Skip to main content

Class: PollNexusOperationExecutionRequest

workflowservice.v1.PollNexusOperationExecutionRequest

Represents a PollNexusOperationExecutionRequest.

Properties​

namespace​

• namespace: string

PollNexusOperationExecutionRequest namespace.


operationId​

• operationId: string

PollNexusOperationExecutionRequest operationId.


runId​

• runId: string

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


waitStage​

• waitStage: NexusOperationWaitStage

Stage to wait for. The operation may be in a more advanced stage when the poll is unblocked.

Methods​

toJSON​

▸ toJSON(): Object

Converts this PollNexusOperationExecutionRequest to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): PollNexusOperationExecutionRequest & $Properties

Creates a new PollNexusOperationExecutionRequest instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

PollNexusOperationExecutionRequest & $Properties

PollNexusOperationExecutionRequest instance

▸ create(properties?): PollNexusOperationExecutionRequest

Parameters​

NameType
properties?$Properties

Returns​

PollNexusOperationExecutionRequest


decode​

▸ decode(reader, length?): PollNexusOperationExecutionRequest & $Properties

Decodes a PollNexusOperationExecutionRequest message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

PollNexusOperationExecutionRequest & $Properties

PollNexusOperationExecutionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): PollNexusOperationExecutionRequest & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

PollNexusOperationExecutionRequest & $Properties

PollNexusOperationExecutionRequest

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

Parameters​

NameTypeDescription
message$PropertiesPollNexusOperationExecutionRequest message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesPollNexusOperationExecutionRequest message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): PollNexusOperationExecutionRequest

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

PollNexusOperationExecutionRequest

PollNexusOperationExecutionRequest


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messagePollNexusOperationExecutionRequestPollNexusOperationExecutionRequest
options?IConversionOptionsConversion options

Returns​

Object

Plain object