Class: 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?: $Properties | null

The failure if the operation completed unsuccessfully.

---

info?

optional info?: $Properties | null

Information about the operation.

---

input?

optional input?: $Properties | null

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?: $Properties | null

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()

Call Signature

static create(properties?): DescribeNexusOperationExecutionResponse & $Shape

Creates a new DescribeNexusOperationExecutionResponse instance using the specified properties.

Parameters

properties?

$Shape

Properties to set

Returns

DescribeNexusOperationExecutionResponse & $Shape

DescribeNexusOperationExecutionResponse instance

Call Signature

static create(properties?): DescribeNexusOperationExecutionResponse

Creates a new DescribeNexusOperationExecutionResponse instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

DescribeNexusOperationExecutionResponse

DescribeNexusOperationExecutionResponse instance

---

decode()

static decode(reader, length?): DescribeNexusOperationExecutionResponse & $Shape

Decodes a DescribeNexusOperationExecutionResponse message from the specified reader or buffer.

Parameters

reader

Uint8Array<ArrayBufferLike> | 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()

static decodeDelimited(reader): DescribeNexusOperationExecutionResponse & $Shape

Decodes a DescribeNexusOperationExecutionResponse message from the specified reader or buffer, length delimited.

Parameters

reader

Uint8Array<ArrayBufferLike> | 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()

static encode(message, writer?): Writer

Encodes the specified DescribeNexusOperationExecutionResponse message. Does not implicitly temporal.api.workflowservice.v1.DescribeNexusOperationExecutionResponse.verify|verify messages.

Parameters

message

$Properties

DescribeNexusOperationExecutionResponse message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

Encodes the specified DescribeNexusOperationExecutionResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.DescribeNexusOperationExecutionResponse.verify|verify messages.

Parameters

message

$Properties

DescribeNexusOperationExecutionResponse message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): DescribeNexusOperationExecutionResponse

Creates a DescribeNexusOperationExecutionResponse message from a plain object. Also converts values to their respective internal types.

Parameters

object

Plain object

Returns

DescribeNexusOperationExecutionResponse

DescribeNexusOperationExecutionResponse

---

toObject()

static toObject(message, options?): object

Creates a plain object from a DescribeNexusOperationExecutionResponse message. Also converts values to other types if specified.

Parameters

message

DescribeNexusOperationExecutionResponse

DescribeNexusOperationExecutionResponse

options?

IConversionOptions

Conversion options

Returns

object

Plain object