Class: WorkerListInfo
Limited worker information returned in the list response. When adding fields here, ensure that it is also added to WorkerInfo (as it carries the full worker information).
Properties
deploymentVersion
• Optional deploymentVersion: null | $Properties
WorkerListInfo deploymentVersion.
drivers
• drivers: $Properties[]
Storage drivers in use by this SDK.
hostName
• hostName: string
Worker host identifier.
plugins
• plugins: $Properties[]
Plugins currently in use by this SDK.
processId
• processId: string
Worker process identifier. This id only needs to be unique within one host (so using e.g. a unix pid would be appropriate).
sdkName
• sdkName: string
WorkerListInfo sdkName.
sdkVersion
• sdkVersion: string
WorkerListInfo 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.
workerGroupingKey
• workerGroupingKey: string
Worker grouping identifier. A key to group workers that share the same client+namespace+process. This will be used to build the worker command nexus task queue name: "temporal-sys/worker-commands/{worker_grouping_key}"
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.
Methods
toJSON
▸ toJSON(): Object
Converts this WorkerListInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): WorkerListInfo & $Properties
Creates a new WorkerListInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
WorkerListInfo instance
▸ create(properties?): WorkerListInfo
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): WorkerListInfo & $Properties
Decodes a WorkerListInfo 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
WorkerListInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): WorkerListInfo & $Properties
Decodes a WorkerListInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
WorkerListInfo
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 WorkerListInfo message. Does not implicitly temporal.api.worker.v1.WorkerListInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkerListInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified WorkerListInfo message, length delimited. Does not implicitly temporal.api.worker.v1.WorkerListInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | WorkerListInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): WorkerListInfo
Creates a WorkerListInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
WorkerListInfo
toObject
▸ toObject(message, options?): Object
Creates a plain object from a WorkerListInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | WorkerListInfo | WorkerListInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object