Class: PollNexusOperationExecutionResponse
workflowservice.v1.PollNexusOperationExecutionResponse
Represents a PollNexusOperationExecutionResponse.
Properties
failure
• Optional failure: null | $Properties
The failure if the operation completed unsuccessfully.
operationToken
• operationToken: string
Operation token. Only populated for asynchronous operations after a successful StartOperation call.
outcome
• Optional outcome: "failure" | "result"
The operation outcome, available if the operation is in a closed state.
result
• Optional result: null | $Properties
The result if the operation completed successfully.
runId
• runId: string
The run ID of the operation, useful when run_id was not specified in the request.
waitStage
• waitStage: NexusOperationWaitStage
The current stage of the operation. May be more advanced than the stage requested in the poll.
Methods
toJSON
▸ toJSON(): Object
Converts this PollNexusOperationExecutionResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): PollNexusOperationExecutionResponse & $Shape
Creates a new PollNexusOperationExecutionResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
PollNexusOperationExecutionResponse & $Shape
PollNexusOperationExecutionResponse instance
▸ create(properties?): PollNexusOperationExecutionResponse
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
PollNexusOperationExecutionResponse
decode
▸ decode(reader, length?): PollNexusOperationExecutionResponse & $Shape
Decodes a PollNexusOperationExecutionResponse 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
PollNexusOperationExecutionResponse & $Shape
PollNexusOperationExecutionResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): PollNexusOperationExecutionResponse & $Shape
Decodes a PollNexusOperationExecutionResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
PollNexusOperationExecutionResponse & $Shape
PollNexusOperationExecutionResponse
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 PollNexusOperationExecutionResponse message. Does not implicitly temporal.api.workflowservice.v1.PollNexusOperationExecutionResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | PollNexusOperationExecutionResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified PollNexusOperationExecutionResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.PollNexusOperationExecutionResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | PollNexusOperationExecutionResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): PollNexusOperationExecutionResponse
Creates a PollNexusOperationExecutionResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
PollNexusOperationExecutionResponse
PollNexusOperationExecutionResponse
toObject
▸ toObject(message, options?): Object
Creates a plain object from a PollNexusOperationExecutionResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | PollNexusOperationExecutionResponse | PollNexusOperationExecutionResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object