Package com.google.cloud.bigtable.admin.v2.models

Enum Cluster.State

java.lang.Object
java.lang.Enum<Cluster.State>
com.google.cloud.bigtable.admin.v2.models.Cluster.State
All Implemented Interfaces:
Serializable, Comparable<Cluster.State>
Enclosing class:
Cluster
public static enum Cluster.State extends Enum<Cluster.State>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CREATING
    The cluster is currently being created, and may be destroyed if the creation process encounters an error.
    DISABLED
    The cluster has no backing nodes.
    NOT_KNOWN
    The state of the cluster could not be determined.
    READY
    The cluster has been successfully created and is ready to serve requests.
    RESIZING
    The cluster is currently being resized, and may revert to its previous node count if the process encounters an error.
    UNRECOGNIZED
    The state of the cluster is not known by this client.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Cluster.State
    fromProto(com.google.bigtable.admin.v2.Cluster.State proto)
    Wraps the protobuf.
    com.google.bigtable.admin.v2.Cluster.State
    toProto()
    Creates the request protobuf.
    static Cluster.State
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static Cluster.State[]
    values()
    Returns an array containing the constants of this enum type, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • NOT_KNOWN

      public static final Cluster.State NOT_KNOWN
      The state of the cluster could not be determined.

    • READY

      public static final Cluster.State READY
      The cluster has been successfully created and is ready to serve requests.

    • CREATING

      public static final Cluster.State CREATING
      The cluster is currently being created, and may be destroyed if the creation process encounters an error. A cluster may not be able to serve requests while being created.

    • RESIZING

      public static final Cluster.State RESIZING
      The cluster is currently being resized, and may revert to its previous node count if the process encounters an error. A cluster is still capable of serving requests while being resized, but may exhibit performance as if its number of allocated nodes is between the starting and requested states.

    • DISABLED

      public static final Cluster.State DISABLED
      The cluster has no backing nodes. The data (tables) still exist, but no operations can be performed on the cluster.

    • UNRECOGNIZED

      public static final Cluster.State UNRECOGNIZED
      The state of the cluster is not known by this client. Please upgrade your client.

  • Method Details

    • values

      public static Cluster.State[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static Cluster.State valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • fromProto

      @InternalApi public static Cluster.State fromProto(com.google.bigtable.admin.v2.Cluster.State proto)
      Wraps the protobuf. This method is considered an internal implementation detail and not meant to be used by applications.

    • toProto

      @InternalApi public com.google.bigtable.admin.v2.Cluster.State toProto()
      Creates the request protobuf. This method is considered an internal implementation detail and not meant to be used by applications.