Skip to main content

Class: UpdateRef

The data needed by a client to refer to a previously invoked Workflow Update.

Properties​

updateId​

updateId: string

UpdateRef updateId.

workflowExecution?​

optional workflowExecution?: $Properties | null

UpdateRef workflowExecution.

Methods​

toJSON()​

toJSON(): object

Converts this UpdateRef to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): UpdateRef & $Properties

Creates a new UpdateRef instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UpdateRef & $Properties

UpdateRef instance

Call Signature​

static create(properties?): UpdateRef

Creates a new UpdateRef instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UpdateRef

UpdateRef instance

decode()​

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

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

UpdateRef & $Properties

UpdateRef

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): UpdateRef & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

UpdateRef & $Properties

UpdateRef

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

Parameters​

message​

$Properties

UpdateRef message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

UpdateRef message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): UpdateRef

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

Parameters​

object​

Plain object

Returns​

UpdateRef

UpdateRef

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

UpdateRef

UpdateRef

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object