syntax = "proto3";

package tidb_cloud_open_api.common.v1beta1;

option go_package = "tidb_cloud_open_api/common/v1beta1";

// Enum of possible states of a cluster.
enum ClusterState {
  CLUSTER_STATE_UNSPECIFIED = 0;

  // Cluster is being created.
  CREATING = 1;

  // Cluster is being deleted.
  DELETING = 2;

  // Cluster is active for use.
  ACTIVE = 3;

  // Cluster data is being restored.
  RESTORING = 4;

  // Cluster is under maintenance.
  MAINTENANCE = 5;

  // Cluster has been deleted.
  DELETED = 6;

  // Cluster is not active, but not being deleted.
  INACTIVE = 7;

  // Cluster is being updated.
  // Only for Dedicated Cluster.
  UPGRADING = 8;

  // Cluster is being imported.
  // Only for Dedicated Cluster.
  IMPORTING = 9;

  // Cluster is being modified.
  // Only for Dedicated Cluster.
  MODIFYING = 10;

  // Cluster is being paused.
  // Only for Dedicated Cluster.
  PAUSING = 11;

  // Cluster is paused.
  // Only for Dedicated Cluster.
  PAUSED = 12;

  // Cluster is resuming.
  // Only for Dedicated Cluster.
  RESUMING = 13;
}