Skip to main content

Interface: $Properties

v1.PollNexusTaskQueueRequest.$Properties

Properties of a PollNexusTaskQueueRequest.

Hierarchy​

Properties​

deploymentOptions​

• Optional deploymentOptions: null | $Properties

Worker deployment options that user has set in the worker.

identity​

• Optional identity: null | string

The identity of the client who initiated this request.

namespace​

• Optional namespace: null | string

PollNexusTaskQueueRequest namespace

pollerGroupId​

• Optional pollerGroupId: null | string

Unless this is the first poll, the client must pass one of the poller group IDs received in poller_group_infos of the last the PollNexusTaskQueueResponse according to the instructions. If not set, the poll is routed randomly which can cause it to be blocked without receiving a task while the queue actually has tasks in another server location.

taskQueue​

• Optional taskQueue: null | $Properties

PollNexusTaskQueueRequest taskQueue

workerHeartbeat​

• Optional workerHeartbeat: null | $Properties[]

Worker info to be sent to the server.

workerInstanceKey​

• Optional workerInstanceKey: null | string

A unique key for this worker instance, used for tracking worker lifecycle. This is guaranteed to be unique, whereas identity is not guaranteed to be unique.

workerVersionCapabilities​

• Optional workerVersionCapabilities: null | $Properties

Information about this worker's build identifier and if it is choosing to use the versioning feature. See the WorkerVersionCapabilities docstring for more. Deprecated. Replaced by deployment_options.