Skip to main content

Class: 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()​

Call Signature​

static create(properties?): CountSchedulesResponse & $Properties

Creates a new CountSchedulesResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CountSchedulesResponse & $Properties

CountSchedulesResponse instance

Call Signature​

static create(properties?): CountSchedulesResponse

Creates a new CountSchedulesResponse instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CountSchedulesResponse

CountSchedulesResponse instance


decode()​

static decode(reader, length?): CountSchedulesResponse & $Properties

Decodes a CountSchedulesResponse 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​

CountSchedulesResponse & $Properties

CountSchedulesResponse

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing


decodeDelimited()​

static decodeDelimited(reader): CountSchedulesResponse & $Properties

Decodes a CountSchedulesResponse message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static encode(message, writer?): Writer

Encodes the specified CountSchedulesResponse message. Does not implicitly temporal.api.workflowservice.v1.CountSchedulesResponse.verify|verify messages.

Parameters​

message​

$Properties

CountSchedulesResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified CountSchedulesResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.CountSchedulesResponse.verify|verify messages.

Parameters​

message​

$Properties

CountSchedulesResponse message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


fromObject()​

static fromObject(object): CountSchedulesResponse

Creates a CountSchedulesResponse message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

CountSchedulesResponse

CountSchedulesResponse


toObject()​

static toObject(message, options?): object

Creates a plain object from a CountSchedulesResponse message. Also converts values to other types if specified.

Parameters​

message​

CountSchedulesResponse

CountSchedulesResponse

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object