Skip to main content

Interface: $Properties

Properties of a PollNexusTaskQueueRequest.

Extended by​

Properties​

deploymentOptions?​

optional deploymentOptions?: $Properties | null

Worker deployment options that user has set in the worker.

identity?​

optional identity?: string | null

The identity of the client who initiated this request.

namespace?​

optional namespace?: string | null

PollNexusTaskQueueRequest namespace

pollerGroupId?​

optional pollerGroupId?: string | null

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

PollNexusTaskQueueRequest taskQueue

workerHeartbeat?​

optional workerHeartbeat?: $Properties[] | null

Worker info to be sent to the server.

workerInstanceKey?​

optional workerInstanceKey?: string | null

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

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.