Class: PollNexusTaskQueueRequest
workflowservice.v1.PollNexusTaskQueueRequest
Represents a PollNexusTaskQueueRequest.
Properties
deploymentOptions
• Optional deploymentOptions: null | $Properties
Worker deployment options that user has set in the worker.
identity
• identity: string
The identity of the client who initiated this request.
namespace
• namespace: string
PollNexusTaskQueueRequest 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 PollNexusTaskQueueResponse 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: null | $Properties
PollNexusTaskQueueRequest taskQueue.
workerHeartbeat
• workerHeartbeat: $Properties[]
Worker info to be sent to the server.
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: 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.
Methods
toJSON
▸ toJSON(): Object
Converts this PollNexusTaskQueueRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): PollNexusTaskQueueRequest & $Shape
Creates a new PollNexusTaskQueueRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
PollNexusTaskQueueRequest & $Shape
PollNexusTaskQueueRequest instance
▸ create(properties?): PollNexusTaskQueueRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): PollNexusTaskQueueRequest & $Shape
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 & $Shape
PollNexusTaskQueueRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): PollNexusTaskQueueRequest & $Shape
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 & $Shape
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 | $Properties | 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 | $Properties | 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
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