Package com.google.bigtable.admin.v2

Class Cluster

  • All Implemented Interfaces:
    ClusterOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Cluster
extends com.google.protobuf.GeneratedMessageV3
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.Cluster
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getName

        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;
        Specified by:
        getName in interface ClusterOrBuilder
        Returns:
        The name.

      • getNameBytes

        public 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;
        Specified by:
        getNameBytes in interface ClusterOrBuilder
        Returns:
        The bytes for name.

      • 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) = { ... }
        Specified by:
        getLocation in interface ClusterOrBuilder
        Returns:
        The location.

      • getLocationBytes

        public 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) = { ... }
        Specified by:
        getLocationBytes in interface ClusterOrBuilder
        Returns:
        The bytes for location.

      • 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];
        Specified by:
        getStateValue in interface ClusterOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • 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];
        Specified by:
        getState in interface ClusterOrBuilder
        Returns:
        The state.

      • 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;
        Specified by:
        getServeNodes in interface ClusterOrBuilder
        Returns:
        The serveNodes.

      • hasClusterConfig

        public boolean hasClusterConfig()
         Configuration for this cluster.
        .google.bigtable.admin.v2.Cluster.ClusterConfig cluster_config = 7;
        Specified by:
        hasClusterConfig in interface ClusterOrBuilder
        Returns:
        Whether the clusterConfig field is set.

      • 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];
        Specified by:
        getDefaultStorageTypeValue in interface ClusterOrBuilder
        Returns:
        The enum numeric value on the wire for defaultStorageType.

      • 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];
        Specified by:
        getDefaultStorageType in interface ClusterOrBuilder
        Returns:
        The defaultStorageType.

      • 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];
        Specified by:
        hasEncryptionConfig in interface ClusterOrBuilder
        Returns:
        Whether the encryptionConfig field is set.

      • 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];
        Specified by:
        getEncryptionConfig in interface ClusterOrBuilder
        Returns:
        The encryptionConfig.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Cluster parseFrom​(ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Cluster parseFrom​(ByteBuffer data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Cluster parseFrom​(com.google.protobuf.ByteString data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Cluster parseFrom​(com.google.protobuf.ByteString data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Cluster parseFrom​(byte[] data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Cluster parseFrom​(byte[] data,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Cluster parseFrom​(com.google.protobuf.CodedInputStream input,
                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                         throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Cluster.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Cluster.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Cluster.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Cluster getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Cluster> parser()

      • getParserForType

        public com.google.protobuf.Parser<Cluster> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Cluster getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder