feat: Publish CBT deletion_protection field in Table, UpdateTableRequest, and UpdateTable API in **stable** proto to external customers

Google APIs · copybara-github · commit e210283d7f45 · 2022-09-13T07:11:09.000-07:00
PiperOrigin-RevId: 474010093
diff --git a/google/bigtable/admin/v2/bigtable_table_admin.proto b/google/bigtable/admin/v2/bigtable_table_admin.proto
@@ -100,6 +100,19 @@ service BigtableTableAdmin {
     option (google.api.method_signature) = "name";
   }
 
+  // Updates a specified table.
+  rpc UpdateTable(UpdateTableRequest) returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      patch: "/v2/{table.name=projects/*/instances/*/tables/*}"
+      body: "table"
+    };
+    option (google.api.method_signature) = "table,update_mask";
+    option (google.longrunning.operation_info) = {
+      response_type: "Table"
+      metadata_type: "UpdateTableMetadata"
+    };
+  }
+
   // Permanently deletes a specified table and all of its data.
   rpc DeleteTable(DeleteTableRequest) returns (google.protobuf.Empty) {
     option (google.api.http) = {
@@ -368,8 +381,8 @@ message RestoreTableRequest {
     // Name of the backup from which to restore.  Values are of the form
     // `projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>`.
     string backup = 3 [(google.api.resource_reference) = {
-                         type: "bigtableadmin.googleapis.com/Backup"
-                       }];
+      type: "bigtableadmin.googleapis.com/Backup"
+    }];
   }
 }
 
@@ -579,6 +592,40 @@ message GetTableRequest {
   Table.View view = 2;
 }
 
+// The request for
+// [UpdateTable][google.bigtable.admin.v2.BigtableTableAdmin.UpdateTable].
+message UpdateTableRequest {
+  // Required. The table to update.
+  // The table's `name` field is used to identify the table to update.
+  // Format:
+  // `projects/{project}/instances/{instance}/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`
+  Table table = 1 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The list of fields to update.
+  // A mask specifying which fields (e.g. `deletion_protection`) in the `table`
+  // field should be updated. This mask is relative to the `table` field, not to
+  // the request message. The wildcard (*) path is currently not supported.
+  // Currently UpdateTable is only supported for the following field:
+  //  * `deletion_protection`
+  // If `column_families` is set in `update_mask`, it will return an
+  // UNIMPLEMENTED error.
+  google.protobuf.FieldMask update_mask = 2
+      [(google.api.field_behavior) = REQUIRED];
+}
+
+// Metadata type for the operation returned by
+// [UpdateTable][google.bigtable.admin.v2.BigtableTableAdmin.UpdateTable].
+message UpdateTableMetadata {
+  // The name of the table being updated.
+  string name = 1;
+
+  // The time at which this operation started.
+  google.protobuf.Timestamp start_time = 2;
+
+  // If set, the time at which this operation finished or was canceled.
+  google.protobuf.Timestamp end_time = 3;
+}
+
 // Request message for
 // [google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable][google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable]
 message DeleteTableRequest {
diff --git a/google/bigtable/admin/v2/bigtableadmin_v2.yaml b/google/bigtable/admin/v2/bigtableadmin_v2.yaml
@@ -21,6 +21,7 @@ types:
 - name: google.bigtable.admin.v2.UpdateAppProfileMetadata
 - name: google.bigtable.admin.v2.UpdateClusterMetadata
 - name: google.bigtable.admin.v2.UpdateInstanceMetadata
+- name: google.bigtable.admin.v2.UpdateTableMetadata
 
 documentation:
   summary: Administer your Cloud Bigtable tables and instances.
diff --git a/google/bigtable/admin/v2/table.proto b/google/bigtable/admin/v2/table.proto
@@ -156,6 +156,14 @@ message Table {
   // Output only. If this table was restored from another data source (e.g. a backup), this
   // field will be populated with information about the restore.
   RestoreInfo restore_info = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Set to true to make the table protected against data loss. i.e. deleting
+  // the following resources through Admin APIs are prohibited:
+  //   - The table.
+  //   - The column families in the table.
+  //   - The instance containing the table.
+  // Note one can still delete the data stored in the table through Data APIs.
+  bool deletion_protection = 9;
 }
 
 // A set of columns within a table which share a common configuration.
