Skip to main content

Interface: IPollActivityTaskQueueRequest

workflowservice.v1.IPollActivityTaskQueueRequest

Properties of a PollActivityTaskQueueRequest.

Hierarchy

Properties

deploymentOptions

Optional deploymentOptions: null | $Properties

Worker deployment options that user has set in the worker.

Inherited from

$Properties.deploymentOptions


identity

Optional identity: null | string

The identity of the worker/client

Inherited from

$Properties.identity


namespace

Optional namespace: null | string

PollActivityTaskQueueRequest namespace

Inherited from

$Properties.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 PollActivityTaskQueueResponse 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.

Inherited from

$Properties.pollerGroupId


taskQueue

Optional taskQueue: null | $Properties

PollActivityTaskQueueRequest taskQueue

Inherited from

$Properties.taskQueue


taskQueueMetadata

Optional taskQueueMetadata: null | $Properties

PollActivityTaskQueueRequest taskQueueMetadata

Inherited from

$Properties.taskQueueMetadata


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.

Inherited from

$Properties.workerControlTaskQueue


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.

Inherited from

$Properties.workerInstanceKey


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.

Inherited from

$Properties.workerVersionCapabilities