Skip to main content

Class: PollerGroupsInfo

taskqueue.v1.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.

Properties​

pollerGroups​

• pollerGroups: $Properties[]

The weighted list of poller groups the client should use for future polls to this task queue.


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.

Methods​

toJSON​

▸ toJSON(): Object

Converts this PollerGroupsInfo to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): PollerGroupsInfo & $Properties

Creates a new PollerGroupsInfo instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

PollerGroupsInfo & $Properties

PollerGroupsInfo instance

▸ create(properties?): PollerGroupsInfo

Parameters​

NameType
properties?$Properties

Returns​

PollerGroupsInfo


decode​

▸ decode(reader, length?): PollerGroupsInfo & $Properties

Decodes a PollerGroupsInfo message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

PollerGroupsInfo & $Properties

PollerGroupsInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): PollerGroupsInfo & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

PollerGroupsInfo & $Properties

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​

NameTypeDescription
message$PropertiesPollerGroupsInfo message or plain object to encode
writer?WriterWriter 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​

NameTypeDescription
message$PropertiesPollerGroupsInfo message or plain object to encode
writer?WriterWriter 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​

NameTypeDescription
objectObjectPlain object

Returns​

PollerGroupsInfo

PollerGroupsInfo


toObject​

▸ toObject(message, options?): Object

Creates a plain object from a PollerGroupsInfo message. Also converts values to other types if specified.

Parameters​

NameTypeDescription
messagePollerGroupsInfoPollerGroupsInfo
options?IConversionOptionsConversion options

Returns​

Object

Plain object