Class NexusOperationHandle

Namespace

Temporalio.Client

Assembly

Temporalio.dll

Handle for a standalone Nexus operation to perform actions on.

public record NexusOperationHandle : IEquatable<NexusOperationHandle>

Inheritance

object

NexusOperationHandle

Implements

IEquatable<NexusOperationHandle>

Derived

NexusOperationHandle<TResult>

Inherited Members

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

NexusOperationHandle(ITemporalClient, string, string?)

Handle for a standalone Nexus operation to perform actions on.

public NexusOperationHandle(ITemporalClient Client, string Id, string? RunId = null)

Parameters

Client ITemporalClient

Client used for operation handle calls.

Id string

Operation ID.

RunId string

Operation run ID if known.

Remarks

WARNING: Standalone Nexus operations are experimental.

Properties

Client

Client used for operation handle calls.

public ITemporalClient Client { get; init; }

Property Value

ITemporalClient

Id

Operation ID.

public string Id { get; init; }

Property Value

string

RunId

Operation run ID if known.

public string? RunId { get; init; }

Property Value

string

Methods

CancelAsync(NexusOperationCancelOptions?)

Request cancellation of this operation.

public virtual Task CancelAsync(NexusOperationCancelOptions? options = null)

Parameters

options NexusOperationCancelOptions

Cancellation options.

Returns

Task

Cancel accepted task.

Remarks

WARNING: Standalone Nexus operations are experimental.

Exceptions

RpcException

Server-side error.

DescribeAsync(NexusOperationDescribeOptions?)

Describe this operation.

public virtual Task<NexusOperationExecutionDescription> DescribeAsync(NexusOperationDescribeOptions? options = null)

Parameters

options NexusOperationDescribeOptions

Extra options.

Returns

Task<NexusOperationExecutionDescription>

Description for the operation.

Remarks

WARNING: Standalone Nexus operations are experimental.

Exceptions

RpcException

Server-side error.

GetResultAsync(RpcOptions?)

Wait for the result of the operation, discarding the return value.

public Task GetResultAsync(RpcOptions? rpcOptions = null)

Parameters

rpcOptions RpcOptions

RPC options for the call.

Returns

Task

Task that completes when the operation completes.

Remarks

WARNING: Standalone Nexus operations are experimental.

Exceptions

NexusOperationFailedException

Exception thrown for unsuccessful operation result.

RpcException

Server-side error.

GetResultAsync<TResult>(RpcOptions?)

Wait for the result of the operation, deserializing into the given type.

public virtual Task<TResult> GetResultAsync<TResult>(RpcOptions? rpcOptions = null)

Parameters

rpcOptions RpcOptions

RPC options for the call.

Returns

Task<TResult>

Result of the operation.

Type Parameters

TResult

Return type to deserialize result into.

Remarks

WARNING: Standalone Nexus operations are experimental.

Exceptions

NexusOperationFailedException

Exception thrown for unsuccessful operation result.

RpcException

Server-side error.

TerminateAsync(NexusOperationTerminateOptions?)

Terminate this operation.

public virtual Task TerminateAsync(NexusOperationTerminateOptions? options = null)

Parameters

options NexusOperationTerminateOptions

Termination options.

Returns

Task

Terminate completed task.

Remarks

WARNING: Standalone Nexus operations are experimental.

Exceptions

RpcException

Server-side error.