package google.bigtable.admin.cluster.v1
Get desktop application:
View/edit binary Protocol Buffers messages
Service for managing zonal Cloud Bigtable resources.
Lists the supported zones for the given project.
Request message for BigtableClusterService.ListZones.
string name = 1
The unique name of the project for which a list of supported zones is requested. Values are of the form projects/<project>
Response message for BigtableClusterService.ListZones.
repeated zones = 1
The list of requested zones.
Gets information about a particular cluster.
Request message for BigtableClusterService.GetCluster.
string name = 1
The unique name of the requested cluster. Values are of the form projects/<project>/zones/<zone>/clusters/<cluster>
Lists all clusters in the given project, along with any zones for which cluster information could not be retrieved.
Request message for BigtableClusterService.ListClusters.
string name = 1
The unique name of the project for which a list of clusters is requested. Values are of the form projects/<project>
Response message for BigtableClusterService.ListClusters.
repeated clusters = 1
The list of requested Clusters.
repeated failed_zones = 2
The zones for which clusters could not be retrieved.
Creates a cluster and begins preparing it to begin serving. The returned cluster embeds as its "current_operation" a long-running operation which can be used to track the progress of turning up the new cluster. Immediately upon completion of this request: * The cluster will be readable via the API, with all requested attributes but no allocated resources. Until completion of the embedded operation: * Cancelling the operation will render the cluster immediately unreadable via the API. * All other attempts to modify or delete the cluster will be rejected. Upon completion of the embedded operation: * Billing for all successfully-allocated resources will begin (some types may have lower than the requested levels). * New tables can be created in the cluster. * The cluster's allocated resource levels will be readable via the API. The embedded operation's "metadata" field type is [CreateClusterMetadata][google.bigtable.admin.cluster.v1.CreateClusterMetadata] The embedded operation's "response" field type is [Cluster][google.bigtable.admin.cluster.v1.Cluster], if successful.
Updates a cluster, and begins allocating or releasing resources as requested. The returned cluster embeds as its "current_operation" a long-running operation which can be used to track the progress of updating the cluster. Immediately upon completion of this request: * For resource types where a decrease in the cluster's allocation has been requested, billing will be based on the newly-requested level. Until completion of the embedded operation: * Cancelling the operation will set its metadata's "cancelled_at_time", and begin restoring resources to their pre-request values. The operation is guaranteed to succeed at undoing all resource changes, after which point it will terminate with a CANCELLED status. * All other attempts to modify or delete the cluster will be rejected. * Reading the cluster via the API will continue to give the pre-request resource levels. Upon completion of the embedded operation: * Billing will begin for all successfully-allocated resources (some types may have lower than the requested levels). * All newly-reserved resources will be available for serving the cluster's tables. * The cluster's new resource levels will be readable via the API. [UpdateClusterMetadata][google.bigtable.admin.cluster.v1.UpdateClusterMetadata] The embedded operation's "response" field type is [Cluster][google.bigtable.admin.cluster.v1.Cluster], if successful.
Marks a cluster and all of its tables for permanent deletion in 7 days. Immediately upon completion of the request: * Billing will cease for all of the cluster's reserved resources. * The cluster's "delete_time" field will be set 7 days in the future. Soon afterward: * All tables within the cluster will become unavailable. Prior to the cluster's "delete_time": * The cluster can be recovered with a call to UndeleteCluster. * All other attempts to modify or delete the cluster will be rejected. At the cluster's "delete_time": * The cluster and *all of its tables* will immediately and irrevocably disappear from the API, and their data will be permanently deleted.
Request message for BigtableClusterService.DeleteCluster.
string name = 1
The unique name of the cluster to be deleted. Values are of the form projects/<project>/zones/<zone>/clusters/<cluster>
Cancels the scheduled deletion of an cluster and begins preparing it to resume serving. The returned operation will also be embedded as the cluster's "current_operation". Immediately upon completion of this request: * The cluster's "delete_time" field will be unset, protecting it from automatic deletion. Until completion of the returned operation: * The operation cannot be cancelled. Upon completion of the returned operation: * Billing for the cluster's resources will resume. * All tables within the cluster will be available. [UndeleteClusterMetadata][google.bigtable.admin.cluster.v1.UndeleteClusterMetadata] The embedded operation's "response" field type is [Cluster][google.bigtable.admin.cluster.v1.Cluster], if successful.
Request message for BigtableClusterService.UndeleteCluster.
string name = 1
The unique name of the cluster to be un-deleted. Values are of the form projects/<project>/zones/<zone>/clusters/<cluster>
message
bigtable_cluster_data.proto:58An isolated set of Cloud BigTable resources on which tables can be hosted.
Used as request type in: BigtableClusterService.UpdateCluster
Used as response type in: BigtableClusterService.CreateCluster, BigtableClusterService.GetCluster, BigtableClusterService.UpdateCluster
Used as field type in: , ,
string name = 1
A permanent unique identifier for the cluster. For technical reasons, the zone in which the cluster resides is included here. Values are of the form projects/<project>/zones/<zone>/clusters/[a-z][-a-z0-9]*
optional current_operation = 3
The operation currently running on the cluster, if any. This cannot be set directly, only through CreateCluster, UpdateCluster, or UndeleteCluster. Calls to these methods will be rejected if "current_operation" is already set.
string display_name = 4
The descriptive name for this cluster as it appears in UIs. Must be unique per zone.
int32 serve_nodes = 5
The number of serve nodes allocated to this cluster.
StorageType default_storage_type = 8
What storage type to use for tables in this cluster. Only configurable at cluster creation time. If unspecified, STORAGE_SSD will be used.
Metadata type for the operation returned by BigtableClusterService.CreateCluster.
optional original_request = 1
The request which prompted the creation of this operation.
optional request_time = 2
The time at which original_request was received.
optional finish_time = 3
The time at which this operation failed or was completed successfully.
Request message for BigtableClusterService.CreateCluster.
Used as request type in: BigtableClusterService.CreateCluster
Used as field type in:
string name = 1
The unique name of the zone in which to create the cluster. Values are of the form projects/<project>/zones/<zone>
string cluster_id = 2
The id to be used when referring to the new cluster within its zone, e.g. just the "test-cluster" section of the full name "projects/<project>/zones/<zone>/clusters/test-cluster".
optional cluster = 3
The cluster to create. The "name", "delete_time", and "current_operation" fields must be left blank.
Used in:
STORAGE_UNSPECIFIED = 0
The storage type used is unspecified.
STORAGE_SSD = 1
Data will be stored in SSD, providing low and consistent latencies.
STORAGE_HDD = 2
Data will be stored in HDD, providing high and less predictable latencies.
Metadata type for the operation returned by BigtableClusterService.UndeleteCluster.
optional request_time = 1
The time at which the original request was received.
optional finish_time = 2
The time at which this operation failed or was completed successfully.
Metadata type for the operation returned by BigtableClusterService.UpdateCluster.
optional original_request = 1
The request which prompted the creation of this operation.
optional request_time = 2
The time at which original_request was received.
optional cancel_time = 3
The time at which this operation was cancelled. If set, this operation is in the process of undoing itself (which is guaranteed to succeed) and cannot be cancelled again.
optional finish_time = 4
The time at which this operation failed or was completed successfully.
Metadata type for operations initiated by the V2 BigtableAdmin service. More complete information for such operations is available via the V2 API.
(message has no fields)
message
bigtable_cluster_data.proto:30A physical location in which a particular project can allocate Cloud BigTable resources.
Used in: ,
string name = 1
A permanent unique identifier for the zone. Values are of the form projects/<project>/zones/[a-z][-a-z0-9]*
string display_name = 2
The name of this zone as it appears in UIs.
Zone.Status status = 3
The current state of this zone.
Possible states of a zone.
Used in:
UNKNOWN = 0
The state of the zone is unknown or unspecified.
OK = 1
The zone is in a good state.
PLANNED_MAINTENANCE = 2
The zone is down for planned maintenance.
EMERGENCY_MAINENANCE = 3
The zone is down for emergency or unplanned maintenance.