Skip to main content

Class: ListClustersRequest

operatorservice.v1.ListClustersRequest

Represents a ListClustersRequest.

Properties​

nextPageToken​

• nextPageToken: Uint8Array

ListClustersRequest nextPageToken.


pageSize​

• pageSize: number

ListClustersRequest pageSize.

Methods​

toJSON​

▸ toJSON(): Object

Converts this ListClustersRequest to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): ListClustersRequest & $Properties

Creates a new ListClustersRequest instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

ListClustersRequest & $Properties

ListClustersRequest instance

▸ create(properties?): ListClustersRequest

Parameters​

NameType
properties?$Properties

Returns​

ListClustersRequest


decode​

▸ decode(reader, length?): ListClustersRequest & $Properties

Decodes a ListClustersRequest message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

ListClustersRequest & $Properties

ListClustersRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): ListClustersRequest & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

ListClustersRequest & $Properties

ListClustersRequest

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 ListClustersRequest message. Does not implicitly temporal.api.operatorservice.v1.ListClustersRequest.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesListClustersRequest message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesListClustersRequest message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): ListClustersRequest

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

ListClustersRequest

ListClustersRequest


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageListClustersRequestListClustersRequest
options?IConversionOptionsConversion options

Returns​

Object

Plain object