Skip to main content

Class: 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?: $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.

cronSchedule​

cronSchedule: string

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

eagerWorkerDeploymentOptions?​

optional eagerWorkerDeploymentOptions?: $Properties | null

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

optional header?: $Properties | null

StartWorkflowExecutionRequest header.

identity​

identity: string

The identity of the client who initiated this request

input?​

optional input?: $Properties | null

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

lastCompletionResult?​

optional lastCompletionResult?: $Properties | null

StartWorkflowExecutionRequest lastCompletionResult.

links: $Properties[]

Links to be associated with the workflow.

memo?​

optional memo?: $Properties | null

StartWorkflowExecutionRequest memo.

namespace​

namespace: string

StartWorkflowExecutionRequest 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.

priority?​

optional priority?: $Properties | null

Priority metadata

propagatedNexusSerializationContext?​

optional propagatedNexusSerializationContext?: $Properties | null

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

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?: $Properties | null

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

searchAttributes?​

optional searchAttributes?: $Properties | null

StartWorkflowExecutionRequest searchAttributes.

taskQueue?​

optional taskQueue?: $Properties | null

StartWorkflowExecutionRequest taskQueue.

timeSkippingConfig?​

optional timeSkippingConfig?: $Properties | null

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

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.

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.

workflowExecutionTimeout?​

optional workflowExecutionTimeout?: $Properties | null

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?: $Properties | null

Timeout of a single workflow run.

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.

workflowTaskTimeout?​

optional workflowTaskTimeout?: $Properties | null

Timeout of a single workflow task.

workflowType?​

optional workflowType?: $Properties | null

StartWorkflowExecutionRequest workflowType.

Methods​

toJSON()​

toJSON(): object

Converts this StartWorkflowExecutionRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): StartWorkflowExecutionRequest & $Shape

Creates a new StartWorkflowExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

StartWorkflowExecutionRequest & $Shape

StartWorkflowExecutionRequest instance

Call Signature​

static create(properties?): StartWorkflowExecutionRequest

Creates a new StartWorkflowExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

StartWorkflowExecutionRequest

StartWorkflowExecutionRequest instance

decode()​

static decode(reader, length?): StartWorkflowExecutionRequest & $Shape

Decodes a StartWorkflowExecutionRequest message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static decodeDelimited(reader): StartWorkflowExecutionRequest & $Shape

Decodes a StartWorkflowExecutionRequest message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static encode(message, writer?): Writer

Encodes the specified StartWorkflowExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.StartWorkflowExecutionRequest.verify|verify messages.

Parameters​

message​

$Properties

StartWorkflowExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified StartWorkflowExecutionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.StartWorkflowExecutionRequest.verify|verify messages.

Parameters​

message​

$Properties

StartWorkflowExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): StartWorkflowExecutionRequest

Creates a StartWorkflowExecutionRequest message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

StartWorkflowExecutionRequest

StartWorkflowExecutionRequest

toObject()​

static toObject(message, options?): object

Creates a plain object from a StartWorkflowExecutionRequest message. Also converts values to other types if specified.

Parameters​

message​

StartWorkflowExecutionRequest

StartWorkflowExecutionRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object