Class: UpdateWorkflowExecutionResponse
workflowservice.v1.UpdateWorkflowExecutionResponse
Represents an UpdateWorkflowExecutionResponse.
Implements
Constructors
constructor
• new UpdateWorkflowExecutionResponse(properties?): UpdateWorkflowExecutionResponse
Constructs a new UpdateWorkflowExecutionResponse.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateWorkflowExecutionResponse | Properties to set |
Returns
UpdateWorkflowExecutionResponse
Properties
outcome
• Optional outcome: null | IOutcome
The outcome of the Update if and only if the Workflow Update has completed. If this response is being returned before the Update has completed then this field will not be set.
Implementation of
IUpdateWorkflowExecutionResponse.outcome
stage
• stage: UpdateWorkflowExecutionLifecycleStage
The most advanced lifecycle stage that the Update is known to have reached, where lifecycle stages are ordered UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_UNSPECIFIED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ADMITTED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED < UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_COMPLETED. UNSPECIFIED will be returned if and only if the server's maximum wait time was reached before the Update reached the stage specified in the request WaitPolicy, and before the context deadline expired; clients may may then retry the call as needed.
Implementation of
IUpdateWorkflowExecutionResponse.stage
updateRef
• Optional updateRef: null | IUpdateRef
Enough information for subsequent poll calls if needed. Never null.
Implementation of
IUpdateWorkflowExecutionResponse.updateRef
Methods
toJSON
▸ toJSON(): Object
Converts this UpdateWorkflowExecutionResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UpdateWorkflowExecutionResponse
Creates a new UpdateWorkflowExecutionResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateWorkflowExecutionResponse | Properties to set |
Returns
UpdateWorkflowExecutionResponse
UpdateWorkflowExecutionResponse instance
decode
▸ decode(reader, length?): UpdateWorkflowExecutionResponse
Decodes an UpdateWorkflowExecutionResponse 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
UpdateWorkflowExecutionResponse
UpdateWorkflowExecutionResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UpdateWorkflowExecutionResponse
Decodes an UpdateWorkflowExecutionResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UpdateWorkflowExecutionResponse
UpdateWorkflowExecutionResponse
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 UpdateWorkflowExecutionResponse message. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkflowExecutionResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateWorkflowExecutionResponse | UpdateWorkflowExecutionResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UpdateWorkflowExecutionResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.UpdateWorkflowExecutionResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateWorkflowExecutionResponse | UpdateWorkflowExecutionResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UpdateWorkflowExecutionResponse
Creates an UpdateWorkflowExecutionResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UpdateWorkflowExecutionResponse
UpdateWorkflowExecutionResponse
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for UpdateWorkflowExecutionResponse
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 UpdateWorkflowExecutionResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UpdateWorkflowExecutionResponse | UpdateWorkflowExecutionResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object