Class WorkflowUpdateHandle<TResult>

Namespace

Temporalio.Client

Assembly

Temporalio.dll

Workflow update handle to perform actions on an individual workflow update.

public record WorkflowUpdateHandle<TResult> : WorkflowUpdateHandle, IEquatable<WorkflowUpdateHandle>, IEquatable<WorkflowUpdateHandle<TResult>>

Type Parameters

TResult

Update result type.

Inheritance

object

WorkflowUpdateHandle

WorkflowUpdateHandle<TResult>

Implements

IEquatable<WorkflowUpdateHandle>

IEquatable<WorkflowUpdateHandle<TResult>>

Inherited Members

WorkflowUpdateHandle.Client

WorkflowUpdateHandle.Id

WorkflowUpdateHandle.WorkflowId

WorkflowUpdateHandle.WorkflowRunId

WorkflowUpdateHandle.GetResultAsync<TResult>(RpcOptions)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

WARNING: Workflow update is experimental and APIs may change.

Constructors

WorkflowUpdateHandle(ITemporalClient, string, string, string?)

Workflow update handle to perform actions on an individual workflow update.

public WorkflowUpdateHandle(ITemporalClient Client, string Id, string WorkflowId, string? WorkflowRunId = null)

Parameters

Client ITemporalClient

Client used for update handle calls.

Id string

Update ID.

WorkflowId string

Workflow ID.

WorkflowRunId string

Run ID if any.

Remarks

WARNING: Workflow update is experimental and APIs may change.

Methods

GetResultAsync(RpcOptions?)

Wait for an update result.

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

Parameters

rpcOptions RpcOptions

Extra RPC options.

Returns

Task<TResult>

Completed update result.

Remarks

WARNING: Workflow update is experimental and APIs may change.