Class: PollActivityTaskQueueRequest

workflowservice.v1.PollActivityTaskQueueRequest

Represents a PollActivityTaskQueueRequest.

Implements

• IPollActivityTaskQueueRequest

Constructors

constructor

• new PollActivityTaskQueueRequest(properties?): PollActivityTaskQueueRequest

Constructs a new PollActivityTaskQueueRequest.

Parameters

Name	Type	Description
properties?	IPollActivityTaskQueueRequest	Properties to set

Returns

PollActivityTaskQueueRequest

Properties

deploymentOptions

• Optional deploymentOptions: null | IWorkerDeploymentOptions

Worker deployment options that user has set in the worker.

Implementation of

IPollActivityTaskQueueRequest.deploymentOptions

---

identity

• identity: string

The identity of the worker/client

Implementation of

IPollActivityTaskQueueRequest.identity

---

namespace

• namespace: string

PollActivityTaskQueueRequest namespace.

Implementation of

IPollActivityTaskQueueRequest.namespace

---

taskQueue

• Optional taskQueue: null | ITaskQueue

PollActivityTaskQueueRequest taskQueue.

Implementation of

IPollActivityTaskQueueRequest.taskQueue

---

taskQueueMetadata

• Optional taskQueueMetadata: null | ITaskQueueMetadata

PollActivityTaskQueueRequest taskQueueMetadata.

Implementation of

IPollActivityTaskQueueRequest.taskQueueMetadata

---

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.

Implementation of

IPollActivityTaskQueueRequest.workerInstanceKey

---

workerVersionCapabilities

• Optional workerVersionCapabilities: null | IWorkerVersionCapabilities

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.

Implementation of

IPollActivityTaskQueueRequest.workerVersionCapabilities

Methods

toJSON

▸ toJSON(): Object

Converts this PollActivityTaskQueueRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): PollActivityTaskQueueRequest

Creates a new PollActivityTaskQueueRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	IPollActivityTaskQueueRequest	Properties to set

Returns

PollActivityTaskQueueRequest

PollActivityTaskQueueRequest instance

---

decode

▸ decode(reader, length?): PollActivityTaskQueueRequest

Decodes a PollActivityTaskQueueRequest message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

PollActivityTaskQueueRequest

PollActivityTaskQueueRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): PollActivityTaskQueueRequest

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

PollActivityTaskQueueRequest

PollActivityTaskQueueRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

encode

▸ encode(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IPollActivityTaskQueueRequest	PollActivityTaskQueueRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IPollActivityTaskQueueRequest	PollActivityTaskQueueRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): PollActivityTaskQueueRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

PollActivityTaskQueueRequest

PollActivityTaskQueueRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for PollActivityTaskQueueRequest

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	PollActivityTaskQueueRequest	PollActivityTaskQueueRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object