Interface: IStartWorkflowExecutionRequest
workflowservice.v1.IStartWorkflowExecutionRequest
Properties of a StartWorkflowExecutionRequest.
Implemented by
Properties
continuedFailure
• Optional
continuedFailure: null
| IFailure
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.
cronSchedule
• Optional
cronSchedule: null
| string
See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/
header
• Optional
header: null
| IHeader
StartWorkflowExecutionRequest header
identity
• Optional
identity: null
| string
The identity of the client who initiated this request
input
• Optional
input: null
| IPayloads
Serialized arguments to the workflow. These are passed as arguments to the workflow function.
lastCompletionResult
• Optional
lastCompletionResult: null
| IPayloads
StartWorkflowExecutionRequest lastCompletionResult
memo
• Optional
memo: null
| IMemo
StartWorkflowExecutionRequest memo
namespace
• Optional
namespace: null
| string
StartWorkflowExecutionRequest namespace
requestEagerExecution
• Optional
requestEagerExecution: null
| boolean
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
.
requestId
• Optional
requestId: null
| string
A unique identifier for this start request. Typically UUIDv4.
retryPolicy
• Optional
retryPolicy: null
| IRetryPolicy
The retry policy for the workflow. Will never exceed workflow_execution_timeout
.
searchAttributes
• Optional
searchAttributes: null
| ISearchAttributes
StartWorkflowExecutionRequest searchAttributes
taskQueue
• Optional
taskQueue: null
| ITaskQueue
StartWorkflowExecutionRequest taskQueue
workflowExecutionTimeout
• Optional
workflowExecutionTimeout: null
| IDuration
Total workflow execution timeout including retries and continue as new.
workflowId
• Optional
workflowId: null
| string
StartWorkflowExecutionRequest workflowId
workflowIdReusePolicy
• Optional
workflowIdReusePolicy: null
| WorkflowIdReusePolicy
Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.
workflowRunTimeout
• Optional
workflowRunTimeout: null
| IDuration
Timeout of a single workflow run.
workflowStartDelay
• Optional
workflowStartDelay: null
| IDuration
Time to wait before dispatching the first workflow task. Cannot be used with cron_schedule
.
If the workflow gets a signal before the delay, a workflow task will be dispatched and the rest
of the delay will be ignored.
workflowTaskTimeout
• Optional
workflowTaskTimeout: null
| IDuration
Timeout of a single workflow task.
workflowType
• Optional
workflowType: null
| IWorkflowType
StartWorkflowExecutionRequest workflowType