Skip to main content

Interface: IStartWorkflowExecutionRequest

Properties of a StartWorkflowExecutionRequest.

Extends​

Properties​

completionCallbacks?​

optional completionCallbacks?: $Properties[] | null

Callbacks to be called by the server when this workflow reaches a terminal state. If the workflow continues-as-new, these callbacks will be carried over to the new execution. Callback addresses must be whitelisted in the server's dynamic configuration.

Inherited from​

$Properties.completionCallbacks

continuedFailure?​

optional continuedFailure?: $Properties | null

These values will be available as ContinuedFailure and LastCompletionResult in the WorkflowExecutionStarted event and through SDKs. The are currently only used by the server itself (for the schedules feature) and are not intended to be exposed in StartWorkflowExecution.

Inherited from​

$Properties.continuedFailure

cronSchedule?​

optional cronSchedule?: string | null

See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/

Inherited from​

$Properties.cronSchedule

eagerWorkerDeploymentOptions?​

optional eagerWorkerDeploymentOptions?: $Properties | null

Deployment Options of the worker who will process the eager task. Passed when request_eager_execution=true.

Inherited from​

$Properties.eagerWorkerDeploymentOptions

optional header?: $Properties | null

StartWorkflowExecutionRequest header

Inherited from​

$Properties.header

identity?​

optional identity?: string | null

The identity of the client who initiated this request

Inherited from​

$Properties.identity

input?​

optional input?: $Properties | null

Serialized arguments to the workflow. These are passed as arguments to the workflow function.

Inherited from​

$Properties.input

lastCompletionResult?​

optional lastCompletionResult?: $Properties | null

StartWorkflowExecutionRequest lastCompletionResult

Inherited from​

$Properties.lastCompletionResult

optional links?: $Properties[] | null

Links to be associated with the workflow.

Inherited from​

$Properties.links

memo?​

optional memo?: $Properties | null

StartWorkflowExecutionRequest memo

Inherited from​

$Properties.memo

namespace?​

optional namespace?: string | null

StartWorkflowExecutionRequest namespace

Inherited from​

$Properties.namespace

onConflictOptions?​

optional onConflictOptions?: $Properties | null

Defines actions to be done to the existing running workflow when the conflict policy WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING is used. If not set (ie., nil value) or set to a empty object (ie., all options with default value), it won't do anything to the existing running workflow. If set, it will add a history event to the running workflow.

Inherited from​

$Properties.onConflictOptions

priority?​

optional priority?: $Properties | null

Priority metadata

Inherited from​

$Properties.priority

propagatedNexusSerializationContext?​

optional propagatedNexusSerializationContext?: $Properties | null

Serialization context propagated from the Nexus caller that started this workflow.

Inherited from​

$Properties.propagatedNexusSerializationContext

requestEagerExecution?​

optional requestEagerExecution?: boolean | null

Request to get the first workflow task inline in the response bypassing matching service and worker polling. If set to true the caller is expected to have a worker available and capable of processing the task. The returned task will be marked as started and is expected to be completed by the specified workflow_task_timeout.

Inherited from​

$Properties.requestEagerExecution

requestId?​

optional requestId?: string | null

A unique identifier for this start request. Typically UUIDv4.

Inherited from​

$Properties.requestId

retryPolicy?​

optional retryPolicy?: $Properties | null

The retry policy for the workflow. Will never exceed workflow_execution_timeout.

Inherited from​

$Properties.retryPolicy

searchAttributes?​

optional searchAttributes?: $Properties | null

StartWorkflowExecutionRequest searchAttributes

Inherited from​

$Properties.searchAttributes

taskQueue?​

optional taskQueue?: $Properties | null

StartWorkflowExecutionRequest taskQueue

Inherited from​

$Properties.taskQueue

timeSkippingConfig?​

optional timeSkippingConfig?: $Properties | null

Time-skipping configuration. If not set, time skipping is disabled.

Inherited from​

$Properties.timeSkippingConfig

userMetadata?​

optional userMetadata?: $Properties | null

Metadata on the workflow if it is started. This is carried over to the WorkflowExecutionInfo for use by user interfaces to display the fixed as-of-start summary and details of the workflow.

Inherited from​

$Properties.userMetadata

versioningOverride?​

optional versioningOverride?: $Properties | null

If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion. To unset the override after the workflow is running, use UpdateWorkflowExecutionOptions.

Inherited from​

$Properties.versioningOverride

workflowExecutionTimeout?​

optional workflowExecutionTimeout?: $Properties | null

Total workflow execution timeout including retries and continue as new.

Inherited from​

$Properties.workflowExecutionTimeout

workflowId?​

optional workflowId?: string | null

StartWorkflowExecutionRequest workflowId

Inherited from​

$Properties.workflowId

workflowIdConflictPolicy?​

optional workflowIdConflictPolicy?: WorkflowIdConflictPolicy | null

Defines how to resolve a workflow id conflict with a running workflow. The default policy is WORKFLOW_ID_CONFLICT_POLICY_FAIL.

See workflow_id_reuse_policy for handling a workflow id duplication with a closed workflow.

Inherited from​

$Properties.workflowIdConflictPolicy

workflowIdReusePolicy?​

optional workflowIdReusePolicy?: WorkflowIdReusePolicy | null

Defines whether to allow re-using the workflow id from a previously closed workflow. The default policy is WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.

See workflow_id_conflict_policy for handling a workflow id duplication with a running workflow.

Inherited from​

$Properties.workflowIdReusePolicy

workflowRunTimeout?​

optional workflowRunTimeout?: $Properties | null

Timeout of a single workflow run.

Inherited from​

$Properties.workflowRunTimeout

workflowStartDelay?​

optional workflowStartDelay?: $Properties | null

Time to wait before making the first workflow task available for dispatch. Cannot be used with cron_schedule. If the workflow gets a signal before the delay, a workflow task will be made available for dispatch and the rest of the delay will be ignored.

Inherited from​

$Properties.workflowStartDelay

workflowTaskTimeout?​

optional workflowTaskTimeout?: $Properties | null

Timeout of a single workflow task.

Inherited from​

$Properties.workflowTaskTimeout

workflowType?​

optional workflowType?: $Properties | null

StartWorkflowExecutionRequest workflowType

Inherited from​

$Properties.workflowType