WorkflowFunctionStepOptions

Namespace Tracon · Assembly Tracon.Workflows.dll

The settings of one function node in a workflow graph built in code, passed to WorkflowFunctionBinding.GetWorkflowFunction.

public sealed class WorkflowFunctionStepOptions

Inheritance

object ← WorkflowFunctionStepOptions

Inherited Members

object.GetType(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()

Remarks

A stored workflow carries the same two values in a WorkflowNodeReference; a graph built in code has no node reference, so it chooses them here. A callback with properties rather than optional parameters, for the reason WorkflowFunctionOptions gives.

Constructors

WorkflowFunctionStepOptions()

public WorkflowFunctionStepOptions()

Properties

Settings

Gets or sets the node’s settings as a JSON object. null (the default) is a node without settings.

public JsonElement? Settings { get; set; }

Property Value

JsonElement?

Remarks

Read into the settings type the function declares (AddWorkflowFunction<TInput, TOutput, TSettings>) with the strict read a stored node’s settings get: an unknown field, a missing required member and a value of the wrong type are refused when the graph is built, naming the node and the member. A function that declares no settings refuses any.

To pass a typed value instead of JSON, call WorkflowFunctionStepOptions.SetSettings`.

Timeout

Gets or sets the longest time one call of the node may take. null (the default) uses the timeout the function was registered with, if any.

public TimeSpan? Timeout { get; set; }

Property Value

TimeSpan?

Remarks

The same setting as WorkflowNodeReference.Timeout; it wins over WorkflowFunctionOptions.Timeout, and its remarks apply: the token the handler was given is cancelled when the time is up, and each attempt of a retried node has the whole time. Must be from one millisecond to about 49.7 days.

Methods

SetSettings<TSettings>(TSettings)

Sets WorkflowFunctionStepOptions.Settings from a typed value.

public void SetSettings<TSettings>(TSettings settings) where TSettings : class

Parameters

settings TSettings

The settings.

Type Parameters

TSettings

The settings type the function declares.

Remarks

The value is written with the options the read uses, so it comes back as the object that was given and the check is the one a stored node’s settings pass. A settings type with a required member is satisfied by the value, not by a default. Settings are values and never a secret: they appear in the run’s audit trail.

Exceptions

ArgumentNullException

settings is null.

JsonException

The value cannot be written as JSON.