Class: PollNexusTaskQueueResponse
workflowservice.v1.PollNexusTaskQueueResponse
Represents a PollNexusTaskQueueResponse.
Properties
pollerGroupId
• pollerGroupId: string
This poller group ID identifies the owner of the nexus task awaiting for synchronous
response.
Corresponding RespondNexusTaskCompleted and RespondNexusTaskFailed calls should pass this
value for proper response routing.
pollerGroupInfos
• pollerGroupInfos: $Properties[]
The weighted list of poller groups IDs that client should use for future polls to this task queue. Client is expected to:
- Maintain minimum number of pollers no less than the number of groups.
- Try to assign the next poll to a group without any pending polls,
- If every group has some pending polls, assign the next poll to a group randomly according to the weights.
pollerGroupsInfo
• Optional pollerGroupsInfo: null | $Properties
The weighted, versioned list of poller groups IDs that client should use for future polls to
this task queue. Client should ignore this if it has already applied a snapshot with a
version greater than or equal to poller_groups_info.version. Client is expected to:
- Maintain minimum number of pollers no less than the number of groups.
- Try to assign the next poll to a group without any pending polls,
- If every group has some pending polls, assign the next poll to a group randomly according to the weights.
pollerScalingDecision
• Optional pollerScalingDecision: null | $Properties
Server-advised information the SDK may use to adjust its poller count.
request
• Optional request: null | $Properties
Embedded request as translated from the incoming frontend request.
taskToken
• taskToken: Uint8Array
An opaque unique identifier for this task for correlating a completion request the embedded request.
Methods
toJSON
▸ toJSON(): Object
Converts this PollNexusTaskQueueResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): PollNexusTaskQueueResponse & $Shape
Creates a new PollNexusTaskQueueResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
PollNexusTaskQueueResponse & $Shape
PollNexusTaskQueueResponse instance
▸ create(properties?): PollNexusTaskQueueResponse
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): PollNexusTaskQueueResponse & $Shape
Decodes a PollNexusTaskQueueResponse 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
PollNexusTaskQueueResponse & $Shape
PollNexusTaskQueueResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): PollNexusTaskQueueResponse & $Shape
Decodes a PollNexusTaskQueueResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
PollNexusTaskQueueResponse & $Shape
PollNexusTaskQueueResponse
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 PollNexusTaskQueueResponse message. Does not implicitly temporal.api.workflowservice.v1.PollNexusTaskQueueResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | PollNexusTaskQueueResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified PollNexusTaskQueueResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.PollNexusTaskQueueResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | PollNexusTaskQueueResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): PollNexusTaskQueueResponse
Creates a PollNexusTaskQueueResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
PollNexusTaskQueueResponse
toObject
▸ toObject(message, options?): Object
Creates a plain object from a PollNexusTaskQueueResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | PollNexusTaskQueueResponse | PollNexusTaskQueueResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object