Class WorkflowUpdateDefinition

Namespace

Temporalio.Workflows

Assembly

Temporalio.dll

Definition of a workflow update.

public class WorkflowUpdateDefinition

Inheritance

object

WorkflowUpdateDefinition

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Description

Gets the optional update description.

public string? Description { get; }

Property Value

string

Dynamic

Gets a value indicating whether the update is dynamic.

public bool Dynamic { get; }

Property Value

bool

Name

Gets the update name. This is null if the update is dynamic.

public string? Name { get; }

Property Value

string

Methods

CreateWithoutAttribute(string?, Delegate, Delegate?, HandlerUnfinishedPolicy, string?)

Creates an update definition from an explicit name and method. Most users should use FromMethod(MethodInfo, MethodInfo?) with attributes instead.

public static WorkflowUpdateDefinition CreateWithoutAttribute(string? name, Delegate del, Delegate? validatorDel = null, HandlerUnfinishedPolicy unfinishedPolicy = HandlerUnfinishedPolicy.WarnAndAbandon, string? description = null)

Parameters

name string

Update name. Null for dynamic update.

del Delegate

Update delegate.

validatorDel Delegate

Optional validator delegate.

unfinishedPolicy HandlerUnfinishedPolicy

Actions taken if a workflow exits with a running instance of this handler.

description string

Optional description. WARNING: This setting is experimental.

Returns

WorkflowUpdateDefinition

Update definition.

FromMethod(MethodInfo, MethodInfo?)

Get an update definition from a method or fail. The result is cached.

public static WorkflowUpdateDefinition FromMethod(MethodInfo method, MethodInfo? validatorMethod = null)

Parameters

method MethodInfo

Update method.

validatorMethod MethodInfo

Optional validator method.

Returns

WorkflowUpdateDefinition

Update definition.