Class: WorkerListInfo

worker.v1.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).

Implements

• IWorkerListInfo

Constructors

constructor

• new WorkerListInfo(properties?): WorkerListInfo

Constructs a new WorkerListInfo.

Parameters

Name	Type	Description
properties?	IWorkerListInfo	Properties to set

Returns

WorkerListInfo

Properties

deploymentVersion

• Optional deploymentVersion: null | IWorkerDeploymentVersion

WorkerListInfo deploymentVersion.

Implementation of

IWorkerListInfo.deploymentVersion

---

drivers

• drivers: IStorageDriverInfo[]

Storage drivers in use by this SDK.

Implementation of

IWorkerListInfo.drivers

---

hostName

• hostName: string

Worker host identifier.

Implementation of

IWorkerListInfo.hostName

---

plugins

• plugins: IPluginInfo[]

Plugins currently in use by this SDK.

Implementation of

IWorkerListInfo.plugins

---

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).

Implementation of

IWorkerListInfo.processId

---

sdkName

• sdkName: string

WorkerListInfo sdkName.

Implementation of

IWorkerListInfo.sdkName

---

sdkVersion

• sdkVersion: string

WorkerListInfo sdkVersion.

Implementation of

IWorkerListInfo.sdkVersion

---

startTime

• Optional startTime: null | ITimestamp

Worker start time. It can be used to determine worker uptime. (current time - start time)

Implementation of

IWorkerListInfo.startTime

---

status

• status: WorkerStatus

Worker status. Defined by SDK.

Implementation of

IWorkerListInfo.status

---

taskQueue

• taskQueue: string

Task queue this worker is polling for tasks.

Implementation of

IWorkerListInfo.taskQueue

---

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}"

Implementation of

IWorkerListInfo.workerGroupingKey

---

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.

Implementation of

IWorkerListInfo.workerIdentity

---

workerInstanceKey

• workerInstanceKey: string

Worker identifier, should be unique for the namespace. It is distinct from worker identity, which is not necessarily namespace-unique.

Implementation of

IWorkerListInfo.workerInstanceKey

Methods

toJSON

▸ toJSON(): Object

Converts this WorkerListInfo to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): WorkerListInfo

Creates a new WorkerListInfo instance using the specified properties.

Parameters

Name	Type	Description
properties?	IWorkerListInfo	Properties to set

Returns

WorkerListInfo

WorkerListInfo instance

---

decode

▸ decode(reader, length?): WorkerListInfo

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

WorkerListInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): WorkerListInfo

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

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

WorkerListInfo

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for WorkerListInfo

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