Class SignalWithStartWorkflowRequest

Namespace

Temporalio.Workflows

Assembly

Temporalio.dll

Request fields for signaling a workflow, starting it first if needed.

[TemporalTransferTypeConverter(typeof(SignalWithStartWorkflowRequest.TransferTypeConverter))]
public record SignalWithStartWorkflowRequest : IEquatable<SignalWithStartWorkflowRequest>

Inheritance

object

SignalWithStartWorkflowRequest

Implements

IEquatable<SignalWithStartWorkflowRequest>

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

SignalWithStartWorkflowRequest(string, string, string, string, string)

Initializes a new instance of the SignalWithStartWorkflowRequest class.

public SignalWithStartWorkflowRequest(string workflow, string id, string taskQueue, string signal, string @namespace)

Parameters

workflow string

id string

taskQueue string

signal string

namespace string

Properties

Args

Arguments for the workflow.

public IReadOnlyCollection<object?>? Args { get; init; }

Property Value

IReadOnlyCollection<object>

CronSchedule

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

public string? CronSchedule { get; init; }

Property Value

string

ExecutionTimeout

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

public TimeSpan? ExecutionTimeout { get; init; }

Property Value

TimeSpan?

Headers

Headers for the request.

public IReadOnlyDictionary<string, object?>? Headers { get; init; }

Property Value

IReadOnlyDictionary<string, object>

Id

Unique identifier for the workflow execution. Must be nonempty.

public string Id { get; init; }

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. Defaults to use-existing.

public WorkflowIdConflictPolicy? IdConflictPolicy { get; init; }

Property Value

WorkflowIdConflictPolicy?

IdReusePolicy

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

public WorkflowIdReusePolicy? IdReusePolicy { get; init; }

Property Value

WorkflowIdReusePolicy?

Memo

Memo for the workflow.

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

Property Value

IReadOnlyDictionary<string, object>

Namespace

Namespace of the workflow execution.

public string Namespace { get; init; }

Property Value

string

Priority

Priority of the workflow execution.

public Priority? Priority { get; init; }

Property Value

Priority

RetryPolicy

Retry policy for the workflow.

public RetryPolicy? RetryPolicy { get; init; }

Property Value

RetryPolicy

RunTimeout

Timeout of a single workflow run. Defaults to the workflow execution timeout.

public TimeSpan? RunTimeout { get; init; }

Property Value

TimeSpan?

SearchAttributes

Typed search attributes for the workflow.

public SearchAttributeCollection? SearchAttributes { get; init; }

Property Value

SearchAttributeCollection

Signal

Signal name or signal expression to send with the start request.

public string Signal { get; init; }

Property Value

string

SignalArgs

Arguments for the signal.

public IReadOnlyCollection<object?>? SignalArgs { get; init; }

Property Value

IReadOnlyCollection<object>

StartDelay

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

public TimeSpan? StartDelay { get; init; }

Property Value

TimeSpan?

TaskQueue

Task queue to run the workflow on.

public string TaskQueue { get; init; }

Property Value

string

TaskTimeout

Timeout of a single workflow task. Defaults to 10 seconds.

public TimeSpan? TaskTimeout { get; init; }

Property Value

TimeSpan?

UserMetadata

Static metadata for the workflow execution.

public UserMetadata? UserMetadata { get; init; }

Property Value

UserMetadata

VersioningOverride

Override for workflow versioning behavior.

public VersioningOverride? VersioningOverride { get; init; }

Property Value

VersioningOverride

Workflow

Workflow type name or workflow expression identifying the workflow to start.

public string Workflow { get; init; }

Property Value

string