Class: StartWorkflowExecutionRequest

workflowservice.v1.StartWorkflowExecutionRequest

Represents a StartWorkflowExecutionRequest.

Implements

• IStartWorkflowExecutionRequest

Constructors

constructor

• new StartWorkflowExecutionRequest(properties?): StartWorkflowExecutionRequest

Constructs a new StartWorkflowExecutionRequest.

Parameters

Name	Type	Description
properties?	IStartWorkflowExecutionRequest	Properties to set

Returns

StartWorkflowExecutionRequest

Properties

completionCallbacks

• completionCallbacks: ICallback[]

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.

Implementation of

IStartWorkflowExecutionRequest.completionCallbacks

---

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.

Implementation of

IStartWorkflowExecutionRequest.continuedFailure

---

cronSchedule

• cronSchedule: string

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

Implementation of

IStartWorkflowExecutionRequest.cronSchedule

---

eagerWorkerDeploymentOptions

• Optional eagerWorkerDeploymentOptions: null | IWorkerDeploymentOptions

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

Implementation of

IStartWorkflowExecutionRequest.eagerWorkerDeploymentOptions

---

header

• Optional header: null | IHeader

StartWorkflowExecutionRequest header.

Implementation of

IStartWorkflowExecutionRequest.header

---

identity

• identity: string

The identity of the client who initiated this request

Implementation of

IStartWorkflowExecutionRequest.identity

---

input

• Optional input: null | IPayloads

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

Implementation of

IStartWorkflowExecutionRequest.input

---

lastCompletionResult

• Optional lastCompletionResult: null | IPayloads

StartWorkflowExecutionRequest lastCompletionResult.

Implementation of

IStartWorkflowExecutionRequest.lastCompletionResult

---

links

• links: ILink[]

Links to be associated with the workflow.

Implementation of

IStartWorkflowExecutionRequest.links

---

memo

• Optional memo: null | IMemo

StartWorkflowExecutionRequest memo.

Implementation of

IStartWorkflowExecutionRequest.memo

---

namespace

• namespace: string

StartWorkflowExecutionRequest namespace.

Implementation of

IStartWorkflowExecutionRequest.namespace

---

onConflictOptions

• Optional onConflictOptions: null | IOnConflictOptions

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.

Implementation of

IStartWorkflowExecutionRequest.onConflictOptions

---

priority

• Optional priority: null | IPriority

Priority metadata

Implementation of

IStartWorkflowExecutionRequest.priority

---

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.

Implementation of

IStartWorkflowExecutionRequest.requestEagerExecution

---

requestId

• requestId: string

A unique identifier for this start request. Typically UUIDv4.

Implementation of

IStartWorkflowExecutionRequest.requestId

---

retryPolicy

• Optional retryPolicy: null | IRetryPolicy

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

Implementation of

IStartWorkflowExecutionRequest.retryPolicy

---

searchAttributes

• Optional searchAttributes: null | ISearchAttributes

StartWorkflowExecutionRequest searchAttributes.

Implementation of

IStartWorkflowExecutionRequest.searchAttributes

---

taskQueue

• Optional taskQueue: null | ITaskQueue

StartWorkflowExecutionRequest taskQueue.

Implementation of

IStartWorkflowExecutionRequest.taskQueue

---

timeSkippingConfig

• Optional timeSkippingConfig: null | ITimeSkippingConfig

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

Implementation of

IStartWorkflowExecutionRequest.timeSkippingConfig

---

userMetadata

• Optional userMetadata: null | IUserMetadata

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.

Implementation of

IStartWorkflowExecutionRequest.userMetadata

---

versioningOverride

• Optional versioningOverride: null | IVersioningOverride

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.

Implementation of

IStartWorkflowExecutionRequest.versioningOverride

---

workflowExecutionTimeout

• Optional workflowExecutionTimeout: null | IDuration

Total workflow execution timeout including retries and continue as new.

Implementation of

IStartWorkflowExecutionRequest.workflowExecutionTimeout

---

workflowId

• workflowId: string

StartWorkflowExecutionRequest workflowId.

Implementation of

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

Implementation of

IStartWorkflowExecutionRequest.workflowIdConflictPolicy

---

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.

Implementation of

IStartWorkflowExecutionRequest.workflowIdReusePolicy

---

workflowRunTimeout

• Optional workflowRunTimeout: null | IDuration

Timeout of a single workflow run.

Implementation of

IStartWorkflowExecutionRequest.workflowRunTimeout

---

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.

Implementation of

IStartWorkflowExecutionRequest.workflowStartDelay

---

workflowTaskTimeout

• Optional workflowTaskTimeout: null | IDuration

Timeout of a single workflow task.

Implementation of

IStartWorkflowExecutionRequest.workflowTaskTimeout

---

workflowType

• Optional workflowType: null | IWorkflowType

StartWorkflowExecutionRequest workflowType.

Implementation of

IStartWorkflowExecutionRequest.workflowType

Methods

toJSON

▸ toJSON(): Object

Converts this StartWorkflowExecutionRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): StartWorkflowExecutionRequest

Creates a new StartWorkflowExecutionRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	IStartWorkflowExecutionRequest	Properties to set

Returns

StartWorkflowExecutionRequest

StartWorkflowExecutionRequest instance

---

decode

▸ decode(reader, length?): StartWorkflowExecutionRequest

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

StartWorkflowExecutionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): StartWorkflowExecutionRequest

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

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	IStartWorkflowExecutionRequest	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	IStartWorkflowExecutionRequest	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

StartWorkflowExecutionRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for StartWorkflowExecutionRequest

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

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