public static final class Cluster.Builder extends com.google.protobuf.GeneratedMessage.Builder<Cluster.Builder> implements ClusterOrBuilder
A resizable group of nodes in a particular cloud location, capable of serving all [Tables][google.bigtable.admin.v2.Table] in the parent [Instance][google.bigtable.admin.v2.Instance].Protobuf type
google.bigtable.admin.v2.ClusteraddRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Cluster.Builder>public Cluster.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessage.Builder<Cluster.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Cluster.Builder>public Cluster getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Cluster build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Cluster buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Cluster.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Cluster.Builder>public Cluster.Builder mergeFrom(Cluster other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessage.Builder<Cluster.Builder>public Cluster.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Cluster.Builder>IOExceptionpublic Cluster.ConfigCase getConfigCase()
getConfigCase in interface ClusterOrBuilderpublic Cluster.Builder clearConfig()
public 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;getName in interface ClusterOrBuilderpublic 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;getNameBytes in interface ClusterOrBuilderpublic Cluster.Builder setName(String value)
The unique name of the cluster. Values are of the form
`projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*`.
string name = 1;value - The name to set.public Cluster.Builder clearName()
The unique name of the cluster. Values are of the form
`projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*`.
string name = 1;public Cluster.Builder setNameBytes(com.google.protobuf.ByteString value)
The unique name of the cluster. Values are of the form
`projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*`.
string name = 1;value - The bytes for name to set.public 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) = { ... }
getLocation in interface ClusterOrBuilderpublic 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) = { ... }
getLocationBytes in interface ClusterOrBuilderpublic Cluster.Builder setLocation(String value)
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) = { ... }
value - The location to set.public Cluster.Builder clearLocation()
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) = { ... }
public Cluster.Builder setLocationBytes(com.google.protobuf.ByteString value)
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) = { ... }
value - The bytes for location to set.public int getStateValue()
Output only. The current state of the cluster.
.google.bigtable.admin.v2.Cluster.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue in interface ClusterOrBuilderpublic Cluster.Builder setStateValue(int value)
Output only. The current state of the cluster.
.google.bigtable.admin.v2.Cluster.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The enum numeric value on the wire for state to set.public 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];
getState in interface ClusterOrBuilderpublic Cluster.Builder setState(Cluster.State value)
Output only. The current state of the cluster.
.google.bigtable.admin.v2.Cluster.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
value - The state to set.public Cluster.Builder clearState()
Output only. The current state of the cluster.
.google.bigtable.admin.v2.Cluster.State state = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
public int getServeNodes()
The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.
int32 serve_nodes = 4;getServeNodes in interface ClusterOrBuilderpublic Cluster.Builder setServeNodes(int value)
The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.
int32 serve_nodes = 4;value - The serveNodes to set.public Cluster.Builder clearServeNodes()
The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.
int32 serve_nodes = 4;public int getNodeScalingFactorValue()
Immutable. The node scaling factor of this cluster.
.google.bigtable.admin.v2.Cluster.NodeScalingFactor node_scaling_factor = 9 [(.google.api.field_behavior) = IMMUTABLE];
getNodeScalingFactorValue in interface ClusterOrBuilderpublic Cluster.Builder setNodeScalingFactorValue(int value)
Immutable. The node scaling factor of this cluster.
.google.bigtable.admin.v2.Cluster.NodeScalingFactor node_scaling_factor = 9 [(.google.api.field_behavior) = IMMUTABLE];
value - The enum numeric value on the wire for nodeScalingFactor to set.public Cluster.NodeScalingFactor getNodeScalingFactor()
Immutable. The node scaling factor of this cluster.
.google.bigtable.admin.v2.Cluster.NodeScalingFactor node_scaling_factor = 9 [(.google.api.field_behavior) = IMMUTABLE];
getNodeScalingFactor in interface ClusterOrBuilderpublic Cluster.Builder setNodeScalingFactor(Cluster.NodeScalingFactor value)
Immutable. The node scaling factor of this cluster.
.google.bigtable.admin.v2.Cluster.NodeScalingFactor node_scaling_factor = 9 [(.google.api.field_behavior) = IMMUTABLE];
value - The nodeScalingFactor to set.public Cluster.Builder clearNodeScalingFactor()
Immutable. The node scaling factor of this cluster.
.google.bigtable.admin.v2.Cluster.NodeScalingFactor node_scaling_factor = 9 [(.google.api.field_behavior) = IMMUTABLE];
public boolean hasClusterConfig()
Configuration for this cluster.
.google.bigtable.admin.v2.Cluster.ClusterConfig cluster_config = 7;hasClusterConfig in interface ClusterOrBuilderpublic Cluster.ClusterConfig getClusterConfig()
Configuration for this cluster.
.google.bigtable.admin.v2.Cluster.ClusterConfig cluster_config = 7;getClusterConfig in interface ClusterOrBuilderpublic Cluster.Builder setClusterConfig(Cluster.ClusterConfig value)
Configuration for this cluster.
.google.bigtable.admin.v2.Cluster.ClusterConfig cluster_config = 7;public Cluster.Builder setClusterConfig(Cluster.ClusterConfig.Builder builderForValue)
Configuration for this cluster.
.google.bigtable.admin.v2.Cluster.ClusterConfig cluster_config = 7;public Cluster.Builder mergeClusterConfig(Cluster.ClusterConfig value)
Configuration for this cluster.
.google.bigtable.admin.v2.Cluster.ClusterConfig cluster_config = 7;public Cluster.Builder clearClusterConfig()
Configuration for this cluster.
.google.bigtable.admin.v2.Cluster.ClusterConfig cluster_config = 7;public Cluster.ClusterConfig.Builder getClusterConfigBuilder()
Configuration for this cluster.
.google.bigtable.admin.v2.Cluster.ClusterConfig cluster_config = 7;public Cluster.ClusterConfigOrBuilder getClusterConfigOrBuilder()
Configuration for this cluster.
.google.bigtable.admin.v2.Cluster.ClusterConfig cluster_config = 7;getClusterConfigOrBuilder in interface ClusterOrBuilderpublic 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];
getDefaultStorageTypeValue in interface ClusterOrBuilderpublic Cluster.Builder setDefaultStorageTypeValue(int value)
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];
value - The enum numeric value on the wire for defaultStorageType to set.public 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];
getDefaultStorageType in interface ClusterOrBuilderpublic Cluster.Builder setDefaultStorageType(StorageType value)
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];
value - The defaultStorageType to set.public Cluster.Builder clearDefaultStorageType()
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];
public boolean hasEncryptionConfig()
Immutable. The encryption configuration for CMEK-protected clusters.
.google.bigtable.admin.v2.Cluster.EncryptionConfig encryption_config = 6 [(.google.api.field_behavior) = IMMUTABLE];
hasEncryptionConfig in interface ClusterOrBuilderpublic 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];
getEncryptionConfig in interface ClusterOrBuilderpublic Cluster.Builder setEncryptionConfig(Cluster.EncryptionConfig value)
Immutable. The encryption configuration for CMEK-protected clusters.
.google.bigtable.admin.v2.Cluster.EncryptionConfig encryption_config = 6 [(.google.api.field_behavior) = IMMUTABLE];
public Cluster.Builder setEncryptionConfig(Cluster.EncryptionConfig.Builder builderForValue)
Immutable. The encryption configuration for CMEK-protected clusters.
.google.bigtable.admin.v2.Cluster.EncryptionConfig encryption_config = 6 [(.google.api.field_behavior) = IMMUTABLE];
public Cluster.Builder mergeEncryptionConfig(Cluster.EncryptionConfig value)
Immutable. The encryption configuration for CMEK-protected clusters.
.google.bigtable.admin.v2.Cluster.EncryptionConfig encryption_config = 6 [(.google.api.field_behavior) = IMMUTABLE];
public Cluster.Builder clearEncryptionConfig()
Immutable. The encryption configuration for CMEK-protected clusters.
.google.bigtable.admin.v2.Cluster.EncryptionConfig encryption_config = 6 [(.google.api.field_behavior) = IMMUTABLE];
public Cluster.EncryptionConfig.Builder getEncryptionConfigBuilder()
Immutable. The encryption configuration for CMEK-protected clusters.
.google.bigtable.admin.v2.Cluster.EncryptionConfig encryption_config = 6 [(.google.api.field_behavior) = IMMUTABLE];
public 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];
getEncryptionConfigOrBuilder in interface ClusterOrBuilderCopyright © 2026 Google LLC. All rights reserved.