Class: PollActivityTaskQueueRequest

Represents a PollActivityTaskQueueRequest.

Properties

deploymentOptions?

optional deploymentOptions?: $Properties | null

Worker deployment options that user has set in the worker.

---

identity

identity: string

The identity of the worker/client

---

namespace

namespace: string

PollActivityTaskQueueRequest namespace.

---

pollerGroupId

pollerGroupId: 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.

---

taskQueue?

optional taskQueue?: $Properties | null

PollActivityTaskQueueRequest taskQueue.

---

taskQueueMetadata?

optional taskQueueMetadata?: $Properties | null

PollActivityTaskQueueRequest taskQueueMetadata.

---

workerControlTaskQueue

workerControlTaskQueue: 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

workerInstanceKey: 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?: $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.

Methods

toJSON()

toJSON(): object

Converts this PollActivityTaskQueueRequest to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): PollActivityTaskQueueRequest & $Properties

Creates a new PollActivityTaskQueueRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

PollActivityTaskQueueRequest & $Properties

PollActivityTaskQueueRequest instance

Call Signature

static create(properties?): PollActivityTaskQueueRequest

Creates a new PollActivityTaskQueueRequest instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

PollActivityTaskQueueRequest

PollActivityTaskQueueRequest instance

---

decode()

static decode(reader, length?): PollActivityTaskQueueRequest & $Properties

Decodes a PollActivityTaskQueueRequest message from the specified reader or buffer.

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?

number

Message length if known beforehand

Returns

PollActivityTaskQueueRequest & $Properties

PollActivityTaskQueueRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): PollActivityTaskQueueRequest & $Properties

Decodes a PollActivityTaskQueueRequest message from the specified reader or buffer, length delimited.

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

PollActivityTaskQueueRequest & $Properties

PollActivityTaskQueueRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode()

static encode(message, writer?): Writer

Encodes the specified PollActivityTaskQueueRequest message. Does not implicitly temporal.api.workflowservice.v1.PollActivityTaskQueueRequest.verify|verify messages.

Parameters

message

$Properties

PollActivityTaskQueueRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

Encodes the specified PollActivityTaskQueueRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.PollActivityTaskQueueRequest.verify|verify messages.

Parameters

message

$Properties

PollActivityTaskQueueRequest message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): PollActivityTaskQueueRequest

Creates a PollActivityTaskQueueRequest message from a plain object. Also converts values to their respective internal types.

Parameters

object

Plain object

Returns

PollActivityTaskQueueRequest

PollActivityTaskQueueRequest

---

toObject()

static toObject(message, options?): object

Creates a plain object from a PollActivityTaskQueueRequest message. Also converts values to other types if specified.

Parameters

message

PollActivityTaskQueueRequest

PollActivityTaskQueueRequest

options?

IConversionOptions

Conversion options

Returns

object

Plain object