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