Class: 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()
Call Signature
staticcreate(properties?):CountWorkflowExecutionsResponse&$Properties
Creates a new CountWorkflowExecutionsResponse instance using the specified properties.
Parameters
properties?
Properties to set
Returns
CountWorkflowExecutionsResponse & $Properties
CountWorkflowExecutionsResponse instance
Call Signature
staticcreate(properties?):CountWorkflowExecutionsResponse
Creates a new CountWorkflowExecutionsResponse instance using the specified properties.
Parameters
properties?
Properties to set
Returns
CountWorkflowExecutionsResponse
CountWorkflowExecutionsResponse instance
decode()
staticdecode(reader,length?):CountWorkflowExecutionsResponse&$Properties
Decodes a CountWorkflowExecutionsResponse message from the specified reader or buffer.
Parameters
reader
Uint8Array<ArrayBufferLike> | 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()
staticdecodeDelimited(reader):CountWorkflowExecutionsResponse&$Properties
Decodes a CountWorkflowExecutionsResponse message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | 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()
staticencode(message,writer?):Writer
Encodes the specified CountWorkflowExecutionsResponse message. Does not implicitly temporal.api.workflowservice.v1.CountWorkflowExecutionsResponse.verify|verify messages.
Parameters
message
CountWorkflowExecutionsResponse message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified CountWorkflowExecutionsResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.CountWorkflowExecutionsResponse.verify|verify messages.
Parameters
message
CountWorkflowExecutionsResponse message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):CountWorkflowExecutionsResponse
Creates a CountWorkflowExecutionsResponse message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
CountWorkflowExecutionsResponse
CountWorkflowExecutionsResponse
toObject()
statictoObject(message,options?):object
Creates a plain object from a CountWorkflowExecutionsResponse message. Also converts values to other types if specified.
Parameters
message
CountWorkflowExecutionsResponse
CountWorkflowExecutionsResponse
options?
IConversionOptions
Conversion options
Returns
object
Plain object