Class WorkflowUpdateHandle

Namespace

Temporalio.Client

Assembly

Temporalio.dll

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

public record WorkflowUpdateHandle : IEquatable<WorkflowUpdateHandle>

Inheritance

object

WorkflowUpdateHandle

Implements

IEquatable<WorkflowUpdateHandle>

Derived

WorkflowUpdateHandle<TResult>

Inherited Members

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.

Properties

Client

Client used for update handle calls.

public ITemporalClient Client { get; init; }

Property Value

ITemporalClient

Id

Update ID.

public string Id { get; init; }

Property Value

string

WorkflowId

Workflow ID.

public string WorkflowId { get; init; }

Property Value

string

WorkflowRunId

Run ID if any.

public string? WorkflowRunId { get; init; }

Property Value

string

Methods

GetResultAsync(RpcOptions?)

Wait for an update result disregarding any return value.

public Task GetResultAsync(RpcOptions? rpcOptions = null)

Parameters

rpcOptions RpcOptions

Extra RPC options.

Returns

Task

Completed update task.

Remarks

WARNING: Workflow update is experimental and APIs may change.

GetResultAsync<TResult>(RpcOptions?)

Wait for an update result.

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

Parameters

rpcOptions RpcOptions

Extra RPC options.

Returns

Task<TResult>

Completed update result.

Type Parameters

TResult

Update result type.

Remarks

WARNING: Workflow update is experimental and APIs may change.