feat: refreshes Bigtable Admin API(s) protos

Google APIs · copybara-github · commit b6fa58e3e886 · 2022-05-16T10:02:57.000-07:00
PiperOrigin-RevId: 448988001
diff --git a/google/bigtable/admin/v2/bigtable_instance_admin.proto b/google/bigtable/admin/v2/bigtable_instance_admin.proto
@@ -484,6 +484,37 @@ message UpdateInstanceMetadata {
 
 // The metadata for the Operation returned by CreateCluster.
 message CreateClusterMetadata {
+  // Progress info for copying a table's data to the new cluster.
+  message TableProgress {
+    enum State {
+      STATE_UNSPECIFIED = 0;
+
+      // The table has not yet begun copying to the new cluster.
+      PENDING = 1;
+
+      // The table is actively being copied to the new cluster.
+      COPYING = 2;
+
+      // The table has been fully copied to the new cluster.
+      COMPLETED = 3;
+
+      // The table was deleted before it finished copying to the new cluster.
+      // Note that tables deleted after completion will stay marked as
+      // COMPLETED, not CANCELLED.
+      CANCELLED = 4;
+    }
+
+    // Estimate of the size of the table to be copied.
+    int64 estimated_size_bytes = 2;
+
+    // Estimate of the number of bytes copied so far for this table.
+    // This will eventually reach 'estimated_size_bytes' unless the table copy
+    // is CANCELLED.
+    int64 estimated_copied_bytes = 3;
+
+    State state = 4;
+  }
+
   // The request that prompted the initiation of this CreateCluster operation.
   CreateClusterRequest original_request = 1;
 
@@ -492,6 +523,16 @@ message CreateClusterMetadata {
 
   // The time at which the operation failed or was completed successfully.
   google.protobuf.Timestamp finish_time = 3;
+
+  // Keys: the full `name` of each table that existed in the instance when
+  // CreateCluster was first called, i.e.
+  // `projects/<project>/instances/<instance>/tables/<table>`. Any table added
+  // to the instance by a later API call will be created in the new cluster by
+  // that API call, not this one.
+  //
+  // Values: information on how much of a table's data has been copied to the
+  // newly-created cluster so far.
+  map<string, TableProgress> tables = 4;
 }
 
 // The metadata for the Operation returned by UpdateCluster.
diff --git a/google/bigtable/admin/v2/bigtableadmin_grpc_service_config.json b/google/bigtable/admin/v2/bigtableadmin_grpc_service_config.json
@@ -105,6 +105,7 @@
       ],
       "timeout": "60s",
       "retryPolicy": {
+        "maxAttempts": 5,
         "initialBackoff": "1s",
         "maxBackoff": "60s",
         "backoffMultiplier": 2,
@@ -144,39 +145,35 @@
         },
         {
           "service": "google.bigtable.admin.v2.BigtableInstanceAdmin",
-          "method": "GetCluster"
+          "method": "UpdateInstance"
         },
         {
           "service": "google.bigtable.admin.v2.BigtableInstanceAdmin",
-          "method": "UpdateCluster"
+          "method": "PartialUpdateInstance"
         },
         {
           "service": "google.bigtable.admin.v2.BigtableInstanceAdmin",
-          "method": "PartialUpdateCluster"
+          "method": "GetCluster"
         },
         {
           "service": "google.bigtable.admin.v2.BigtableInstanceAdmin",
           "method": "ListClusters"
         },
         {
           "service": "google.bigtable.admin.v2.BigtableInstanceAdmin",
-          "method": "GetAppProfile"
-        },
-        {
-          "service": "google.bigtable.admin.v2.BigtableInstanceAdmin",
-          "method": "ListAppProfiles"
+          "method": "UpdateCluster"
         },
         {
           "service": "google.bigtable.admin.v2.BigtableInstanceAdmin",
-          "method": "UpdateAppProfile"
+          "method": "GetAppProfile"
         },
         {
           "service": "google.bigtable.admin.v2.BigtableInstanceAdmin",
-          "method": "UpdateInstance"
+          "method": "ListAppProfiles"
         },
         {
           "service": "google.bigtable.admin.v2.BigtableInstanceAdmin",
-          "method": "PartialUpdateInstance"
+          "method": "UpdateAppProfile"
         },
         {
           "service": "google.bigtable.admin.v2.BigtableInstanceAdmin",
diff --git a/google/bigtable/admin/v2/common.proto b/google/bigtable/admin/v2/common.proto
@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2022 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -16,8 +16,8 @@ syntax = "proto3";
 
 package google.bigtable.admin.v2;
 
-import "google/protobuf/timestamp.proto";
 import "google/api/annotations.proto";
+import "google/protobuf/timestamp.proto";
 
 option csharp_namespace = "Google.Cloud.Bigtable.Admin.V2";
 option go_package = "google.golang.org/genproto/googleapis/bigtable/admin/v2;admin";
diff --git a/google/bigtable/admin/v2/instance.proto b/google/bigtable/admin/v2/instance.proto
@@ -16,11 +16,11 @@ syntax = "proto3";
 
 package google.bigtable.admin.v2;
 
+import "google/api/annotations.proto";
 import "google/api/field_behavior.proto";
 import "google/api/resource.proto";
 import "google/bigtable/admin/v2/common.proto";
 import "google/protobuf/timestamp.proto";
-import "google/api/annotations.proto";
 
 option csharp_namespace = "Google.Cloud.Bigtable.Admin.V2";
 option go_package = "google.golang.org/genproto/googleapis/bigtable/admin/v2;admin";
@@ -69,19 +69,14 @@ message Instance {
     // on the cluster.
     PRODUCTION = 1;
 
-    // The instance is meant for development and testing purposes only; it has
-    // no performance or uptime guarantees and is not covered by SLA.
-    // After a development instance is created, it can be upgraded by
-    // updating the instance to type `PRODUCTION`. An instance created
-    // as a production instance cannot be changed to a development instance.
-    // When creating a development instance, `serve_nodes` on the cluster must
-    // not be set.
+    // DEPRECATED: Prefer PRODUCTION for all use cases, as it no longer enforces
+    // a higher minimum node count than DEVELOPMENT.
     DEVELOPMENT = 2;
   }
 
   // The unique name of the instance. Values are of the form
   // `projects/{project}/instances/[a-z][a-z0-9\\-]+[a-z0-9]`.
-  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+  string name = 1;
 
   // Required. The descriptive name for this instance as it appears in UIs.
   // Can be changed at any time, but should be kept globally unique
@@ -141,6 +136,31 @@ message Cluster {
     pattern: "projects/{project}/instances/{instance}/clusters/{cluster}"
   };
 
+  // Possible states of a cluster.
+  enum State {
+    // The state of the cluster could not be determined.
+    STATE_NOT_KNOWN = 0;
+
+    // The cluster has been successfully created and is ready to serve requests.
+    READY = 1;
+
+    // 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.
+    CREATING = 2;
+
+    // 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.
+    RESIZING = 3;
+
+    // The cluster has no backing nodes. The data (tables) still
+    // exist, but no operations can be performed on the cluster.
+    DISABLED = 4;
+  }
+
   // Autoscaling config for a cluster.
   message ClusterAutoscalingConfig {
     // Required. Autoscaling limits for this cluster.
@@ -166,50 +186,30 @@ message Cluster {
     //  `cloudkms.cryptoKeyEncrypterDecrypter` role on the CMEK key.
     //  2) Only regional keys can be used and the region of the CMEK key must
     //  match the region of the cluster.
+    //  3) All clusters within an instance must use the same CMEK key.
+    // Values are of the form
+    // `projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{key}`
     string kms_key_name = 1 [(google.api.resource_reference) = {
-      type: "cloudkms.googleapis.com/CryptoKey"
-    }];
-  }
-
-  // Possible states of a cluster.
-  enum State {
-    // The state of the cluster could not be determined.
-    STATE_NOT_KNOWN = 0;
-
-    // The cluster has been successfully created and is ready to serve requests.
-    READY = 1;
-
-    // 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.
-    CREATING = 2;
-
-    // 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.
-    RESIZING = 3;
-
-    // The cluster has no backing nodes. The data (tables) still
-    // exist, but no operations can be performed on the cluster.
-    DISABLED = 4;
+                               type: "cloudkms.googleapis.com/CryptoKey"
+                             }];
   }
 
   // The unique name of the cluster. Values are of the form
   // `projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*`.
-  string name = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+  string name = 1;
 
-  // (`CreationOnly`)
-  // The location where this cluster's nodes and storage reside. For best
+  // 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.resource_reference) = {
-    type: "locations.googleapis.com/Location"
-  }];
-
-  // The current state of the cluster.
+  string location = 2 [
+    (google.api.field_behavior) = IMMUTABLE,
+    (google.api.resource_reference) = {
+      type: "locations.googleapis.com/Location"
+    }
+  ];
+
+  // Output only. The current state of the cluster.
   State state = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // The number of nodes allocated to this cluster. More nodes enable higher
