Interface ClusterOrBuilder (2.3.1)

Version 2.3.1

• 2.49.0 (latest)
• 2.46.0
• 2.45.1
• 2.44.1
• 2.43.0
• 2.42.0
• 2.40.0
• 2.39.5
• 2.37.0
• 2.35.1
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.1
• 2.28.0

public interface ClusterOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDefaultStorageType()

public abstract 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

Type	Description
StorageType	The defaultStorageType.

getDefaultStorageTypeValue()

public abstract 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

Type	Description
int	The enum numeric value on the wire for defaultStorageType.

getEncryptionConfig()

public abstract 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

Type	Description
Cluster.EncryptionConfig	The encryptionConfig.

getEncryptionConfigOrBuilder()

public abstract 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];

Returns

Type	Description
Cluster.EncryptionConfigOrBuilder

getLocation()

public abstract 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

Type	Description
String	The location.

getLocationBytes()

public abstract 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

Type	Description
ByteString	The bytes for location.

getName()

public abstract String getName()

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

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

Returns

Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

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

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

Returns

Type	Description
ByteString	The bytes for name.

getServeNodes()

public abstract 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

Type	Description
int	The serveNodes.

getState()

public abstract Cluster.State getState()

The current state of the cluster.

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

Returns

Type	Description
Cluster.State	The state.

getStateValue()

public abstract int getStateValue()

The current state of the cluster.

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

Returns

Type	Description
int	The enum numeric value on the wire for state.

hasEncryptionConfig()

public abstract 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

Type	Description
boolean	Whether the encryptionConfig field is set.