Skip to main content

Class: PollNexusOperationExecutionResponse

Represents a PollNexusOperationExecutionResponse.

Properties​

failure?​

optional failure?: $Properties | null

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.

propagatedNexusSerializationContext?​

optional propagatedNexusSerializationContext?: $Properties | null

Serialization context for this operation's payloads, derived from its stored target. For a reused operation, this is the original execution's context.

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.

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

Call Signature​

static create(properties?): PollNexusOperationExecutionResponse & $Shape

Creates a new PollNexusOperationExecutionResponse instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

PollNexusOperationExecutionResponse & $Shape

PollNexusOperationExecutionResponse instance

Call Signature​

static create(properties?): PollNexusOperationExecutionResponse

Creates a new PollNexusOperationExecutionResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

PollNexusOperationExecutionResponse

PollNexusOperationExecutionResponse instance

decode()​

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

Decodes a PollNexusOperationExecutionResponse 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​

PollNexusOperationExecutionResponse & $Shape

PollNexusOperationExecutionResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): PollNexusOperationExecutionResponse & $Shape

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

Parameters​

reader​

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

static encode(message, writer?): Writer

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

Parameters​

message​

$Properties

PollNexusOperationExecutionResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

PollNexusOperationExecutionResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): PollNexusOperationExecutionResponse

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

Parameters​

object​

Plain object

Returns​

PollNexusOperationExecutionResponse

PollNexusOperationExecutionResponse

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

PollNexusOperationExecutionResponse

PollNexusOperationExecutionResponse

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object