Skip to main content

Class: DescribeNexusOperationExecutionRequest

Represents a DescribeNexusOperationExecutionRequest.

Properties​

includeInput​

includeInput: boolean

Include the input field in the response.

includeOutcome​

includeOutcome: boolean

Include the outcome (result/failure) in the response if the operation has completed.

longPollToken​

longPollToken: Uint8Array

Token from a previous DescribeNexusOperationExecutionResponse. If present, this RPC will long-poll until operation state changes from the state encoded in this token. If absent, return current state immediately. If present, run_id must also be present. Note that operation state may change multiple times between requests, therefore it is not guaranteed that a client making a sequence of long-poll requests will see a complete sequence of state changes.

namespace​

namespace: string

DescribeNexusOperationExecutionRequest namespace.

operationId​

operationId: string

DescribeNexusOperationExecutionRequest operationId.

runId​

runId: string

Operation run ID. If empty the request targets the latest run.

Methods​

toJSON()​

toJSON(): object

Converts this DescribeNexusOperationExecutionRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): DescribeNexusOperationExecutionRequest & $Properties

Creates a new DescribeNexusOperationExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeNexusOperationExecutionRequest & $Properties

DescribeNexusOperationExecutionRequest instance

Call Signature​

static create(properties?): DescribeNexusOperationExecutionRequest

Creates a new DescribeNexusOperationExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DescribeNexusOperationExecutionRequest

DescribeNexusOperationExecutionRequest instance

decode()​

static decode(reader, length?): DescribeNexusOperationExecutionRequest & $Properties

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

DescribeNexusOperationExecutionRequest & $Properties

DescribeNexusOperationExecutionRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): DescribeNexusOperationExecutionRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DescribeNexusOperationExecutionRequest & $Properties

DescribeNexusOperationExecutionRequest

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 DescribeNexusOperationExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.DescribeNexusOperationExecutionRequest.verify|verify messages.

Parameters​

message​

$Properties

DescribeNexusOperationExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

DescribeNexusOperationExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DescribeNexusOperationExecutionRequest

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

Parameters​

object​

Plain object

Returns​

DescribeNexusOperationExecutionRequest

DescribeNexusOperationExecutionRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DescribeNexusOperationExecutionRequest

DescribeNexusOperationExecutionRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object