Class: PollerInfo
Represents a PollerInfo.
Implements
Constructors
constructor
• new PollerInfo(properties?): PollerInfo
Constructs a new PollerInfo.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPollerInfo | Properties to set |
Returns
Properties
deploymentOptions
• Optional deploymentOptions: null | IWorkerDeploymentOptions
Worker deployment options that SDK sent to server.
Implementation of
identity
• identity: string
PollerInfo identity.
Implementation of
lastAccessTime
• Optional lastAccessTime: null | ITimestamp
PollerInfo lastAccessTime.
Implementation of
ratePerSecond
• ratePerSecond: number
PollerInfo ratePerSecond.
Implementation of
workerVersionCapabilities
• Optional workerVersionCapabilities: null | IWorkerVersionCapabilities
If a worker has opted into the worker versioning feature while polling, its capabilities will appear here. Deprecated. Replaced by deployment_options.
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
| Name | Type | Description |
|---|---|---|
properties? | IPollerInfo | Properties to set |
Returns
PollerInfo instance
decode
▸ decode(reader, length?): PollerInfo
Decodes a PollerInfo 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
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
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
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
| Name | Type | Description |
|---|---|---|
message | IPollerInfo | PollerInfo message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
message | IPollerInfo | PollerInfo message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
PollerInfo
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for PollerInfo
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 PollerInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | PollerInfo | PollerInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object