Class: CountWorkersRequest
workflowservice.v1.CountWorkersRequest
Represents a CountWorkersRequest.
Properties
includeSystemWorkers
• includeSystemWorkers: boolean
When true, the count 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
CountWorkersRequest namespace.
query
• query: string
Query to filter workers before counting. Supported filter fields are the same as in ListWorkersRequest.
Methods
toJSON
▸ toJSON(): Object
Converts this CountWorkersRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): CountWorkersRequest & $Properties
Creates a new CountWorkersRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
CountWorkersRequest & $Properties
CountWorkersRequest instance
▸ create(properties?): CountWorkersRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): CountWorkersRequest & $Properties
Decodes a CountWorkersRequest 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
CountWorkersRequest & $Properties
CountWorkersRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): CountWorkersRequest & $Properties
Decodes a CountWorkersRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
CountWorkersRequest & $Properties
CountWorkersRequest
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 CountWorkersRequest message. Does not implicitly temporal.api.workflowservice.v1.CountWorkersRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CountWorkersRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified CountWorkersRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.CountWorkersRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CountWorkersRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): CountWorkersRequest
Creates a CountWorkersRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
CountWorkersRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a CountWorkersRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | CountWorkersRequest | CountWorkersRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object