Class: ListWorkersRequest
workflowservice.v1.ListWorkersRequest
Represents a ListWorkersRequest.
Implements
Constructors
constructor
• new ListWorkersRequest(properties?): ListWorkersRequest
Constructs a new ListWorkersRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IListWorkersRequest | Properties to set |
Returns
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.
Implementation of
IListWorkersRequest.includeSystemWorkers
namespace
• namespace: string
ListWorkersRequest namespace.
Implementation of
nextPageToken
• nextPageToken: Uint8Array
ListWorkersRequest nextPageToken.
Implementation of
IListWorkersRequest.nextPageToken
pageSize
• pageSize: number
ListWorkersRequest pageSize.
Implementation of
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
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this ListWorkersRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): ListWorkersRequest
Creates a new ListWorkersRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IListWorkersRequest | Properties to set |
Returns
ListWorkersRequest instance
decode
▸ decode(reader, length?): ListWorkersRequest
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
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ListWorkersRequest
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
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 | IListWorkersRequest | 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 | IListWorkersRequest | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ListWorkersRequest
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 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