Skip to main content

Class: StartWorkflowExecutionResponse

Represents a StartWorkflowExecutionResponse.

Properties​

eagerWorkflowTask?​

optional eagerWorkflowTask?: $Properties | null

When request_eager_execution is set on the StartWorkflowExecutionRequest, the server - if supported - will return the first workflow task to be eagerly executed. The caller is expected to have a worker available to process the task.

firstExecutionRunId​

firstExecutionRunId: string

If the workflow was started as a result of a de-dupe, this field will contain the run id of the first execution in the chain.

optional link?: $Properties | null

Link to the workflow event.

runId​

runId: string

The run id of the workflow that was started - or used (via WorkflowIdConflictPolicy USE_EXISTING).

started​

started: boolean

If true, a new workflow was started.

status​

status: WorkflowExecutionStatus

Current execution status of the workflow. Typically remains WORKFLOW_EXECUTION_STATUS_RUNNING unless a de-dupe occurs or in specific scenarios handled within the ExecuteMultiOperation (refer to its docs).

Methods​

toJSON()​

toJSON(): object

Converts this StartWorkflowExecutionResponse to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): StartWorkflowExecutionResponse & $Shape

Creates a new StartWorkflowExecutionResponse instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

StartWorkflowExecutionResponse & $Shape

StartWorkflowExecutionResponse instance

Call Signature​

static create(properties?): StartWorkflowExecutionResponse

Creates a new StartWorkflowExecutionResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

StartWorkflowExecutionResponse

StartWorkflowExecutionResponse instance

decode()​

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

Decodes a StartWorkflowExecutionResponse 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​

StartWorkflowExecutionResponse & $Shape

StartWorkflowExecutionResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): StartWorkflowExecutionResponse & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

StartWorkflowExecutionResponse & $Shape

StartWorkflowExecutionResponse

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 StartWorkflowExecutionResponse message. Does not implicitly temporal.api.workflowservice.v1.StartWorkflowExecutionResponse.verify|verify messages.

Parameters​

message​

$Properties

StartWorkflowExecutionResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

StartWorkflowExecutionResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): StartWorkflowExecutionResponse

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

Parameters​

object​

Plain object

Returns​

StartWorkflowExecutionResponse

StartWorkflowExecutionResponse

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

StartWorkflowExecutionResponse

StartWorkflowExecutionResponse

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object