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
Static Fields
CLUSTER_CONFIG_FIELD_NUMBER
public static final int CLUSTER_CONFIG_FIELD_NUMBER
Field Value
DEFAULT_STORAGE_TYPE_FIELD_NUMBER
public static final int DEFAULT_STORAGE_TYPE_FIELD_NUMBER
Field Value
ENCRYPTION_CONFIG_FIELD_NUMBER
public static final int ENCRYPTION_CONFIG_FIELD_NUMBER
Field Value
LOCATION_FIELD_NUMBER
public static final int LOCATION_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
SERVE_NODES_FIELD_NUMBER
public static final int SERVE_NODES_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Cluster getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Cluster.Builder newBuilder()
Returns
newBuilder(Cluster prototype)
public static Cluster.Builder newBuilder(Cluster prototype)
Parameter
Returns
public static Cluster parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Cluster parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Cluster parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Cluster parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Cluster parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Cluster parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Cluster parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Cluster parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Cluster parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Cluster parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Cluster parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Cluster parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Cluster> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getClusterConfig()
public Cluster.ClusterConfig getClusterConfig()
Configuration for this cluster.
.google.bigtable.admin.v2.Cluster.ClusterConfig cluster_config = 7;
Returns
getClusterConfigOrBuilder()
public Cluster.ClusterConfigOrBuilder getClusterConfigOrBuilder()
Configuration for this cluster.
.google.bigtable.admin.v2.Cluster.ClusterConfig cluster_config = 7;
Returns
getConfigCase()
public Cluster.ConfigCase getConfigCase()
Returns
getDefaultInstanceForType()
public Cluster getDefaultInstanceForType()
Returns
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
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
Type | Description |
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
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
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
Type | Description |
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
getName()
The unique name of the cluster. Values are of the form
projects/{project}/instances/{instance}/clusters/a-z*
.
string name = 1;
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;
Returns
getParserForType()
public Parser<Cluster> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
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
Type | Description |
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
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
Type | Description |
int | The enum numeric value on the wire for state.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasClusterConfig()
public boolean hasClusterConfig()
Configuration for this cluster.
.google.bigtable.admin.v2.Cluster.ClusterConfig cluster_config = 7;
Returns
Type | Description |
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
Type | Description |
boolean | Whether the encryptionConfig field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Cluster.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Cluster.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Cluster.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions