Class StartActivityOptions

Namespace

Temporalio.Client

Assembly

Temporalio.dll

Options for starting a standalone activity. Id and TaskQueue are required.

public class StartActivityOptions : ICloneable

Inheritance

object

StartActivityOptions

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: Standalone activities are experimental.

Constructors

StartActivityOptions()

Initializes a new instance of the StartActivityOptions class.

public StartActivityOptions()

StartActivityOptions(string, string)

Initializes a new instance of the StartActivityOptions class.

public StartActivityOptions(string id, string taskQueue)

Parameters

id string

Activity ID.

taskQueue string

Task queue to start the activity on.

Properties

HeartbeatTimeout

Gets or sets the maximum time between successful heartbeats.

public TimeSpan? HeartbeatTimeout { get; set; }

Property Value

TimeSpan?

Id

Gets or sets the unique activity identifier. This is required.

public string? Id { get; set; }

Property Value

string

IdConflictPolicy

Gets or sets how already-running activities of the same ID are treated. Default is Unspecified which effectively means Fail on the server.

public ActivityIdConflictPolicy IdConflictPolicy { get; set; }

Property Value

ActivityIdConflictPolicy

IdReusePolicy

Gets or sets whether to allow re-using an activity ID from a previously closed activity. Default is AllowDuplicate.

public ActivityIdReusePolicy IdReusePolicy { get; set; }

Property Value

ActivityIdReusePolicy

Priority

Gets or sets the priority to use when starting this activity.

public Priority? Priority { get; set; }

Property Value

Priority

RetryPolicy

Gets or sets the retry policy for the activity. If unset, uses server default.

public RetryPolicy? RetryPolicy { get; set; }

Property Value

RetryPolicy

Rpc

Gets or sets RPC options for starting the activity.

public RpcOptions? Rpc { get; set; }

Property Value

RpcOptions

ScheduleToCloseTimeout

Gets or sets the total time the activity is allowed to run including retries.

public TimeSpan? ScheduleToCloseTimeout { get; set; }

Property Value

TimeSpan?

ScheduleToStartTimeout

Gets or sets the maximum time the activity can wait in the task queue before being picked up by a worker. This timeout is non-retryable.

public TimeSpan? ScheduleToStartTimeout { get; set; }

Property Value

TimeSpan?

StartToCloseTimeout

Gets or sets the maximum time for a single execution attempt. This timeout is retryable.

public TimeSpan? StartToCloseTimeout { get; set; }

Property Value

TimeSpan?

StaticDetails

Gets or sets general fixed details for this activity execution that may appear in UI/CLI. This can be in Temporal markdown format and can span multiple lines.

public string? StaticDetails { get; set; }

Property Value

string

Remarks

WARNING: This setting is experimental.

StaticSummary

Gets or sets a single-line fixed summary for this activity execution that may appear in UI/CLI. This can be in single-line Temporal markdown format.

public string? StaticSummary { get; set; }

Property Value

string

Remarks

WARNING: This setting is experimental.

TaskQueue

Gets or sets the task queue to run the activity on. This is required.

public string? TaskQueue { get; set; }

Property Value

string

TypedSearchAttributes

Gets or sets the search attributes for the activity.

public SearchAttributeCollection? TypedSearchAttributes { get; set; }

Property Value

SearchAttributeCollection

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.