Skip to main content

Class: ListClustersResponse

operatorservice.v1.ListClustersResponse

Represents a ListClustersResponse.

Implements​

Constructors​

constructor​

β€’ new ListClustersResponse(properties?)

Constructs a new ListClustersResponse.

Parameters​

NameTypeDescription
properties?IListClustersResponseProperties to set

Properties​

clusters​

β€’ clusters: IClusterMetadata[]

ListClustersResponse clusters.

Implementation of​

IListClustersResponse.clusters


nextPageToken​

β€’ nextPageToken: Uint8Array

ListClustersResponse nextPageToken.

Implementation of​

IListClustersResponse.nextPageToken

Methods​

toJSON​

β–Έ toJSON(): Object

Converts this ListClustersResponse to JSON.

Returns​

Object

JSON object


create​

β–Έ Static create(properties?): ListClustersResponse

Creates a new ListClustersResponse instance using the specified properties.

Parameters​

NameTypeDescription
properties?IListClustersResponseProperties to set

Returns​

ListClustersResponse

ListClustersResponse instance


decode​

β–Έ Static decode(reader, length?): ListClustersResponse

Decodes a ListClustersResponse message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters​

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

Returns​

ListClustersResponse

ListClustersResponse


decodeDelimited​

β–Έ Static decodeDelimited(reader): ListClustersResponse

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

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

ListClustersResponse

ListClustersResponse


encode​

β–Έ Static encode(message, writer?): Writer

Encodes the specified ListClustersResponse message. Does not implicitly temporal.api.operatorservice.v1.ListClustersResponse.verify|verify messages.

Parameters​

NameTypeDescription
messageIListClustersResponseListClustersResponse message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

β–Έ Static encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
messageIListClustersResponseListClustersResponse message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

β–Έ Static fromObject(object): ListClustersResponse

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

ListClustersResponse

ListClustersResponse


getTypeUrl​

β–Έ Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for ListClustersResponse

Parameters​

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns​

string

The default type url


toObject​

β–Έ Static toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageListClustersResponseListClustersResponse
options?IConversionOptionsConversion options

Returns​

Object

Plain object