Skip to main content

Class: UpdateWorkflowExecutionResponse

Represents an UpdateWorkflowExecutionResponse.

Properties​

optional link?: $Properties | null

Link to the update event. May be null if the update has not yet been accepted.

outcome?​

optional outcome?: $Properties | null

The outcome of the Update if and only if the Workflow Update has completed. If this response is being returned before the Update has completed then this field will not be set.

stage​

stage: UpdateWorkflowExecutionLifecycleStage

The most advanced lifecycle stage that the Update is known to have reached, where lifecycle stages are ordered UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED. UNSPECIFIED will be returned if and only if the server's maximum wait time was reached before the Update reached the stage specified in the request WaitPolicy, and before the context deadline expired; clients may may then retry the call as needed.

updateRef?​

optional updateRef?: $Properties | null

Enough information for subsequent poll calls if needed. Never null.

Methods​

toJSON()​

toJSON(): object

Converts this UpdateWorkflowExecutionResponse to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): UpdateWorkflowExecutionResponse & $Shape

Creates a new UpdateWorkflowExecutionResponse instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

UpdateWorkflowExecutionResponse & $Shape

UpdateWorkflowExecutionResponse instance

Call Signature​

static create(properties?): UpdateWorkflowExecutionResponse

Creates a new UpdateWorkflowExecutionResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UpdateWorkflowExecutionResponse

UpdateWorkflowExecutionResponse instance

decode()​

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

Decodes an UpdateWorkflowExecutionResponse 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​

UpdateWorkflowExecutionResponse & $Shape

UpdateWorkflowExecutionResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): UpdateWorkflowExecutionResponse & $Shape

Decodes an UpdateWorkflowExecutionResponse message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

UpdateWorkflowExecutionResponse & $Shape

UpdateWorkflowExecutionResponse

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

Parameters​

message​

$Properties

UpdateWorkflowExecutionResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

UpdateWorkflowExecutionResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): UpdateWorkflowExecutionResponse

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

Parameters​

object​

Plain object

Returns​

UpdateWorkflowExecutionResponse

UpdateWorkflowExecutionResponse

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

UpdateWorkflowExecutionResponse

UpdateWorkflowExecutionResponse

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object