Class: CountSchedulesResponse
workflowservice.v1.CountSchedulesResponse
Represents a CountSchedulesResponse.
Properties
count
• count: Long
If query is not grouping by any field, the count is an approximate number
of schedules 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 schedules matching the query.
groups
• groups: $Properties[]
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 CountSchedulesResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): CountSchedulesResponse & $Properties
Creates a new CountSchedulesResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
CountSchedulesResponse & $Properties
CountSchedulesResponse instance
▸ create(properties?): CountSchedulesResponse
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): CountSchedulesResponse & $Properties
Decodes a CountSchedulesResponse 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
CountSchedulesResponse & $Properties
CountSchedulesResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): CountSchedulesResponse & $Properties
Decodes a CountSchedulesResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
CountSchedulesResponse & $Properties
CountSchedulesResponse
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 CountSchedulesResponse message. Does not implicitly temporal.api.workflowservice.v1.CountSchedulesResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CountSchedulesResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified CountSchedulesResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.CountSchedulesResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CountSchedulesResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): CountSchedulesResponse
Creates a CountSchedulesResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
CountSchedulesResponse
toObject
▸ toObject(message, options?): Object
Creates a plain object from a CountSchedulesResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | CountSchedulesResponse | CountSchedulesResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object