Skip to main content

Class: PollerInfo

taskqueue.v1.PollerInfo

Represents a PollerInfo.

Properties​

deploymentOptions​

• Optional deploymentOptions: null | $Properties

Worker deployment options that SDK sent to server.


identity​

• identity: string

PollerInfo identity.


lastAccessTime​

• Optional lastAccessTime: null | $Properties

PollerInfo lastAccessTime.


ratePerSecond​

• ratePerSecond: number

PollerInfo ratePerSecond.


workerVersionCapabilities​

• Optional workerVersionCapabilities: null | $Properties

If a worker has opted into the worker versioning feature while polling, its capabilities will appear here. Deprecated. Replaced by deployment_options.

Methods​

toJSON​

▸ toJSON(): Object

Converts this PollerInfo to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): PollerInfo & $Properties

Creates a new PollerInfo instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

PollerInfo & $Properties

PollerInfo instance

▸ create(properties?): PollerInfo

Parameters​

NameType
properties?$Properties

Returns​

PollerInfo


decode​

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

Decodes a PollerInfo message from the specified reader or buffer.

Parameters​

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

Returns​

PollerInfo & $Properties

PollerInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): PollerInfo & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

PollerInfo & $Properties

PollerInfo

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 PollerInfo message. Does not implicitly temporal.api.taskqueue.v1.PollerInfo.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesPollerInfo message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesPollerInfo message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): PollerInfo

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

PollerInfo

PollerInfo


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messagePollerInfoPollerInfo
options?IConversionOptionsConversion options

Returns​

Object

Plain object