Class: CountWorkflowExecutionsResponse
workflowservice.v1.CountWorkflowExecutionsResponse
Represents a CountWorkflowExecutionsResponse.
Properties
count
• count: Long
If query is not grouping by any field, the count is an approximate number
of workflows that matches the query.
If query is grouping by a field, the count is simply the sum of the counts
of the groups returned in the response. This number can be smaller than the
total number of workflows matching the query.
groups
• groups: $Properties[]
groups contains the groups if the request is grouping by a field.
The list might not be complete, and the counts of each group is approximate.
Methods
toJSON
▸ toJSON(): Object
Converts this CountWorkflowExecutionsResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): CountWorkflowExecutionsResponse & $Properties
Creates a new CountWorkflowExecutionsResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
CountWorkflowExecutionsResponse & $Properties
CountWorkflowExecutionsResponse instance
▸ create(properties?): CountWorkflowExecutionsResponse
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
CountWorkflowExecutionsResponse
decode
▸ decode(reader, length?): CountWorkflowExecutionsResponse & $Properties
Decodes a CountWorkflowExecutionsResponse 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
CountWorkflowExecutionsResponse & $Properties
CountWorkflowExecutionsResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): CountWorkflowExecutionsResponse & $Properties
Decodes a CountWorkflowExecutionsResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
CountWorkflowExecutionsResponse & $Properties
CountWorkflowExecutionsResponse
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 CountWorkflowExecutionsResponse message. Does not implicitly temporal.api.workflowservice.v1.CountWorkflowExecutionsResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CountWorkflowExecutionsResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified CountWorkflowExecutionsResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.CountWorkflowExecutionsResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CountWorkflowExecutionsResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): CountWorkflowExecutionsResponse
Creates a CountWorkflowExecutionsResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
CountWorkflowExecutionsResponse
CountWorkflowExecutionsResponse
toObject
▸ toObject(message, options?): Object
Creates a plain object from a CountWorkflowExecutionsResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | CountWorkflowExecutionsResponse | CountWorkflowExecutionsResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object