Class Cluster.Builder (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 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Cluster.Builder

Implements

ClusterOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Cluster.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
Cluster.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Cluster build()

Returns

Type	Description
Cluster

buildPartial()

public Cluster buildPartial()

Returns

Type	Description
Cluster

clear()

public Cluster.Builder clear()

Returns

Type	Description
Cluster.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDefaultStorageType()

public Cluster.Builder clearDefaultStorageType()

(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
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

Type	Description
Cluster.Builder

clearField(Descriptors.FieldDescriptor field)

public Cluster.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
Cluster.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearLocation()

public Cluster.Builder clearLocation()

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

Returns

Type	Description
Cluster.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Cluster.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
Cluster.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearServeNodes()

public Cluster.Builder clearServeNodes()

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
Cluster.Builder	This builder for chaining.

clearState()

public Cluster.Builder clearState()

The current state of the cluster.

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

Returns

Type	Description
Cluster.Builder	This builder for chaining.

clone()

public Cluster.Builder clone()

Returns

Type	Description
Cluster.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Cluster getDefaultInstanceForType()

Returns

Type	Description
Cluster

getDefaultStorageType()

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

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

Type	Description
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

Type	Description
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

Type	Description
Cluster.EncryptionConfigOrBuilder

getLocation()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

Name	Description
value	Cluster.EncryptionConfig

Returns

Type	Description
Cluster.Builder

mergeFrom(Cluster other)

public Cluster.Builder mergeFrom(Cluster other)

Parameter

Name	Description
other	Cluster

Returns

Type	Description
Cluster.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Cluster.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
Cluster.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public Cluster.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
Cluster.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Cluster.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
Cluster.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setDefaultStorageType(StorageType value)

public Cluster.Builder setDefaultStorageType(StorageType value)

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

Parameter

Name	Description
value	StorageType The defaultStorageType to set.

Returns

Type	Description
Cluster.Builder	This builder for chaining.

setDefaultStorageTypeValue(int value)

public Cluster.Builder setDefaultStorageTypeValue(int value)

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

Parameter

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

Returns

Type	Description
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

Name	Description
value	Cluster.EncryptionConfig

Returns

Type	Description
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

Name	Description
builderForValue	Cluster.EncryptionConfig.Builder

Returns

Type	Description
Cluster.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Cluster.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
Cluster.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setLocation(String value)

public Cluster.Builder setLocation(String value)

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

Parameter

Name	Description
value	String The location to set.

Returns

Type	Description
Cluster.Builder	This builder for chaining.

setLocationBytes(ByteString value)

public Cluster.Builder setLocationBytes(ByteString value)

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

Parameter

Name	Description
value	ByteString The bytes for location to set.

Returns

Type	Description
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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	String The name to set.

Returns

Type	Description
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 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	ByteString The bytes for name to set.

Returns

Type	Description
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

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
Cluster.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setServeNodes(int value)

public Cluster.Builder setServeNodes(int value)

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

Parameter

Name	Description
value	int The serveNodes to set.

Returns

Type	Description
Cluster.Builder	This builder for chaining.

setState(Cluster.State value)

public Cluster.Builder setState(Cluster.State value)

The current state of the cluster.

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

Parameter

Name	Description
value	Cluster.State The state to set.

Returns

Type	Description
Cluster.Builder	This builder for chaining.

setStateValue(int value)

public Cluster.Builder setStateValue(int value)

The current state of the cluster.

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

Parameter

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

Returns

Type	Description
Cluster.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Cluster.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
Cluster.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)