Class: PollWorkflowTaskQueueRequest
workflowservice.v1.PollWorkflowTaskQueueRequest
Represents a PollWorkflowTaskQueueRequest.
Properties
binaryChecksum
• binaryChecksum: string
Deprecated. Use deployment_options 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.
deploymentOptions
• Optional deploymentOptions: null | $Properties
Worker deployment options that user has set in the worker.
identity
• identity: string
The identity of the worker/client who is polling this task queue
namespace
• namespace: string
PollWorkflowTaskQueueRequest 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 PollWorkflowTaskQueueResponse 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
PollWorkflowTaskQueueRequest taskQueue.
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: null | $Properties
Deprecated. Use deployment_options instead.
Information about this worker's build identifier and if it is choosing to use the versioning
feature. See the WorkerVersionCapabilities docstring for more.
Methods
toJSON
▸ toJSON(): Object
Converts this PollWorkflowTaskQueueRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): PollWorkflowTaskQueueRequest & $Properties
Creates a new PollWorkflowTaskQueueRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
PollWorkflowTaskQueueRequest & $Properties
PollWorkflowTaskQueueRequest instance
▸ create(properties?): PollWorkflowTaskQueueRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): PollWorkflowTaskQueueRequest & $Properties
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 & $Properties
PollWorkflowTaskQueueRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): PollWorkflowTaskQueueRequest & $Properties
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 & $Properties
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 | $Properties | 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 | $Properties | 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
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