Table of Contents

Class WorkflowUpdateAttribute

Namespace
Temporalio.Workflows
Assembly
Temporalio.dll

Designate a method as an update handler.

[AttributeUsage(AttributeTargets.Method, Inherited = false)]
public sealed class WorkflowUpdateAttribute : Attribute
Inheritance
WorkflowUpdateAttribute
Inherited Members

Remarks

This is not inherited, so if a method is overridden, it must also have this attribute. The method must be public, non-static, and return a task (can be a task with result).

Constructors

WorkflowUpdateAttribute()

Initializes a new instance of the WorkflowUpdateAttribute class with the default name. See Name.

public WorkflowUpdateAttribute()

WorkflowUpdateAttribute(string)

Initializes a new instance of the WorkflowUpdateAttribute class with the given name.

public WorkflowUpdateAttribute(string name)

Parameters

name string

Workflow update name to use. See Name.

Properties

Description

Gets or sets a short description for this update that may appear in UI/CLI when workflow is asked for which updates it supports.

public string? Description { get; set; }

Property Value

string

Dynamic

Gets or sets a value indicating whether the update is dynamic. If a update is dynamic, it cannot be given a name in this attribute and the method must accept a string name and an array of IRawValue.

public bool Dynamic { get; set; }

Property Value

bool

Name

Gets the workflow update name. If this is unset, it defaults to the unqualified method name. If the method name ends with "Async", that is trimmed off when creating the default.

public string? Name { get; }

Property Value

string

UnfinishedPolicy

Gets or sets the actions taken if a workflow exits with a running instance of this handler. Default is WarnAndAbandon.

public HandlerUnfinishedPolicy UnfinishedPolicy { get; set; }

Property Value

HandlerUnfinishedPolicy