Skip to main content

Class: PollNexusOperationExecutionRequest

workflowservice.v1.PollNexusOperationExecutionRequest

Represents a PollNexusOperationExecutionRequest.

Implements

Constructors

constructor

new PollNexusOperationExecutionRequest(properties?): PollNexusOperationExecutionRequest

Constructs a new PollNexusOperationExecutionRequest.

Parameters

NameTypeDescription
properties?IPollNexusOperationExecutionRequestProperties to set

Returns

PollNexusOperationExecutionRequest

Properties

namespace

namespace: string

PollNexusOperationExecutionRequest namespace.

Implementation of

IPollNexusOperationExecutionRequest.namespace


operationId

operationId: string

PollNexusOperationExecutionRequest operationId.

Implementation of

IPollNexusOperationExecutionRequest.operationId


runId

runId: string

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

Implementation of

IPollNexusOperationExecutionRequest.runId


waitStage

waitStage: NexusOperationWaitStage

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

Implementation of

IPollNexusOperationExecutionRequest.waitStage

Methods

toJSON

toJSON(): Object

Converts this PollNexusOperationExecutionRequest to JSON.

Returns

Object

JSON object


create

create(properties?): PollNexusOperationExecutionRequest

Creates a new PollNexusOperationExecutionRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IPollNexusOperationExecutionRequestProperties to set

Returns

PollNexusOperationExecutionRequest

PollNexusOperationExecutionRequest instance


decode

decode(reader, length?): PollNexusOperationExecutionRequest

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

PollNexusOperationExecutionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): PollNexusOperationExecutionRequest

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

PollNexusOperationExecutionRequest

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
messageIPollNexusOperationExecutionRequestPollNexusOperationExecutionRequest 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
messageIPollNexusOperationExecutionRequestPollNexusOperationExecutionRequest 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


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for PollNexusOperationExecutionRequest

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


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