Class: CountActivityExecutionsResponse
workflowservice.v1.CountActivityExecutionsResponse
Represents a CountActivityExecutionsResponse.
Implements
Constructors
constructor
• new CountActivityExecutionsResponse(properties?): CountActivityExecutionsResponse
Constructs a new CountActivityExecutionsResponse.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ICountActivityExecutionsResponse | Properties to set |
Returns
CountActivityExecutionsResponse
Properties
count
• count: Long
If query is not grouping by any field, the count is an approximate number
of activities that match 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 activities matching the query.
Implementation of
ICountActivityExecutionsResponse.count
groups
• groups: IAggregationGroup[]
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.
Implementation of
ICountActivityExecutionsResponse.groups
Methods
toJSON
▸ toJSON(): Object
Converts this CountActivityExecutionsResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): CountActivityExecutionsResponse
Creates a new CountActivityExecutionsResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ICountActivityExecutionsResponse | Properties to set |
Returns
CountActivityExecutionsResponse
CountActivityExecutionsResponse instance
decode
▸ decode(reader, length?): CountActivityExecutionsResponse
Decodes a CountActivityExecutionsResponse 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
CountActivityExecutionsResponse
CountActivityExecutionsResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): CountActivityExecutionsResponse
Decodes a CountActivityExecutionsResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
CountActivityExecutionsResponse
CountActivityExecutionsResponse
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 CountActivityExecutionsResponse message. Does not implicitly temporal.api.workflowservice.v1.CountActivityExecutionsResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ICountActivityExecutionsResponse | CountActivityExecutionsResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified CountActivityExecutionsResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.CountActivityExecutionsResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ICountActivityExecutionsResponse | CountActivityExecutionsResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): CountActivityExecutionsResponse
Creates a CountActivityExecutionsResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
CountActivityExecutionsResponse
CountActivityExecutionsResponse
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for CountActivityExecutionsResponse
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 CountActivityExecutionsResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | CountActivityExecutionsResponse | CountActivityExecutionsResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object