Class: WorkflowUpdateOptionsUpdate
v1.WorkflowExecutionOptionsUpdatedEventAttributes.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
▸ create(properties?): WorkflowUpdateOptionsUpdate & $Shape
Creates a new WorkflowUpdateOptionsUpdate instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
WorkflowUpdateOptionsUpdate & $Shape
WorkflowUpdateOptionsUpdate instance
▸ create(properties?): WorkflowUpdateOptionsUpdate
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): WorkflowUpdateOptionsUpdate & $Shape
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 & $Shape
WorkflowUpdateOptionsUpdate
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkflowUpdateOptionsUpdate & $Shape
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 & $Shape
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 | $Properties | 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 | $Properties | 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
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