Class: PollNexusTaskQueueRequest

workflowservice.v1.PollNexusTaskQueueRequest

Represents a PollNexusTaskQueueRequest.

Implements

• IPollNexusTaskQueueRequest

Constructors

constructor

• new PollNexusTaskQueueRequest(properties?): PollNexusTaskQueueRequest

Constructs a new PollNexusTaskQueueRequest.

Parameters

Name	Type	Description
properties?	IPollNexusTaskQueueRequest	Properties to set

Returns

PollNexusTaskQueueRequest

Properties

deploymentOptions

• Optional deploymentOptions: null | IWorkerDeploymentOptions

Worker deployment options that user has set in the worker.

Implementation of

IPollNexusTaskQueueRequest.deploymentOptions

---

identity

• identity: string

The identity of the client who initiated this request.

Implementation of

IPollNexusTaskQueueRequest.identity

---

namespace

• namespace: string

PollNexusTaskQueueRequest namespace.

Implementation of

IPollNexusTaskQueueRequest.namespace

---

taskQueue

• Optional taskQueue: null | ITaskQueue

PollNexusTaskQueueRequest taskQueue.

Implementation of

IPollNexusTaskQueueRequest.taskQueue

---

workerHeartbeat

• workerHeartbeat: IWorkerHeartbeat[]

Worker info to be sent to the server.

Implementation of

IPollNexusTaskQueueRequest.workerHeartbeat

---

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

IPollNexusTaskQueueRequest.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

IPollNexusTaskQueueRequest.workerVersionCapabilities

Methods

toJSON

▸ toJSON(): Object

Converts this PollNexusTaskQueueRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): PollNexusTaskQueueRequest

Creates a new PollNexusTaskQueueRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	IPollNexusTaskQueueRequest	Properties to set

Returns

PollNexusTaskQueueRequest

PollNexusTaskQueueRequest instance

---

decode

▸ decode(reader, length?): PollNexusTaskQueueRequest

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

PollNexusTaskQueueRequest

PollNexusTaskQueueRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): PollNexusTaskQueueRequest

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

Parameters

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

Returns

PollNexusTaskQueueRequest

PollNexusTaskQueueRequest

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

Parameters

Name	Type	Description
message	IPollNexusTaskQueueRequest	PollNexusTaskQueueRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IPollNexusTaskQueueRequest	PollNexusTaskQueueRequest message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): PollNexusTaskQueueRequest

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

PollNexusTaskQueueRequest

PollNexusTaskQueueRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for PollNexusTaskQueueRequest

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

Parameters

Name	Type	Description
message	PollNexusTaskQueueRequest	PollNexusTaskQueueRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object