Class: PollWorkflowTaskQueueRequest

workflowservice.v1.PollWorkflowTaskQueueRequest

Represents a PollWorkflowTaskQueueRequest.

Implements

• IPollWorkflowTaskQueueRequest

Constructors

constructor

• new PollWorkflowTaskQueueRequest(properties?): PollWorkflowTaskQueueRequest

Constructs a new PollWorkflowTaskQueueRequest.

Parameters

Name	Type	Description
properties?	IPollWorkflowTaskQueueRequest	Properties to set

Returns

PollWorkflowTaskQueueRequest

Properties

binaryChecksum

• binaryChecksum: string

DEPRECATED since 1.21 - use worker_version_capabilities 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.

Implementation of

IPollWorkflowTaskQueueRequest.binaryChecksum

---

identity

• identity: string

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

Implementation of

IPollWorkflowTaskQueueRequest.identity

---

namespace

• namespace: string

PollWorkflowTaskQueueRequest namespace.

Implementation of

IPollWorkflowTaskQueueRequest.namespace

---

taskQueue

• Optional taskQueue: null | ITaskQueue

PollWorkflowTaskQueueRequest taskQueue.

Implementation of

IPollWorkflowTaskQueueRequest.taskQueue

---

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.

Implementation of

IPollWorkflowTaskQueueRequest.workerVersionCapabilities

Methods

toJSON

▸ toJSON(): Object

Converts this PollWorkflowTaskQueueRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): PollWorkflowTaskQueueRequest

Creates a new PollWorkflowTaskQueueRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	IPollWorkflowTaskQueueRequest	Properties to set

Returns

PollWorkflowTaskQueueRequest

PollWorkflowTaskQueueRequest instance

---

decode

▸ decode(reader, length?): PollWorkflowTaskQueueRequest

Decodes a PollWorkflowTaskQueueRequest 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

PollWorkflowTaskQueueRequest

PollWorkflowTaskQueueRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): PollWorkflowTaskQueueRequest

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

Parameters

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

Returns

PollWorkflowTaskQueueRequest

PollWorkflowTaskQueueRequest

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 PollWorkflowTaskQueueRequest message. Does not implicitly temporal.api.workflowservice.v1.PollWorkflowTaskQueueRequest.verify|verify messages.

Parameters

Name	Type	Description
message	IPollWorkflowTaskQueueRequest	PollWorkflowTaskQueueRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IPollWorkflowTaskQueueRequest	PollWorkflowTaskQueueRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): PollWorkflowTaskQueueRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

PollWorkflowTaskQueueRequest

PollWorkflowTaskQueueRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for PollWorkflowTaskQueueRequest

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 PollWorkflowTaskQueueRequest message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	PollWorkflowTaskQueueRequest	PollWorkflowTaskQueueRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object