Class NexusOperationExecutionDescription

Namespace

Temporalio.Client

Assembly

Temporalio.dll

Description of a standalone Nexus operation execution from a describe call.

public class NexusOperationExecutionDescription : NexusOperationExecution

Inheritance

object

NexusOperationExecution

NexusOperationExecutionDescription

Inherited Members

NexusOperationExecution.OperationId

NexusOperationExecution.RunId

NexusOperationExecution.Endpoint

NexusOperationExecution.Service

NexusOperationExecution.Operation

NexusOperationExecution.CloseTime

NexusOperationExecution.ExecutionDuration

NexusOperationExecution.Namespace

NexusOperationExecution.ScheduledTime

NexusOperationExecution.StateTransitionCount

NexusOperationExecution.Status

NexusOperationExecution.TypedSearchAttributes

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

WARNING: Standalone Nexus operations are experimental.

Constructors

NexusOperationExecutionDescription(DescribeNexusOperationExecutionResponse, string, DataConverter)

Initializes a new instance of the NexusOperationExecutionDescription class.

protected NexusOperationExecutionDescription(DescribeNexusOperationExecutionResponse rawDescription, string clientNamespace, DataConverter dataConverter)

Parameters

rawDescription DescribeNexusOperationExecutionResponse

Raw proto description.

clientNamespace string

Client namespace.

dataConverter DataConverter

Data converter.

Remarks

WARNING: This constructor may be mutated in backwards incompatible ways.

Properties

Attempt

Gets the current attempt number, starting at 1.

public int Attempt { get; }

Property Value

int

BlockedReason

Gets the blocked reason if the state is blocked.

public string? BlockedReason { get; }

Property Value

string

ExpirationTime

Gets the scheduled time plus schedule-to-close timeout.

public DateTime? ExpirationTime { get; }

Property Value

DateTime?

LastAttemptCompleteTime

Gets when the last attempt completed.

public DateTime? LastAttemptCompleteTime { get; }

Property Value

DateTime?

LongPollToken

Gets the token for follow-on long-poll requests, or null if the operation is complete.

public byte[]? LongPollToken { get; }

Property Value

byte[]

NextAttemptScheduleTime

Gets when the next attempt will be scheduled.

public DateTime? NextAttemptScheduleTime { get; }

Property Value

DateTime?

OperationToken

Gets the operation token for async operations after a successful StartOperation call.

public string? OperationToken { get; }

Property Value

string

RequestId

Gets the server-generated request ID used as an idempotency token.

public string? RequestId { get; }

Property Value

string

ScheduleToCloseTimeout

Gets the schedule-to-close timeout.

public TimeSpan? ScheduleToCloseTimeout { get; }

Property Value

TimeSpan?

State

Gets the more detailed state if the operation status is running.

public PendingNexusOperationState State { get; }

Property Value

PendingNexusOperationState

Methods

GetStaticDetailsAsync()

Gets the general fixed details for this operation that may appear in UI/CLI. This can be in Temporal markdown format and can span multiple lines.

public Task<string?> GetStaticDetailsAsync()

Returns

Task<string>

Static details.

Remarks

WARNING: Standalone Nexus operations are experimental.

GetStaticSummaryAsync()

Gets the single-line fixed summary for this operation that may appear in UI/CLI. This can be in single-line Temporal markdown format.

public Task<string?> GetStaticSummaryAsync()

Returns

Task<string>

Static summary.