Class: StartWorkflowExecutionRequest
workflowservice.v1.StartWorkflowExecutionRequest
Represents a StartWorkflowExecutionRequest.
Properties
completionCallbacks
• completionCallbacks: $Properties[]
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.
continuedFailure
• Optional continuedFailure: null | $Properties
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
• cronSchedule: string
See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/
eagerWorkerDeploymentOptions
• Optional eagerWorkerDeploymentOptions: null | $Properties
Deployment Options of the worker who will process the eager task. Passed when request_eager_execution=true.
header
• Optional header: null | $Properties
StartWorkflowExecutionRequest header.
identity
• identity: string
The identity of the client who initiated this request
input
• Optional input: null | $Properties
Serialized arguments to the workflow. These are passed as arguments to the workflow function.
lastCompletionResult
• Optional lastCompletionResult: null | $Properties
StartWorkflowExecutionRequest lastCompletionResult.
links
• links: $Properties[]
Links to be associated with the workflow.
memo
• Optional memo: null | $Properties
StartWorkflowExecutionRequest memo.
namespace
• namespace: string
StartWorkflowExecutionRequest namespace.
onConflictOptions
• Optional onConflictOptions: null | $Properties
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.
priority
• Optional priority: null | $Properties
Priority metadata
requestEagerExecution
• requestEagerExecution: 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
• requestId: string
A unique identifier for this start request. Typically UUIDv4.
retryPolicy
• Optional retryPolicy: null | $Properties
The retry policy for the workflow. Will never exceed workflow_execution_timeout.
searchAttributes
• Optional searchAttributes: null | $Properties
StartWorkflowExecutionRequest searchAttributes.
taskQueue
• Optional taskQueue: null | $Properties
StartWorkflowExecutionRequest taskQueue.
timeSkippingConfig
• Optional timeSkippingConfig: null | $Properties
Time-skipping configuration. If not set, time skipping is disabled.
userMetadata
• Optional userMetadata: null | $Properties
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.
versioningOverride
• Optional versioningOverride: null | $Properties
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.
workflowExecutionTimeout
• Optional workflowExecutionTimeout: null | $Properties
Total workflow execution timeout including retries and continue as new.
workflowId
• workflowId: string
StartWorkflowExecutionRequest workflowId.
workflowIdConflictPolicy
• workflowIdConflictPolicy: WorkflowIdConflictPolicy
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.
workflowIdReusePolicy
• workflowIdReusePolicy: WorkflowIdReusePolicy
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.
workflowRunTimeout
• Optional workflowRunTimeout: null | $Properties
Timeout of a single workflow run.
workflowStartDelay
• Optional workflowStartDelay: null | $Properties
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.
workflowTaskTimeout
• Optional workflowTaskTimeout: null | $Properties
Timeout of a single workflow task.
workflowType
• Optional workflowType: null | $Properties
StartWorkflowExecutionRequest workflowType.
Methods
toJSON
▸ toJSON(): Object
Converts this StartWorkflowExecutionRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): StartWorkflowExecutionRequest & $Shape
Creates a new StartWorkflowExecutionRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
StartWorkflowExecutionRequest & $Shape
StartWorkflowExecutionRequest instance
▸ create(properties?): StartWorkflowExecutionRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): StartWorkflowExecutionRequest & $Shape
Decodes a StartWorkflowExecutionRequest message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
StartWorkflowExecutionRequest & $Shape
StartWorkflowExecutionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): StartWorkflowExecutionRequest & $Shape
Decodes a StartWorkflowExecutionRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
StartWorkflowExecutionRequest & $Shape
StartWorkflowExecutionRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode
▸ encode(message, writer?): Writer
Encodes the specified StartWorkflowExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.StartWorkflowExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | StartWorkflowExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified StartWorkflowExecutionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.StartWorkflowExecutionRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | StartWorkflowExecutionRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): StartWorkflowExecutionRequest
Creates a StartWorkflowExecutionRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
StartWorkflowExecutionRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a StartWorkflowExecutionRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | StartWorkflowExecutionRequest | StartWorkflowExecutionRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object