Class: WorkerHeartbeat
Worker info message, contains information about the worker and its current state. All information is provided by the worker itself. (-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: Removing those words make names less clear. --)
Properties
activityPollerInfo
• Optional activityPollerInfo: null | $Properties
WorkerHeartbeat activityPollerInfo.
activityTaskSlotsInfo
• Optional activityTaskSlotsInfo: null | $Properties
WorkerHeartbeat activityTaskSlotsInfo.
currentStickyCacheSize
• currentStickyCacheSize: number
Current cache size, expressed in number of Workflow Executions.
deploymentVersion
• Optional deploymentVersion: null | $Properties
WorkerHeartbeat deploymentVersion.
drivers
• drivers: $Properties[]
Storage drivers in use by this SDK.
elapsedSinceLastHeartbeat
• Optional elapsedSinceLastHeartbeat: null | $Properties
Elapsed time since the last heartbeat from the worker.
environment
• Optional environment: null | $Properties
Information about the environment this SDK is running in.
heartbeatTime
• Optional heartbeatTime: null | $Properties
Timestamp of this heartbeat, coming from the worker. Worker should set it to "now". Note that this timestamp comes directly from the worker and is subject to workers' clock skew.
hostInfo
• Optional hostInfo: null | $Properties
Worker host information.
localActivitySlotsInfo
• Optional localActivitySlotsInfo: null | $Properties
WorkerHeartbeat localActivitySlotsInfo.
nexusPollerInfo
• Optional nexusPollerInfo: null | $Properties
WorkerHeartbeat nexusPollerInfo.
nexusTaskSlotsInfo
• Optional nexusTaskSlotsInfo: null | $Properties
WorkerHeartbeat nexusTaskSlotsInfo.
plugins
• plugins: $Properties[]
Plugins currently in use by this SDK.
sdkName
• sdkName: string
WorkerHeartbeat sdkName.
sdkVersion
• sdkVersion: string
WorkerHeartbeat sdkVersion.
startTime
• Optional startTime: null | $Properties
Worker start time. It can be used to determine worker uptime. (current time - start time)
status
• status: WorkerStatus
Worker status. Defined by SDK.
taskQueue
• taskQueue: string
Task queue this worker is polling for tasks.
totalStickyCacheHit
• totalStickyCacheHit: number
A Workflow Task found a cached Workflow Execution to run against.
totalStickyCacheMiss
• totalStickyCacheMiss: number
A Workflow Task did not find a cached Workflow execution to run against.
workerIdentity
• workerIdentity: string
Worker identity, set by the client, may not be unique. Usually host_name+(user group name)+process_id, but can be overwritten by the user.
workerInstanceKey
• workerInstanceKey: string
Worker identifier, should be unique for the namespace. It is distinct from worker identity, which is not necessarily namespace-unique.
workflowPollerInfo
• Optional workflowPollerInfo: null | $Properties
WorkerHeartbeat workflowPollerInfo.
workflowStickyPollerInfo
• Optional workflowStickyPollerInfo: null | $Properties
WorkerHeartbeat workflowStickyPollerInfo.
workflowTaskSlotsInfo
• Optional workflowTaskSlotsInfo: null | $Properties
WorkerHeartbeat workflowTaskSlotsInfo.
Methods
toJSON
▸ toJSON(): Object
Converts this WorkerHeartbeat to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkerHeartbeat & $Shape
Creates a new WorkerHeartbeat instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
WorkerHeartbeat instance
▸ create(properties?): WorkerHeartbeat
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): WorkerHeartbeat & $Shape
Decodes a WorkerHeartbeat 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
WorkerHeartbeat
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkerHeartbeat & $Shape
Decodes a WorkerHeartbeat message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkerHeartbeat
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 WorkerHeartbeat message. Does not implicitly temporal.api.worker.v1.WorkerHeartbeat.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkerHeartbeat message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkerHeartbeat message, length delimited. Does not implicitly temporal.api.worker.v1.WorkerHeartbeat.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkerHeartbeat message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkerHeartbeat
Creates a WorkerHeartbeat message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkerHeartbeat
toObject
▸ toObject(message, options?): Object
Creates a plain object from a WorkerHeartbeat message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkerHeartbeat | WorkerHeartbeat |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object