Class: PollerGroupsInfo
A versioned snapshot of the poller groups the client should use for future polls to a task queue. The version is monotonically increasing so that a client can ignore a snapshot that is older than the one it has already applied.
Implements
Constructors
constructor
• new PollerGroupsInfo(properties?): PollerGroupsInfo
Constructs a new PollerGroupsInfo.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPollerGroupsInfo | Properties to set |
Returns
Properties
pollerGroups
• pollerGroups: IPollerGroupInfo[]
The weighted list of poller groups the client should use for future polls to this task queue.
Implementation of
IPollerGroupsInfo.pollerGroups
version
• version: Long
Monotonically increasing version of this snapshot. A client should ignore any snapshot whose version is not greater than the one it last applied.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this PollerGroupsInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): PollerGroupsInfo
Creates a new PollerGroupsInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPollerGroupsInfo | Properties to set |
Returns
PollerGroupsInfo instance
decode
▸ decode(reader, length?): PollerGroupsInfo
Decodes a PollerGroupsInfo 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
PollerGroupsInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): PollerGroupsInfo
Decodes a PollerGroupsInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
PollerGroupsInfo
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 PollerGroupsInfo message. Does not implicitly temporal.api.taskqueue.v1.PollerGroupsInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPollerGroupsInfo | PollerGroupsInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified PollerGroupsInfo message, length delimited. Does not implicitly temporal.api.taskqueue.v1.PollerGroupsInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IPollerGroupsInfo | PollerGroupsInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): PollerGroupsInfo
Creates a PollerGroupsInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
PollerGroupsInfo
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for PollerGroupsInfo
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 PollerGroupsInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | PollerGroupsInfo | PollerGroupsInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object