Class: UpdateWorkflowExecutionCompleted
v1.CallbackInfo.UpdateWorkflowExecutionCompleted
Trigger for when a workflow update is completed.
Implements
Constructors
constructor
• new UpdateWorkflowExecutionCompleted(properties?): UpdateWorkflowExecutionCompleted
Constructs a new UpdateWorkflowExecutionCompleted.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateWorkflowExecutionCompleted | Properties to set |
Returns
UpdateWorkflowExecutionCompleted
Properties
updateId
• updateId: string
UpdateWorkflowExecutionCompleted updateId.
Implementation of
IUpdateWorkflowExecutionCompleted.updateId
Methods
toJSON
▸ toJSON(): Object
Converts this UpdateWorkflowExecutionCompleted to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UpdateWorkflowExecutionCompleted
Creates a new UpdateWorkflowExecutionCompleted instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateWorkflowExecutionCompleted | Properties to set |
Returns
UpdateWorkflowExecutionCompleted
UpdateWorkflowExecutionCompleted instance
decode
▸ decode(reader, length?): UpdateWorkflowExecutionCompleted
Decodes an UpdateWorkflowExecutionCompleted 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
UpdateWorkflowExecutionCompleted
UpdateWorkflowExecutionCompleted
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UpdateWorkflowExecutionCompleted
Decodes an UpdateWorkflowExecutionCompleted message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UpdateWorkflowExecutionCompleted
UpdateWorkflowExecutionCompleted
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 UpdateWorkflowExecutionCompleted message. Does not implicitly temporal.api.workflow.v1.CallbackInfo.UpdateWorkflowExecutionCompleted.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateWorkflowExecutionCompleted | UpdateWorkflowExecutionCompleted message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UpdateWorkflowExecutionCompleted message, length delimited. Does not implicitly temporal.api.workflow.v1.CallbackInfo.UpdateWorkflowExecutionCompleted.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateWorkflowExecutionCompleted | UpdateWorkflowExecutionCompleted message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UpdateWorkflowExecutionCompleted
Creates an UpdateWorkflowExecutionCompleted message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UpdateWorkflowExecutionCompleted
UpdateWorkflowExecutionCompleted
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for UpdateWorkflowExecutionCompleted
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 an UpdateWorkflowExecutionCompleted message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UpdateWorkflowExecutionCompleted | UpdateWorkflowExecutionCompleted |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object