Class: ListWorkersResponse
workflowservice.v1.ListWorkersResponse
Represents a ListWorkersResponse.
Properties
nextPageToken
• nextPageToken: Uint8Array
Next page token
workers
• workers: $Properties[]
Limited worker information.
workersInfo
• workersInfo: $Properties[]
Deprecated: Use workers instead. This field returns full WorkerInfo which includes expensive runtime metrics. We will stop populating this field in the future.
Methods
toJSON
▸ toJSON(): Object
Converts this ListWorkersResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ListWorkersResponse & $Shape
Creates a new ListWorkersResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
ListWorkersResponse instance
▸ create(properties?): ListWorkersResponse
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): ListWorkersResponse & $Shape
Decodes a ListWorkersResponse 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
ListWorkersResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ListWorkersResponse & $Shape
Decodes a ListWorkersResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ListWorkersResponse
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 ListWorkersResponse message. Does not implicitly temporal.api.workflowservice.v1.ListWorkersResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ListWorkersResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ListWorkersResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.ListWorkersResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ListWorkersResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ListWorkersResponse
Creates a ListWorkersResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ListWorkersResponse
toObject
▸ toObject(message, options?): Object
Creates a plain object from a ListWorkersResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ListWorkersResponse | ListWorkersResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object