Class: DescribeNexusOperationExecutionResponse
workflowservice.v1.DescribeNexusOperationExecutionResponse
Represents a DescribeNexusOperationExecutionResponse.
Properties
completionCallbacks
• completionCallbacks: $Properties[]
Completion callbacks to be invoked once the Nexus operation reaches a terminal state. They will remain in the CALLBACK_STATE_STANDBY state until the Nexus operation is finished.
failure
• Optional failure: null | $Properties
The failure if the operation completed unsuccessfully.
info
• Optional info: null | $Properties
Information about the operation.
input
• Optional input: null | $Properties
Serialized operation input, passed as the request payload. Only set if include_input was true in the request.
longPollToken
• longPollToken: Uint8Array
Token for follow-on long-poll requests. Absent only if the operation is complete.
outcome
• Optional outcome: "failure" | "result"
Only set if the operation is completed and include_outcome was true in the request.
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.
Methods
toJSON
▸ toJSON(): Object
Converts this DescribeNexusOperationExecutionResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DescribeNexusOperationExecutionResponse & $Shape
Creates a new DescribeNexusOperationExecutionResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
DescribeNexusOperationExecutionResponse & $Shape
DescribeNexusOperationExecutionResponse instance
▸ create(properties?): DescribeNexusOperationExecutionResponse
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
DescribeNexusOperationExecutionResponse
decode
▸ decode(reader, length?): DescribeNexusOperationExecutionResponse & $Shape
Decodes a DescribeNexusOperationExecutionResponse 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
DescribeNexusOperationExecutionResponse & $Shape
DescribeNexusOperationExecutionResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DescribeNexusOperationExecutionResponse & $Shape
Decodes a DescribeNexusOperationExecutionResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
DescribeNexusOperationExecutionResponse & $Shape
DescribeNexusOperationExecutionResponse
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 DescribeNexusOperationExecutionResponse message. Does not implicitly temporal.api.workflowservice.v1.DescribeNexusOperationExecutionResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DescribeNexusOperationExecutionResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified DescribeNexusOperationExecutionResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.DescribeNexusOperationExecutionResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DescribeNexusOperationExecutionResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): DescribeNexusOperationExecutionResponse
Creates a DescribeNexusOperationExecutionResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
DescribeNexusOperationExecutionResponse
DescribeNexusOperationExecutionResponse
toObject
▸ toObject(message, options?): Object
Creates a plain object from a DescribeNexusOperationExecutionResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | DescribeNexusOperationExecutionResponse | DescribeNexusOperationExecutionResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object