Skip to main content

Class: UpdateWorkflowExecutionCompleted

Trigger for when a workflow update is completed.

Properties​

updateId​

updateId: string

UpdateWorkflowExecutionCompleted updateId.

Methods​

toJSON()​

toJSON(): object

Converts this UpdateWorkflowExecutionCompleted to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): UpdateWorkflowExecutionCompleted & $Properties

Creates a new UpdateWorkflowExecutionCompleted instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UpdateWorkflowExecutionCompleted & $Properties

UpdateWorkflowExecutionCompleted instance

Call Signature​

static create(properties?): UpdateWorkflowExecutionCompleted

Creates a new UpdateWorkflowExecutionCompleted instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UpdateWorkflowExecutionCompleted

UpdateWorkflowExecutionCompleted instance

decode()​

static decode(reader, length?): UpdateWorkflowExecutionCompleted & $Properties

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

UpdateWorkflowExecutionCompleted & $Properties

UpdateWorkflowExecutionCompleted

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): UpdateWorkflowExecutionCompleted & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

UpdateWorkflowExecutionCompleted & $Properties

UpdateWorkflowExecutionCompleted

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 UpdateWorkflowExecutionCompleted message. Does not implicitly temporal.api.workflow.v1.CallbackInfo.UpdateWorkflowExecutionCompleted.verify|verify messages.

Parameters​

message​

$Properties

UpdateWorkflowExecutionCompleted message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified UpdateWorkflowExecutionCompleted message, length delimited. Does not implicitly temporal.api.workflow.v1.CallbackInfo.UpdateWorkflowExecutionCompleted.verify|verify messages.

Parameters​

message​

$Properties

UpdateWorkflowExecutionCompleted message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): UpdateWorkflowExecutionCompleted

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

Parameters​

object​

Plain object

Returns​

UpdateWorkflowExecutionCompleted

UpdateWorkflowExecutionCompleted

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

UpdateWorkflowExecutionCompleted

UpdateWorkflowExecutionCompleted

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object