Class NexusOperationOptions

Namespace

Temporalio.Workflows

Assembly

Temporalio.dll

Options for starting a Nexus operation.

public class NexusOperationOptions : ICloneable

Inheritance

object

NexusOperationOptions

Implements

ICloneable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

WARNING: Nexus support is experimental.

Properties

CancellationToken

Gets or sets the cancellation token. If unset, defaults to the workflow cancellation token.

public CancellationToken? CancellationToken { get; set; }

Property Value

CancellationToken?

CancellationType

Gets or sets how the workflow will send/wait for cancellation of the Nexus operation. Default is WaitCancellationCompleted.

public NexusOperationCancellationType CancellationType { get; set; }

Property Value

NexusOperationCancellationType

ScheduleToCloseTimeout

Gets or sets the schedule to close timeout.

public TimeSpan? ScheduleToCloseTimeout { get; set; }

Property Value

TimeSpan?

Remarks

Indicates how long the caller is willing to wait for operation completion. Calls are retried internally by the server.

ScheduleToStartTimeout

Gets or sets the schedule to start timeout.

public TimeSpan? ScheduleToStartTimeout { get; set; }

Property Value

TimeSpan?

Remarks

Indicates how long the caller is willing to wait for the operation to be started (or completed if synchronous) by the handler. If the operation is not started within this timeout, it will fail with TIMEOUT_TYPE_SCHEDULE_TO_START. If not set or zero, no schedule-to-start timeout is enforced. Requires server version 1.31.0 or later.

StartToCloseTimeout

Gets or sets the start to close timeout.

public TimeSpan? StartToCloseTimeout { get; set; }

Property Value

TimeSpan?

Remarks

Indicates how long the caller is willing to wait for an asynchronous operation to complete after it has been started. If the operation does not complete within this timeout after starting, it will fail with TIMEOUT_TYPE_START_TO_CLOSE. Only applies to asynchronous operations. Synchronous operations ignore this timeout. If not set or zero, no start-to-close timeout is enforced. Requires server version 1.31.0 or later.

Summary

Gets or sets the summary.

public string? Summary { get; set; }

Property Value

string

Methods

Clone()

Create a shallow copy of these options.

public virtual object Clone()

Returns

object

A shallow copy of these options.