Class Cluster.Builder (2.17.1)

public static final class Cluster.Builder extends GeneratedMessageV3.Builder<Cluster.Builder> implements ClusterOrBuilder

A resizable group of nodes in a particular cloud location, capable of serving all Tables in the parent Instance.

Protobuf type google.bigtable.admin.v2.Cluster

Implements

ClusterOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Cluster.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Cluster.Builder
Overrides

build()

public Cluster build()
Returns
TypeDescription
Cluster

buildPartial()

public Cluster buildPartial()
Returns
TypeDescription
Cluster

clear()

public Cluster.Builder clear()
Returns
TypeDescription
Cluster.Builder
Overrides

clearClusterConfig()

public Cluster.Builder clearClusterConfig()

Configuration for this cluster.

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

Returns
TypeDescription
Cluster.Builder

clearConfig()

public Cluster.Builder clearConfig()
Returns
TypeDescription
Cluster.Builder

clearDefaultStorageType()

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

Returns
TypeDescription
Cluster.Builder

This builder for chaining.

clearEncryptionConfig()

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

Returns
TypeDescription
Cluster.Builder

clearField(Descriptors.FieldDescriptor field)

public Cluster.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Cluster.Builder
Overrides

clearLocation()

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) = { ... }

Returns
TypeDescription
Cluster.Builder

This builder for chaining.

clearName()

public Cluster.Builder clearName()

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

string name = 1;

Returns
TypeDescription
Cluster.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Cluster.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Cluster.Builder
Overrides

clearServeNodes()

public Cluster.Builder clearServeNodes()

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

int32 serve_nodes = 4;

Returns
TypeDescription
Cluster.Builder

This builder for chaining.

clearState()

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

Returns
TypeDescription
Cluster.Builder

This builder for chaining.

clone()

public Cluster.Builder clone()
Returns
TypeDescription
Cluster.Builder
Overrides

getClusterConfig()

public Cluster.ClusterConfig getClusterConfig()

Configuration for this cluster.

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

Returns
TypeDescription
Cluster.ClusterConfig

The clusterConfig.

getClusterConfigBuilder()

public Cluster.ClusterConfig.Builder getClusterConfigBuilder()

Configuration for this cluster.

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

Returns
TypeDescription
Cluster.ClusterConfig.Builder

getClusterConfigOrBuilder()

public Cluster.ClusterConfigOrBuilder getClusterConfigOrBuilder()

Configuration for this cluster.

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

Returns
TypeDescription
Cluster.ClusterConfigOrBuilder

getConfigCase()

public Cluster.ConfigCase getConfigCase()
Returns
TypeDescription
Cluster.ConfigCase

getDefaultInstanceForType()

public Cluster getDefaultInstanceForType()
Returns
TypeDescription
Cluster

getDefaultStorageType()

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

Returns
TypeDescription
StorageType

The defaultStorageType.

getDefaultStorageTypeValue()

public 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
TypeDescription
int

The enum numeric value on the wire for defaultStorageType.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEncryptionConfig()

public 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
TypeDescription
Cluster.EncryptionConfig

The encryptionConfig.

getEncryptionConfigBuilder()

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

Returns
TypeDescription
Cluster.EncryptionConfig.Builder

getEncryptionConfigOrBuilder()

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

Returns
TypeDescription
Cluster.EncryptionConfigOrBuilder

getLocation()

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) = { ... }

Returns
TypeDescription
String

The location.

getLocationBytes()

public 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
TypeDescription
ByteString

The bytes for location.

getName()

public String getName()

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

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getServeNodes()

public int getServeNodes()

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

int32 serve_nodes = 4;

Returns
TypeDescription
int

The serveNodes.

getState()

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

Returns
TypeDescription
Cluster.State

The state.

getStateValue()

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

Returns
TypeDescription
int

The enum numeric value on the wire for state.

hasClusterConfig()

public boolean hasClusterConfig()

Configuration for this cluster.

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

Returns
TypeDescription
boolean

Whether the clusterConfig field is set.

hasEncryptionConfig()

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

Returns
TypeDescription
boolean

Whether the encryptionConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeClusterConfig(Cluster.ClusterConfig value)

public Cluster.Builder mergeClusterConfig(Cluster.ClusterConfig value)

Configuration for this cluster.

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

Parameter
NameDescription
valueCluster.ClusterConfig
Returns
TypeDescription
Cluster.Builder

mergeEncryptionConfig(Cluster.EncryptionConfig value)

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

Parameter
NameDescription
valueCluster.EncryptionConfig
Returns
TypeDescription
Cluster.Builder

mergeFrom(Cluster other)

public Cluster.Builder mergeFrom(Cluster other)
Parameter
NameDescription
otherCluster
Returns
TypeDescription
Cluster.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Cluster.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Cluster.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Cluster.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Cluster.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Cluster.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Cluster.Builder
Overrides

setClusterConfig(Cluster.ClusterConfig value)

public Cluster.Builder setClusterConfig(Cluster.ClusterConfig value)

Configuration for this cluster.

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

Parameter
NameDescription
valueCluster.ClusterConfig
Returns
TypeDescription
Cluster.Builder

setClusterConfig(Cluster.ClusterConfig.Builder builderForValue)

public Cluster.Builder setClusterConfig(Cluster.ClusterConfig.Builder builderForValue)

Configuration for this cluster.

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

Parameter
NameDescription
builderForValueCluster.ClusterConfig.Builder
Returns
TypeDescription
Cluster.Builder

setDefaultStorageType(StorageType value)

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

Parameter
NameDescription
valueStorageType

The defaultStorageType to set.

Returns
TypeDescription
Cluster.Builder

This builder for chaining.

setDefaultStorageTypeValue(int value)

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for defaultStorageType to set.

Returns
TypeDescription
Cluster.Builder

This builder for chaining.

setEncryptionConfig(Cluster.EncryptionConfig value)

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

Parameter
NameDescription
valueCluster.EncryptionConfig
Returns
TypeDescription
Cluster.Builder

setEncryptionConfig(Cluster.EncryptionConfig.Builder builderForValue)

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

Parameter
NameDescription
builderForValueCluster.EncryptionConfig.Builder
Returns
TypeDescription
Cluster.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Cluster.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Cluster.Builder
Overrides

setLocation(String value)

public 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) = { ... }

Parameter
NameDescription
valueString

The location to set.

Returns
TypeDescription
Cluster.Builder

This builder for chaining.

setLocationBytes(ByteString value)

public Cluster.Builder setLocationBytes(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) = { ... }

Parameter
NameDescription
valueByteString

The bytes for location to set.

Returns
TypeDescription
Cluster.Builder

This builder for chaining.

setName(String value)

public Cluster.Builder setName(String value)

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

string name = 1;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Cluster.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Cluster.Builder setNameBytes(ByteString value)

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

string name = 1;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Cluster.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Cluster.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Cluster.Builder
Overrides

setServeNodes(int value)

public Cluster.Builder setServeNodes(int value)

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

int32 serve_nodes = 4;

Parameter
NameDescription
valueint

The serveNodes to set.

Returns
TypeDescription
Cluster.Builder

This builder for chaining.

setState(Cluster.State value)

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

Parameter
NameDescription
valueCluster.State

The state to set.

Returns
TypeDescription
Cluster.Builder

This builder for chaining.

setStateValue(int value)

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
Cluster.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Cluster.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Cluster.Builder
Overrides