Class: ListClustersResponse
operatorservice.v1.ListClustersResponse
Represents a ListClustersResponse.
Implements
Constructors
constructor
• new ListClustersResponse(properties?): ListClustersResponse
Constructs a new ListClustersResponse.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IListClustersResponse | Properties to set |
Returns
Properties
clusters
• clusters: IClusterMetadata[]
List of all cluster information
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
▸ create(properties?): ListClustersResponse
Creates a new ListClustersResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IListClustersResponse | Properties to set |
Returns
ListClustersResponse instance
decode
▸ decode(reader, length?): ListClustersResponse
Decodes a ListClustersResponse 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
ListClustersResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): ListClustersResponse
Decodes a ListClustersResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
ListClustersResponse
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 ListClustersResponse message. Does not implicitly temporal.api.operatorservice.v1.ListClustersResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IListClustersResponse | ListClustersResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified ListClustersResponse message, length delimited. Does not implicitly temporal.api.operatorservice.v1.ListClustersResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IListClustersResponse | ListClustersResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): ListClustersResponse
Creates a ListClustersResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
ListClustersResponse
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for ListClustersResponse
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a ListClustersResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | ListClustersResponse | ListClustersResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object