Skip to main content

Class: PollerInfo

taskqueue.v1.PollerInfo

Represents a PollerInfo.

Implements

Constructors

constructor

new PollerInfo(properties?): PollerInfo

Constructs a new PollerInfo.

Parameters

NameTypeDescription
properties?IPollerInfoProperties to set

Returns

PollerInfo

Properties

identity

identity: string

PollerInfo identity.

Implementation of

IPollerInfo.identity


lastAccessTime

Optional lastAccessTime: null | ITimestamp

PollerInfo lastAccessTime.

Implementation of

IPollerInfo.lastAccessTime


ratePerSecond

ratePerSecond: number

PollerInfo ratePerSecond.

Implementation of

IPollerInfo.ratePerSecond


workerVersionCapabilities

Optional workerVersionCapabilities: null | IWorkerVersionCapabilities

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

Implementation of

IPollerInfo.workerVersionCapabilities

Methods

toJSON

toJSON(): Object

Converts this PollerInfo to JSON.

Returns

Object

JSON object


create

create(properties?): PollerInfo

Creates a new PollerInfo instance using the specified properties.

Parameters

NameTypeDescription
properties?IPollerInfoProperties to set

Returns

PollerInfo

PollerInfo instance


decode

decode(reader, length?): PollerInfo

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

PollerInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): PollerInfo

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

PollerInfo

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
messageIPollerInfoPollerInfo 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
messageIPollerInfoPollerInfo 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


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for PollerInfo

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


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