Class WorkflowUpdateOptions

Namespace

Temporalio.Client

Assembly

Temporalio.dll

Options for executing an update on a WorkflowHandle.

public class WorkflowUpdateOptions : ICloneable

Inheritance

object

WorkflowUpdateOptions

Implements

ICloneable

Derived

WorkflowUpdateStartOptions

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

WorkflowUpdateOptions()

Initializes a new instance of the WorkflowUpdateOptions class.

public WorkflowUpdateOptions()

WorkflowUpdateOptions(string)

Initializes a new instance of the WorkflowUpdateOptions class.

public WorkflowUpdateOptions(string id)

Parameters

id string

Update ID.

Properties

Id

Gets or sets the unique update identifier. If not set, this is defaulted to a GUID. This must be unique within the scope of a workflow execution (i.e. namespace + workflow ID + run ID).

public string? Id { get; set; }

Property Value

string

Rpc

Gets or sets RPC options for update RPC calls.

public RpcOptions? Rpc { get; set; }

Property Value

RpcOptions

Methods

Clone()

Create a shallow copy of these options.

public virtual object Clone()

Returns

object

A shallow copy of these options and any transitive options fields.