Skip to main content

Interface: $Properties

v1.PollWorkflowTaskQueueRequest.$Properties

Properties of a PollWorkflowTaskQueueRequest.

Hierarchy​

Properties​

binaryChecksum​

• Optional binaryChecksum: null | string

Deprecated. Use deployment_options instead. Each worker process should provide an ID unique to the specific set of code it is running "checksum" in this field name isn't very accurate, it should be though of as an id.

deploymentOptions​

• Optional deploymentOptions: null | $Properties

Worker deployment options that user has set in the worker.

identity​

• Optional identity: null | string

The identity of the worker/client who is polling this task queue

namespace​

• Optional namespace: null | string

PollWorkflowTaskQueueRequest 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 PollWorkflowTaskQueueResponse 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

PollWorkflowTaskQueueRequest taskQueue

workerControlTaskQueue​

• Optional workerControlTaskQueue: null | string

A dedicated per-worker Nexus task queue on which the server sends control tasks (e.g. activity cancellation) to this specific worker instance.

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

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