Class: PollWorkflowExecutionUpdateResponse
workflowservice.v1.PollWorkflowExecutionUpdateResponse
Represents a PollWorkflowExecutionUpdateResponse.
Implements
Constructors
constructor
• new PollWorkflowExecutionUpdateResponse(properties?): PollWorkflowExecutionUpdateResponse
Constructs a new PollWorkflowExecutionUpdateResponse.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPollWorkflowExecutionUpdateResponse | Properties to set |
Returns
PollWorkflowExecutionUpdateResponse
Properties
outcome
• Optional outcome: null | IOutcome
The outcome of the update if and only if the update has completed. If this response is being returned before the update has completed (e.g. due to the specification of a wait policy that only waits on UPDATE_WORKFLOW_EXECUTION_LIFECYCLE_STAGE_ACCEPTED) then this field will not be set.
Implementation of
IPollWorkflowExecutionUpdateResponse.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
IPollWorkflowExecutionUpdateResponse.stage
updateRef
• Optional updateRef: null | IUpdateRef
Sufficient information to address this update.
Implementation of
IPollWorkflowExecutionUpdateResponse.updateRef
Methods
toJSON
▸ toJSON(): Object
Converts this PollWorkflowExecutionUpdateResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): PollWorkflowExecutionUpdateResponse
Creates a new PollWorkflowExecutionUpdateResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPollWorkflowExecutionUpdateResponse | Properties to set |
Returns
PollWorkflowExecutionUpdateResponse
PollWorkflowExecutionUpdateResponse instance
decode
▸ decode(reader, length?): PollWorkflowExecutionUpdateResponse
Decodes a PollWorkflowExecutionUpdateResponse 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
PollWorkflowExecutionUpdateResponse
PollWorkflowExecutionUpdateResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): PollWorkflowExecutionUpdateResponse
Decodes a PollWorkflowExecutionUpdateResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
PollWorkflowExecutionUpdateResponse
PollWorkflowExecutionUpdateResponse
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 PollWorkflowExecutionUpdateResponse message. Does not implicitly temporal.api.workflowservice.v1.PollWorkflowExecutionUpdateResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPollWorkflowExecutionUpdateResponse | PollWorkflowExecutionUpdateResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified PollWorkflowExecutionUpdateResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.PollWorkflowExecutionUpdateResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPollWorkflowExecutionUpdateResponse | PollWorkflowExecutionUpdateResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): PollWorkflowExecutionUpdateResponse
Creates a PollWorkflowExecutionUpdateResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
PollWorkflowExecutionUpdateResponse
PollWorkflowExecutionUpdateResponse
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for PollWorkflowExecutionUpdateResponse
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 PollWorkflowExecutionUpdateResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | PollWorkflowExecutionUpdateResponse | PollWorkflowExecutionUpdateResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object