@@ -221,14 +221,12 @@ message Cluster {
     ClusterConfig cluster_config = 7;
   }
 
-  // (`CreationOnly`)
-  // The type of storage used by this cluster to serve its
+  // Immutable. The type of storage used by this cluster to serve its
   // parent instance's tables, unless explicitly overridden.
-  StorageType default_storage_type = 5;
+  StorageType default_storage_type = 5 [(google.api.field_behavior) = IMMUTABLE];
 
   // Immutable. The encryption configuration for CMEK-protected clusters.
-  EncryptionConfig encryption_config = 6
-      [(google.api.field_behavior) = IMMUTABLE];
+  EncryptionConfig encryption_config = 6 [(google.api.field_behavior) = IMMUTABLE];
 }
 
 // A configuration object describing how Cloud Bigtable should treat traffic
@@ -263,7 +261,6 @@ message AppProfile {
     bool allow_transactional_writes = 2;
   }
 
-  // (`OutputOnly`)
   // The unique name of the app profile. Values are of the form
   // `projects/{project}/instances/{instance}/appProfiles/[_a-zA-Z0-9][-_.a-zA-Z0-9]*`.
   string name = 1;
@@ -278,7 +275,7 @@ message AppProfile {
   // details.
   string etag = 2;
 
-  // Optional long form description of the use case for this AppProfile.
+  // Long form description of the use case for this AppProfile.
   string description = 3;
 
   // The routing policy for all read/write requests that use this app profile.
diff --git a/google/bigtable/admin/v2/table.proto b/google/bigtable/admin/v2/table.proto
