Class SignalWithStartWorkflowOptions

Namespace

Temporalio.Workflows

Assembly

Temporalio.dll

Signal a workflow, starting it first if needed.

public class SignalWithStartWorkflowOptions

Inheritance

object

SignalWithStartWorkflowOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

WARNING: This API is experimental and may change in the future.

Constructors

SignalWithStartWorkflowOptions(string, string)

public SignalWithStartWorkflowOptions(string id, string taskQueue)

Parameters

id string

taskQueue string

Properties

CronSchedule

Cron schedule for recurring workflow executions. See https://docs.temporal.io/cron-job.

public string? CronSchedule { get; set; }

Property Value

string

ExecutionTimeout

Total workflow execution timeout, including retries and continue-as-new.

public TimeSpan? ExecutionTimeout { get; set; }

Property Value

TimeSpan?

Id

Unique identifier for the workflow execution.

public string Id { get; set; }

Property Value

string

IdConflictPolicy

Behavior when a workflow is currently running with the same ID. Set to use-existing for idempotent deduplication on workflow ID. Cannot be set if id-reuse-policy is terminate-if-running.

public WorkflowIdConflictPolicy? IdConflictPolicy { get; set; }

Property Value

WorkflowIdConflictPolicy?

IdReusePolicy

Behavior when a closed workflow with the same ID exists. Default is allow-duplicate.

public WorkflowIdReusePolicy? IdReusePolicy { get; set; }

Property Value

WorkflowIdReusePolicy?

Memo

Memo for the workflow.

public IReadOnlyDictionary<string, object?>? Memo { get; set; }

Property Value

IReadOnlyDictionary<string, object>

Priority

Priority of the workflow execution.

public Priority? Priority { get; set; }

Property Value

Priority

RequestId

Request ID used to deduplicate workflow start requests.

public string? RequestId { get; set; }

Property Value

string

RetryPolicy

Retry policy for the workflow.

public RetryPolicy? RetryPolicy { get; set; }

Property Value

RetryPolicy

RunTimeout

Timeout of a single workflow run.

public TimeSpan? RunTimeout { get; set; }

Property Value

TimeSpan?

SearchAttributes

Typed search attributes for the workflow.

public SearchAttributeCollection? SearchAttributes { get; set; }

Property Value

SearchAttributeCollection

StartDelay

Amount of time to wait before starting the workflow. This does not work with cron-schedule.

public TimeSpan? StartDelay { get; set; }

Property Value

TimeSpan?

StaticDetails

General fixed details for the workflow execution that may appear in UI and CLI. This can be in Temporal Markdown format and can span multiple lines. This value is fixed on the workflow execution and cannot be updated.

public string? StaticDetails { get; set; }

Property Value

string

StaticSummary

Single-line fixed summary for the workflow execution that may appear in UI and CLI. This can be in single-line Temporal Markdown format.

public string? StaticSummary { get; set; }

Property Value

string

TaskQueue

Task queue to run the workflow on.

public string TaskQueue { get; set; }

Property Value

string

TaskTimeout

Timeout of a single workflow task.

public TimeSpan? TaskTimeout { get; set; }

Property Value

TimeSpan?

VersioningOverride

Override for workflow versioning behavior.

public VersioningOverride? VersioningOverride { get; set; }

Property Value

VersioningOverride