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
Cluster.ClusterConfig	getClusterConfig() Configuration for this cluster.
Cluster.ClusterConfigOrBuilder	getClusterConfigOrBuilder() Configuration for this cluster.
Cluster.ConfigCase	getConfigCase()
StorageType	getDefaultStorageType() Immutable.
int	getDefaultStorageTypeValue() Immutable.
Cluster.EncryptionConfig	getEncryptionConfig() Immutable.
Cluster.EncryptionConfigOrBuilder	getEncryptionConfigOrBuilder() Immutable.
String	getLocation() Immutable.
com.google.protobuf.ByteString	getLocationBytes() Immutable.
String	getName() The unique name of the cluster.
com.google.protobuf.ByteString	getNameBytes() The unique name of the cluster.
int	getServeNodes() The number of nodes allocated to this cluster.
Cluster.State	getState() Output only.
int	getStateValue() Output only.
boolean	hasClusterConfig() Configuration for this cluster.
boolean	hasEncryptionConfig() Immutable.

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;

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;

Returns:

The bytes for name.

getLocation

String getLocation()

 Immutable. 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.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns:

The location.

getLocationBytes

com.google.protobuf.ByteString getLocationBytes()

 Immutable. 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.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns:

The bytes for location.

getStateValue

int getStateValue()

 Output only. 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()

 Output only. 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()

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

int32 serve_nodes = 4;

Returns:

The serveNodes.

hasClusterConfig

boolean hasClusterConfig()

 Configuration for this cluster.
 

.google.bigtable.admin.v2.Cluster.ClusterConfig cluster_config = 7;

Returns:

Whether the clusterConfig field is set.

getClusterConfig

Cluster.ClusterConfig getClusterConfig()

 Configuration for this cluster.
 

.google.bigtable.admin.v2.Cluster.ClusterConfig cluster_config = 7;

Returns:

The clusterConfig.

getClusterConfigOrBuilder

Cluster.ClusterConfigOrBuilder getClusterConfigOrBuilder()

 Configuration for this cluster.
 

.google.bigtable.admin.v2.Cluster.ClusterConfig cluster_config = 7;

getDefaultStorageTypeValue

int getDefaultStorageTypeValue()

 Immutable. 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 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

The enum numeric value on the wire for defaultStorageType.

getDefaultStorageType

StorageType getDefaultStorageType()

 Immutable. 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 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

The defaultStorageType.

hasEncryptionConfig

boolean hasEncryptionConfig()

 Immutable. The encryption configuration for CMEK-protected clusters.
 

.google.bigtable.admin.v2.Cluster.EncryptionConfig encryption_config = 6 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

Whether the encryptionConfig field is set.

getEncryptionConfig

Cluster.EncryptionConfig getEncryptionConfig()

 Immutable. The encryption configuration for CMEK-protected clusters.
 

.google.bigtable.admin.v2.Cluster.EncryptionConfig encryption_config = 6 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

The encryptionConfig.

getEncryptionConfigOrBuilder

Cluster.EncryptionConfigOrBuilder getEncryptionConfigOrBuilder()

 Immutable. The encryption configuration for CMEK-protected clusters.
 

.google.bigtable.admin.v2.Cluster.EncryptionConfig encryption_config = 6 [(.google.api.field_behavior) = IMMUTABLE];

getConfigCase

Cluster.ConfigCase getConfigCase()