Skip to main content

Class: PollNexusTaskQueueResponse

Represents a 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.

pollerGroupInfos​

pollerGroupInfos: $Properties[]

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.

pollerGroupsInfo?​

optional pollerGroupsInfo?: $Properties | null

The weighted, versioned list of poller groups IDs that client should use for future polls to this task queue. Client should ignore this if it has already applied a snapshot with a version greater than or equal to poller_groups_info.version. 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.

pollerScalingDecision?​

optional pollerScalingDecision?: $Properties | null

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

request?​

optional request?: $Properties | null

Embedded request as translated from the incoming frontend request.

taskToken​

taskToken: Uint8Array

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

Methods​

toJSON()​

toJSON(): object

Converts this PollNexusTaskQueueResponse to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): PollNexusTaskQueueResponse & $Shape

Creates a new PollNexusTaskQueueResponse instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

PollNexusTaskQueueResponse & $Shape

PollNexusTaskQueueResponse instance

Call Signature​

static create(properties?): PollNexusTaskQueueResponse

Creates a new PollNexusTaskQueueResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

PollNexusTaskQueueResponse

PollNexusTaskQueueResponse instance

decode()​

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

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

PollNexusTaskQueueResponse & $Shape

PollNexusTaskQueueResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): PollNexusTaskQueueResponse & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

PollNexusTaskQueueResponse & $Shape

PollNexusTaskQueueResponse

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

Parameters​

message​

$Properties

PollNexusTaskQueueResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

PollNexusTaskQueueResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): PollNexusTaskQueueResponse

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

Parameters​

object​

Plain object

Returns​

PollNexusTaskQueueResponse

PollNexusTaskQueueResponse

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

PollNexusTaskQueueResponse

PollNexusTaskQueueResponse

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object