Skip to main content

Class: PollNexusTaskQueueResponse

workflowservice.v1.PollNexusTaskQueueResponse

Represents a PollNexusTaskQueueResponse.

Implements

Constructors

constructor

new PollNexusTaskQueueResponse(properties?): PollNexusTaskQueueResponse

Constructs a new PollNexusTaskQueueResponse.

Parameters

NameTypeDescription
properties?IPollNexusTaskQueueResponseProperties to set

Returns

PollNexusTaskQueueResponse

Properties

pollerGroupId

pollerGroupId: string

This poller group ID identifies the owner of the nexus task awaiting for synchronous response. Corresponding RespondNexusTaskCompleted and RespondNexusTaskFailed calls should pass this value for proper response routing.

Implementation of

IPollNexusTaskQueueResponse.pollerGroupId


pollerGroupInfos

pollerGroupInfos: IPollerGroupInfo[]

The weighted list of poller groups IDs that client should use for future polls to this task queue. Client is expected to:

  1. Maintain minimum number of pollers no less than the number of groups.
  2. Try to assign the next poll to a group without any pending polls,
  3. If every group has some pending polls, assign the next poll to a group randomly according to the weights.

Implementation of

IPollNexusTaskQueueResponse.pollerGroupInfos


pollerScalingDecision

Optional pollerScalingDecision: null | IPollerScalingDecision

Server-advised information the SDK may use to adjust its poller count.

Implementation of

IPollNexusTaskQueueResponse.pollerScalingDecision


request

Optional request: null | IRequest

Embedded request as translated from the incoming frontend request.

Implementation of

IPollNexusTaskQueueResponse.request


taskToken

taskToken: Uint8Array

An opaque unique identifier for this task for correlating a completion request the embedded request.

Implementation of

IPollNexusTaskQueueResponse.taskToken

Methods

toJSON

toJSON(): Object

Converts this PollNexusTaskQueueResponse to JSON.

Returns

Object

JSON object


create

create(properties?): PollNexusTaskQueueResponse

Creates a new PollNexusTaskQueueResponse instance using the specified properties.

Parameters

NameTypeDescription
properties?IPollNexusTaskQueueResponseProperties to set

Returns

PollNexusTaskQueueResponse

PollNexusTaskQueueResponse instance


decode

decode(reader, length?): PollNexusTaskQueueResponse

Decodes a PollNexusTaskQueueResponse message from the specified reader or buffer.

Parameters

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

Returns

PollNexusTaskQueueResponse

PollNexusTaskQueueResponse

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): PollNexusTaskQueueResponse

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

PollNexusTaskQueueResponse

PollNexusTaskQueueResponse

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

Parameters

NameTypeDescription
messageIPollNexusTaskQueueResponsePollNexusTaskQueueResponse message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIPollNexusTaskQueueResponsePollNexusTaskQueueResponse message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): PollNexusTaskQueueResponse

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

PollNexusTaskQueueResponse

PollNexusTaskQueueResponse


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for PollNexusTaskQueueResponse

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 PollNexusTaskQueueResponse message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messagePollNexusTaskQueueResponsePollNexusTaskQueueResponse
options?IConversionOptionsConversion options

Returns

Object

Plain object