Class: ListWorkersRequest
workflowservice.v1.ListWorkersRequest
Represents a ListWorkersRequest.
Properties
includeSystemWorkers
• includeSystemWorkers: boolean
When true, the response will include system workers that are created implicitly by the server and not by the user. By default, system workers are excluded.
namespace
• namespace: string
ListWorkersRequest namespace.
nextPageToken
• nextPageToken: Uint8Array
ListWorkersRequest nextPageToken.
pageSize
• pageSize: number
ListWorkersRequest pageSize.
query
• query: string
query in ListWorkers is used to filter workers based on worker attributes.
Supported attributes:
- WorkerInstanceKey
- WorkerIdentity
- HostName
- TaskQueue
- DeploymentName
- BuildId
- SdkName
- SdkVersion
- StartTime
- Status
Methods
toJSON
▸ toJSON(): Object
Converts this ListWorkersRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ListWorkersRequest & $Properties
Creates a new ListWorkersRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
ListWorkersRequest & $Properties
ListWorkersRequest instance
▸ create(properties?): ListWorkersRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): ListWorkersRequest & $Properties
Decodes a ListWorkersRequest 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
ListWorkersRequest & $Properties
ListWorkersRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ListWorkersRequest & $Properties
Decodes a ListWorkersRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ListWorkersRequest & $Properties
ListWorkersRequest
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 ListWorkersRequest message. Does not implicitly temporal.api.workflowservice.v1.ListWorkersRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ListWorkersRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ListWorkersRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.ListWorkersRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | ListWorkersRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ListWorkersRequest
Creates a ListWorkersRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ListWorkersRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a ListWorkersRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ListWorkersRequest | ListWorkersRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object