Skip to main content

Interface: $Properties

v1.PollNexusTaskQueueResponse.$Properties

Properties of a PollNexusTaskQueueResponse.

Hierarchy​

Properties​

pollerGroupId​

• Optional pollerGroupId: null | 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​

• Optional pollerGroupInfos: null | $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: null | $Properties

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: null | $Properties

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

request​

• Optional request: null | $Properties

Embedded request as translated from the incoming frontend request.

taskToken​

• Optional taskToken: null | Uint8Array

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