feat: added VerifyConnectivity RPC

Google APIs · copybara-github · commit be2600ed6ce9 · 2023-05-10T13:33:19.000-07:00
PiperOrigin-RevId: 530991686
diff --git a/google/cloud/kms/v1/ekm_service.proto b/google/cloud/kms/v1/ekm_service.proto
@@ -102,6 +102,19 @@ service EkmService {
     };
     option (google.api.method_signature) = "ekm_config,update_mask";
   }
+
+  // Verifies that Cloud KMS can successfully connect to the external key
+  // manager specified by an [EkmConnection][google.cloud.kms.v1.EkmConnection].
+  // If there is an error connecting to the EKM, this method returns a
+  // FAILED_PRECONDITION status containing structured information as described
+  // at https://cloud.google.com/kms/docs/reference/ekm_errors.
+  rpc VerifyConnectivity(VerifyConnectivityRequest)
+      returns (VerifyConnectivityResponse) {
+    option (google.api.http) = {
+      get: "/v1/{name=projects/*/locations/*/ekmConnections/*}:verifyConnectivity"
+    };
+    option (google.api.method_signature) = "name";
+  }
 }
 
 // Request message for
@@ -419,3 +432,20 @@ message EkmConfig {
     }
   ];
 }
+
+// Request message for
+// [EkmService.VerifyConnectivity][google.cloud.kms.v1.EkmService.VerifyConnectivity].
+message VerifyConnectivityRequest {
+  // Required. The [name][google.cloud.kms.v1.EkmConnection.name] of the
+  // [EkmConnection][google.cloud.kms.v1.EkmConnection] to verify.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "cloudkms.googleapis.com/EkmConnection"
+    }
+  ];
+}
+
+// Response message for
+// [EkmService.VerifyConnectivity][google.cloud.kms.v1.EkmService.VerifyConnectivity].
+message VerifyConnectivityResponse {}
