feat: add WarmAndPing request for channel priming

Google APIs · copybara-github · commit 6cce671cb21e · 2022-02-15T09:03:01.000-08:00
PiperOrigin-RevId: 428795660
diff --git a/google/bigtable/v2/bigtable.proto b/google/bigtable/v2/bigtable.proto
@@ -1,4 +1,4 @@
-// Copyright 2019 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.
@@ -36,6 +36,10 @@ option (google.api.resource_definition) = {
   type: "bigtableadmin.googleapis.com/Table"
   pattern: "projects/{project}/instances/{instance}/tables/{table}"
 };
+option (google.api.resource_definition) = {
+  type: "bigtableadmin.googleapis.com/Instance"
+  pattern: "projects/{project}/instances/{instance}"
+};
 
 // Service for reading from and writing to existing Bigtable tables.
 service Bigtable {
@@ -152,6 +156,26 @@ service Bigtable {
     option (google.api.method_signature) = "table_name,row_key,predicate_filter,true_mutations,false_mutations,app_profile_id";
   }
 
+  // Warm up associated instance metadata for this connection.
+  // This call is not required but may be useful for connection keep-alive.
+  rpc PingAndWarm(PingAndWarmRequest) returns (PingAndWarmResponse) {
+    option (google.api.http) = {
+      post: "/v2/{name=projects/*/instances/*}:ping"
+      body: "*"
+    };
+    option (google.api.routing) = {
+      routing_parameters {
+        field: "name"
+        path_template: "{name=projects/*/instances/*}"
+      }
+      routing_parameters {
+        field: "app_profile_id"
+      }
+    };
+    option (google.api.method_signature) = "name";
+    option (google.api.method_signature) = "name,app_profile_id";
+  }
+
   // Modifies a row atomically on the server. The method reads the latest
   // existing timestamp and value from the specified columns and writes a new
   // entry based on pre-defined read/modify/write rules. The new value for the
@@ -450,6 +474,27 @@ message CheckAndMutateRowResponse {
   bool predicate_matched = 1;
 }
 
+// Request message for client connection keep-alive and warming.
+message PingAndWarmRequest {
+  // Required. The unique name of the instance to check permissions for as well as
+  // respond. Values are of the form `projects/<project>/instances/<instance>`.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "bigtableadmin.googleapis.com/Instance"
+    }
+  ];
+
+  // This value specifies routing for replication. If not specified, the
+  // "default" application profile will be used.
+  string app_profile_id = 2;
+}
+
+// Response message for Bigtable.PingAndWarm connection keepalive and warming.
+message PingAndWarmResponse {
+
+}
+
 // Request message for Bigtable.ReadModifyWriteRow.
 message ReadModifyWriteRowRequest {
   // Required. The unique name of the table to which the read/modify/write rules should be
diff --git a/google/bigtable/v2/bigtable_grpc_service_config.json b/google/bigtable/v2/bigtable_grpc_service_config.json
@@ -11,13 +11,7 @@
           "method": "ReadModifyWriteRow"
         }
       ],
-      "timeout": "20s",
-      "retryPolicy": {
-        "initialBackoff": "0.010s",
-        "maxBackoff": "60s",
-        "backoffMultiplier": 2,
-        "retryableStatusCodes": []
-      }
+      "timeout": "20s"
     },
     {
       "name": [
@@ -26,13 +20,7 @@
           "method": "SampleRowKeys"
         }
       ],
-      "timeout": "60s",
-      "retryPolicy": {
-        "initialBackoff": "0.010s",
-        "maxBackoff": "60s",
-        "backoffMultiplier": 2,
-        "retryableStatusCodes": []
-      }
+      "timeout": "60s"
     },
     {
       "name": [
@@ -41,13 +29,7 @@
           "method": "MutateRows"
         }
       ],
-      "timeout": "600s",
-      "retryPolicy": {
-        "initialBackoff": "0.010s",
-        "maxBackoff": "60s",
-        "backoffMultiplier": 2,
-        "retryableStatusCodes": []
-      }
+      "timeout": "600s"
     },
     {
       "name": [
@@ -56,13 +38,7 @@
           "method": "ReadRows"
         }
       ],
-      "timeout": "43200s",
-      "retryPolicy": {
-        "initialBackoff": "0.010s",
-        "maxBackoff": "60s",
-        "backoffMultiplier": 2,
-        "retryableStatusCodes": []
-      }
+      "timeout": "43200s"
     },
     {
       "name": [
diff --git a/google/bigtable/v2/bigtable_v2.yaml b/google/bigtable/v2/bigtable_v2.yaml
@@ -1,5 +1,5 @@
 type: google.api.Service
-config_version: 1
+config_version: 3
 name: bigtable.googleapis.com
 title: Cloud Bigtable API
 
diff --git a/google/bigtable/v2/data.proto b/google/bigtable/v2/data.proto
@@ -1,4 +1,4 @@
-// Copyright 2019 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.

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Copyright 2019 Google LLC`
	`1`	`+// Copyright 2022 Google LLC`
`2`	`2`	`//`
`3`	`3`	`// Licensed under the Apache License, Version 2.0 (the "License");`
`4`	`4`	`// you may not use this file except in compliance with the License.`