com.google.bigtable.admin.v2

Interface ClusterOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Cluster, Cluster.Builder

public interface ClusterOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
StorageType	getDefaultStorageType() (`CreationOnly`) The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
int	getDefaultStorageTypeValue() (`CreationOnly`) The type of storage used by this cluster to serve its parent instance's tables, unless explicitly overridden.
String	getLocation() (`CreationOnly`) The location where this cluster's nodes and storage reside.
com.google.protobuf.ByteString	getLocationBytes() (`CreationOnly`) The location where this cluster's nodes and storage reside.
String	getName() The unique name of the cluster.
com.google.protobuf.ByteString	getNameBytes() The unique name of the cluster.
int	getServeNodes() Required.
Cluster.State	getState() The current state of the cluster.
int	getStateValue() The current state of the cluster.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 The unique name of the cluster. Values are of the form
 `projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*`.
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 The unique name of the cluster. Values are of the form
 `projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*`.
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for name.

getLocation

String getLocation()

 (`CreationOnly`)
 The location where this cluster's nodes and storage reside. For best
 performance, clients should be located as close as possible to this
 cluster. Currently only zones are supported, so values should be of the
 form `projects/{project}/locations/{zone}`.
 

string location = 2 [(.google.api.resource_reference) = { ... }

Returns:

The location.

getLocationBytes

com.google.protobuf.ByteString getLocationBytes()

 (`CreationOnly`)
 The location where this cluster's nodes and storage reside. For best
 performance, clients should be located as close as possible to this
 cluster. Currently only zones are supported, so values should be of the
 form `projects/{project}/locations/{zone}`.
 

string location = 2 [(.google.api.resource_reference) = { ... }

Returns:

The bytes for location.

getStateValue

int getStateValue()

 The current state of the cluster.
 

.google.bigtable.admin.v2.Cluster.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The enum numeric value on the wire for state.

getState

Cluster.State getState()

 The current state of the cluster.
 

.google.bigtable.admin.v2.Cluster.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The state.

getServeNodes

int getServeNodes()

 Required. The number of nodes allocated to this cluster. More nodes enable
 higher throughput and more consistent performance.
 

int32 serve_nodes = 4 [(.google.api.field_behavior) = REQUIRED];

Returns:

The serveNodes.

getDefaultStorageTypeValue

int getDefaultStorageTypeValue()

 (`CreationOnly`)
 The type of storage used by this cluster to serve its
 parent instance's tables, unless explicitly overridden.
 

.google.bigtable.admin.v2.StorageType default_storage_type = 5;

Returns:

The enum numeric value on the wire for defaultStorageType.

getDefaultStorageType

StorageType getDefaultStorageType()

 (`CreationOnly`)
 The type of storage used by this cluster to serve its
 parent instance's tables, unless explicitly overridden.
 

.google.bigtable.admin.v2.StorageType default_storage_type = 5;

Returns:

The defaultStorageType.