Skip to main content

Class: WorkflowUpdateOptionsUpdate

Represents a WorkflowUpdateOptionsUpdate.

Properties​

attachedCompletionCallbacks​

attachedCompletionCallbacks: $Properties[]

Completion callbacks attached to the running workflow update.

attachedRequestId​

attachedRequestId: string

Request ID attached to the running workflow update so that subsequent requests with same request ID will be deduped

updateId​

updateId: string

The ID of the workflow update this update options update corresponds to.

Methods​

toJSON()​

toJSON(): object

Converts this WorkflowUpdateOptionsUpdate to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkflowUpdateOptionsUpdate & $Shape

Creates a new WorkflowUpdateOptionsUpdate instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

WorkflowUpdateOptionsUpdate & $Shape

WorkflowUpdateOptionsUpdate instance

Call Signature​

static create(properties?): WorkflowUpdateOptionsUpdate

Creates a new WorkflowUpdateOptionsUpdate instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowUpdateOptionsUpdate

WorkflowUpdateOptionsUpdate instance

decode()​

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

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

WorkflowUpdateOptionsUpdate & $Shape

WorkflowUpdateOptionsUpdate

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkflowUpdateOptionsUpdate & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkflowUpdateOptionsUpdate & $Shape

WorkflowUpdateOptionsUpdate

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 WorkflowUpdateOptionsUpdate message. Does not implicitly temporal.api.history.v1.WorkflowExecutionOptionsUpdatedEventAttributes.WorkflowUpdateOptionsUpdate.verify|verify messages.

Parameters​

message​

$Properties

WorkflowUpdateOptionsUpdate message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified WorkflowUpdateOptionsUpdate message, length delimited. Does not implicitly temporal.api.history.v1.WorkflowExecutionOptionsUpdatedEventAttributes.WorkflowUpdateOptionsUpdate.verify|verify messages.

Parameters​

message​

$Properties

WorkflowUpdateOptionsUpdate message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkflowUpdateOptionsUpdate

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

Parameters​

object​

Plain object

Returns​

WorkflowUpdateOptionsUpdate

WorkflowUpdateOptionsUpdate

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkflowUpdateOptionsUpdate

WorkflowUpdateOptionsUpdate

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object