Class Cluster (2.16.0)

public final class Cluster extends GeneratedMessageV3 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 Fields

CLUSTER_CONFIG_FIELD_NUMBER

public static final int CLUSTER_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

DEFAULT_STORAGE_TYPE_FIELD_NUMBER

public static final int DEFAULT_STORAGE_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

ENCRYPTION_CONFIG_FIELD_NUMBER

public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

SERVE_NODES_FIELD_NUMBER

public static final int SERVE_NODES_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Cluster getDefaultInstance()
Returns
TypeDescription
Cluster

getDescriptor()

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

newBuilder()

public static Cluster.Builder newBuilder()
Returns
TypeDescription
Cluster.Builder

newBuilder(Cluster prototype)

public static Cluster.Builder newBuilder(Cluster prototype)
Parameter
NameDescription
prototypeCluster
Returns
TypeDescription
Cluster.Builder

parseDelimitedFrom(InputStream input)

public static Cluster parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Cluster
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Cluster parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Cluster
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Cluster parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Cluster
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Cluster parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Cluster
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Cluster parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Cluster
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Cluster parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Cluster
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Cluster parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Cluster
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Cluster parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Cluster
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Cluster parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Cluster
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Cluster parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Cluster
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Cluster parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Cluster
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Cluster parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Cluster
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Cluster> parser()
Returns
TypeDescription
Parser<Cluster>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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.

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.

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.

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.

getParserForType()

public Parser<Cluster> getParserForType()
Returns
TypeDescription
Parser<Cluster>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Cluster.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Cluster.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException