Skip to main content

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.

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()​

Call Signature​

static create(properties?): PollerGroupsInfo & $Properties

Creates a new PollerGroupsInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

PollerGroupsInfo & $Properties

PollerGroupsInfo instance

Call Signature​

static create(properties?): PollerGroupsInfo

Creates a new PollerGroupsInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

PollerGroupsInfo

PollerGroupsInfo instance

decode()​

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

Decodes a PollerGroupsInfo message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message 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()​

static decodeDelimited(reader): PollerGroupsInfo & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader 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()​

static encode(message, writer?): Writer

Encodes the specified PollerGroupsInfo message. Does not implicitly temporal.api.taskqueue.v1.PollerGroupsInfo.verify|verify messages.

Parameters​

message​

$Properties

PollerGroupsInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified PollerGroupsInfo message, length delimited. Does not implicitly temporal.api.taskqueue.v1.PollerGroupsInfo.verify|verify messages.

Parameters​

message​

$Properties

PollerGroupsInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): PollerGroupsInfo

Creates a PollerGroupsInfo message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

PollerGroupsInfo

PollerGroupsInfo

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

PollerGroupsInfo

PollerGroupsInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object