Class: WorkflowUpdateOptionsUpdate

v1.WorkflowExecutionOptionsUpdatedEventAttributes.WorkflowUpdateOptionsUpdate

Represents a WorkflowUpdateOptionsUpdate.

Implements

• IWorkflowUpdateOptionsUpdate

Constructors

constructor

• new WorkflowUpdateOptionsUpdate(properties?): WorkflowUpdateOptionsUpdate

Constructs a new WorkflowUpdateOptionsUpdate.

Parameters

Name	Type	Description
properties?	IWorkflowUpdateOptionsUpdate	Properties to set

Returns

WorkflowUpdateOptionsUpdate

Properties

attachedCompletionCallbacks

• attachedCompletionCallbacks: ICallback[]

Completion callbacks attached to the running workflow update.

Implementation of

IWorkflowUpdateOptionsUpdate.attachedCompletionCallbacks

---

attachedRequestId

• attachedRequestId: string

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

Implementation of

IWorkflowUpdateOptionsUpdate.attachedRequestId

---

updateId

• updateId: string

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

Implementation of

IWorkflowUpdateOptionsUpdate.updateId

Methods

toJSON

▸ toJSON(): Object

Converts this WorkflowUpdateOptionsUpdate to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): WorkflowUpdateOptionsUpdate

Creates a new WorkflowUpdateOptionsUpdate instance using the specified properties.

Parameters

Name	Type	Description
properties?	IWorkflowUpdateOptionsUpdate	Properties to set

Returns

WorkflowUpdateOptionsUpdate

WorkflowUpdateOptionsUpdate instance

---

decode

▸ decode(reader, length?): WorkflowUpdateOptionsUpdate

Decodes a WorkflowUpdateOptionsUpdate message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

WorkflowUpdateOptionsUpdate

WorkflowUpdateOptionsUpdate

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): WorkflowUpdateOptionsUpdate

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

WorkflowUpdateOptionsUpdate

WorkflowUpdateOptionsUpdate

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode

▸ encode(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IWorkflowUpdateOptionsUpdate	WorkflowUpdateOptionsUpdate message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IWorkflowUpdateOptionsUpdate	WorkflowUpdateOptionsUpdate message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): WorkflowUpdateOptionsUpdate

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

WorkflowUpdateOptionsUpdate

WorkflowUpdateOptionsUpdate

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for WorkflowUpdateOptionsUpdate

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	WorkflowUpdateOptionsUpdate	WorkflowUpdateOptionsUpdate
options?	IConversionOptions	Conversion options

Returns

Object

Plain object