feat: Add support for Cloud Bigtable Request Priorities in App Profiles

Google APIs · copybara-github · commit bc3c83b41b15 · 2023-10-05T16:16:07.000-07:00
PiperOrigin-RevId: 571158646
diff --git a/google/bigtable/admin/v2/bigtable_instance_admin.proto b/google/bigtable/admin/v2/bigtable_instance_admin.proto
@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -57,12 +57,14 @@ service BigtableInstanceAdmin {
   // serve_nodes is set to non-zero, then the cluster is manually scaled. If
   // cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is
   // enabled.
-  rpc CreateInstance(CreateInstanceRequest) returns (google.longrunning.Operation) {
+  rpc CreateInstance(CreateInstanceRequest)
+      returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v2/{parent=projects/*}/instances"
       body: "*"
     };
-    option (google.api.method_signature) = "parent,instance_id,instance,clusters";
+    option (google.api.method_signature) =
+        "parent,instance_id,instance,clusters";
     option (google.longrunning.operation_info) = {
       response_type: "Instance"
       metadata_type: "CreateInstanceMetadata"
@@ -97,7 +99,8 @@ service BigtableInstanceAdmin {
 
   // Partially updates an instance within a project. This method can modify all
   // fields of an Instance and is the preferred way to update an Instance.
-  rpc PartialUpdateInstance(PartialUpdateInstanceRequest) returns (google.longrunning.Operation) {
+  rpc PartialUpdateInstance(PartialUpdateInstanceRequest)
+      returns (google.longrunning.Operation) {
     option (google.api.http) = {
       patch: "/v2/{instance.name=projects/*/instances/*}"
       body: "instance"
@@ -124,7 +127,8 @@ service BigtableInstanceAdmin {
   // serve_nodes is set to non-zero, then the cluster is manually scaled. If
   // cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is
   // enabled.
-  rpc CreateCluster(CreateClusterRequest) returns (google.longrunning.Operation) {
+  rpc CreateCluster(CreateClusterRequest)
+      returns (google.longrunning.Operation) {
     option (google.api.http) = {
       post: "/v2/{parent=projects/*/instances/*}/clusters"
       body: "cluster"
@@ -180,7 +184,8 @@ service BigtableInstanceAdmin {
   //
   // To disable autoscaling, clear cluster_config.cluster_autoscaling_config,
   // and explicitly set a serve_node count via the update_mask.
-  rpc PartialUpdateCluster(PartialUpdateClusterRequest) returns (google.longrunning.Operation) {
+  rpc PartialUpdateCluster(PartialUpdateClusterRequest)
+      returns (google.longrunning.Operation) {
     option (google.api.http) = {
       patch: "/v2/{cluster.name=projects/*/instances/*/clusters/*}"
       body: "cluster"
@@ -218,15 +223,17 @@ service BigtableInstanceAdmin {
   }
 
   // Lists information about app profiles in an instance.
-  rpc ListAppProfiles(ListAppProfilesRequest) returns (ListAppProfilesResponse) {
+  rpc ListAppProfiles(ListAppProfilesRequest)
+      returns (ListAppProfilesResponse) {
     option (google.api.http) = {
       get: "/v2/{parent=projects/*/instances/*}/appProfiles"
     };
     option (google.api.method_signature) = "parent";
   }
 
   // Updates an app profile within an instance.
-  rpc UpdateAppProfile(UpdateAppProfileRequest) returns (google.longrunning.Operation) {
+  rpc UpdateAppProfile(UpdateAppProfileRequest)
+      returns (google.longrunning.Operation) {
     option (google.api.http) = {
       patch: "/v2/{app_profile.name=projects/*/instances/*/appProfiles/*}"
       body: "app_profile"
@@ -239,7 +246,8 @@ service BigtableInstanceAdmin {
   }
 
   // Deletes an app profile from an instance.
-  rpc DeleteAppProfile(DeleteAppProfileRequest) returns (google.protobuf.Empty) {
+  rpc DeleteAppProfile(DeleteAppProfileRequest)
+      returns (google.protobuf.Empty) {
     option (google.api.http) = {
       delete: "/v2/{name=projects/*/instances/*/appProfiles/*}"
     };
@@ -248,7 +256,8 @@ service BigtableInstanceAdmin {
 
   // Gets the access control policy for an instance resource. Returns an empty
   // policy if an instance exists but does not have a policy set.
-  rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) returns (google.iam.v1.Policy) {
+  rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest)
+      returns (google.iam.v1.Policy) {
     option (google.api.http) = {
       post: "/v2/{resource=projects/*/instances/*}:getIamPolicy"
       body: "*"
@@ -258,7 +267,8 @@ service BigtableInstanceAdmin {
 
   // Sets the access control policy on an instance resource. Replaces any
   // existing policy.
-  rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest) returns (google.iam.v1.Policy) {
+  rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest)
+      returns (google.iam.v1.Policy) {
     option (google.api.http) = {
       post: "/v2/{resource=projects/*/instances/*}:setIamPolicy"
       body: "*"
@@ -267,7 +277,8 @@ service BigtableInstanceAdmin {
   }
 
   // Returns permissions that the caller has on the specified instance resource.
-  rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest) returns (google.iam.v1.TestIamPermissionsResponse) {
+  rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest)
+      returns (google.iam.v1.TestIamPermissionsResponse) {
     option (google.api.http) = {
       post: "/v2/{resource=projects/*/instances/*}:testIamPermissions"
       body: "*"
@@ -287,17 +298,17 @@ service BigtableInstanceAdmin {
 
 // Request message for BigtableInstanceAdmin.CreateInstance.
 message CreateInstanceRequest {
-  // Required. The unique name of the project in which to create the new instance.
-  // Values are of the form `projects/{project}`.
+  // Required. The unique name of the project in which to create the new
+  // instance. Values are of the form `projects/{project}`.
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
       type: "cloudresourcemanager.googleapis.com/Project"
     }
   ];
 
-  // Required. The ID to be used when referring to the new instance within its project,
-  // e.g., just `myinstance` rather than
+  // Required. The ID to be used when referring to the new instance within its
+  // project, e.g., just `myinstance` rather than
   // `projects/myproject/instances/myinstance`.
   string instance_id = 2 [(google.api.field_behavior) = REQUIRED];
 
@@ -327,8 +338,8 @@ message GetInstanceRequest {
 
 // Request message for BigtableInstanceAdmin.ListInstances.
 message ListInstancesRequest {
-  // Required. The unique name of the project for which a list of instances is requested.
-  // Values are of the form `projects/{project}`.
+  // Required. The unique name of the project for which a list of instances is
+  // requested. Values are of the form `projects/{project}`.
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -364,7 +375,8 @@ message PartialUpdateInstanceRequest {
 
   // Required. The subset of Instance fields which should be replaced.
   // Must be explicitly set.
-  google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+  google.protobuf.FieldMask update_mask = 2
+      [(google.api.field_behavior) = REQUIRED];
 }
 
 // Request message for BigtableInstanceAdmin.DeleteInstance.
@@ -381,18 +393,17 @@ message DeleteInstanceRequest {
 
 // Request message for BigtableInstanceAdmin.CreateCluster.
 message CreateClusterRequest {
-  // Required. The unique name of the instance in which to create the new cluster.
-  // Values are of the form
-  // `projects/{project}/instances/{instance}`.
+  // Required. The unique name of the instance in which to create the new
+  // cluster. Values are of the form `projects/{project}/instances/{instance}`.
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
       type: "bigtableadmin.googleapis.com/Instance"
     }
   ];
 
-  // Required. The ID to be used when referring to the new cluster within its instance,
-  // e.g., just `mycluster` rather than
+  // Required. The ID to be used when referring to the new cluster within its
+  // instance, e.g., just `mycluster` rather than
   // `projects/myproject/instances/myinstance/clusters/mycluster`.
   string cluster_id = 2 [(google.api.field_behavior) = REQUIRED];
 
@@ -415,10 +426,11 @@ message GetClusterRequest {
 
 // Request message for BigtableInstanceAdmin.ListClusters.
 message ListClustersRequest {
-  // Required. The unique name of the instance for which a list of clusters is requested.
-  // Values are of the form `projects/{project}/instances/{instance}`.
-  // Use `{instance} = '-'` to list Clusters for all Instances in a project,
-  // e.g., `projects/myproject/instances/-`.
+  // Required. The unique name of the instance for which a list of clusters is
+  // requested. Values are of the form
+  // `projects/{project}/instances/{instance}`. Use `{instance} = '-'` to list
+  // Clusters for all Instances in a project, e.g.,
+  // `projects/myproject/instances/-`.
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -448,8 +460,8 @@ message ListClustersResponse {
 
 // Request message for BigtableInstanceAdmin.DeleteCluster.
 message DeleteClusterRequest {
-  // Required. The unique name of the cluster to be deleted. Values are of the form
-  // `projects/{project}/instances/{instance}/clusters/{cluster}`.
+  // Required. The unique name of the cluster to be deleted. Values are of the
+  // form `projects/{project}/instances/{instance}/clusters/{cluster}`.
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -561,28 +573,28 @@ message PartialUpdateClusterMetadata {
 
 // Request message for BigtableInstanceAdmin.PartialUpdateCluster.
 message PartialUpdateClusterRequest {
-  // Required. The Cluster which contains the partial updates to be applied, subject to
-  // the update_mask.
+  // Required. The Cluster which contains the partial updates to be applied,
+  // subject to the update_mask.
   Cluster cluster = 1 [(google.api.field_behavior) = REQUIRED];
 
   // Required. The subset of Cluster fields which should be replaced.
-  google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+  google.protobuf.FieldMask update_mask = 2
+      [(google.api.field_behavior) = REQUIRED];
 }
 
 // Request message for BigtableInstanceAdmin.CreateAppProfile.
 message CreateAppProfileRequest {
-  // Required. The unique name of the instance in which to create the new app profile.
-  // Values are of the form
-  // `projects/{project}/instances/{instance}`.
+  // Required. The unique name of the instance in which to create the new app
+  // profile. Values are of the form `projects/{project}/instances/{instance}`.
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
       type: "bigtableadmin.googleapis.com/Instance"
     }
   ];
 
-  // Required. The ID to be used when referring to the new app profile within its
-  // instance, e.g., just `myprofile` rather than
+  // Required. The ID to be used when referring to the new app profile within
+  // its instance, e.g., just `myprofile` rather than
   // `projects/myproject/instances/myinstance/appProfiles/myprofile`.
   string app_profile_id = 2 [(google.api.field_behavior) = REQUIRED];
 
@@ -596,8 +608,8 @@ message CreateAppProfileRequest {
 
 // Request message for BigtableInstanceAdmin.GetAppProfile.
 message GetAppProfileRequest {
-  // Required. The unique name of the requested app profile. Values are of the form
-  // `projects/{project}/instances/{instance}/appProfiles/{app_profile}`.
+  // Required. The unique name of the requested app profile. Values are of the
+  // form `projects/{project}/instances/{instance}/appProfiles/{app_profile}`.
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {
@@ -608,8 +620,8 @@ message GetAppProfileRequest {
 
 // Request message for BigtableInstanceAdmin.ListAppProfiles.
 message ListAppProfilesRequest {
-  // Required. The unique name of the instance for which a list of app profiles is
-  // requested. Values are of the form
+  // Required. The unique name of the instance for which a list of app profiles
+  // is requested. Values are of the form
   // `projects/{project}/instances/{instance}`.
   // Use `{instance} = '-'` to list AppProfiles for all Instances in a project,
   // e.g., `projects/myproject/instances/-`.
@@ -659,15 +671,17 @@ message UpdateAppProfileRequest {
 
   // Required. The subset of app profile fields which should be replaced.
   // If unset, all fields will be replaced.
-  google.protobuf.FieldMask update_mask = 2 [(google.api.field_behavior) = REQUIRED];
+  google.protobuf.FieldMask update_mask = 2
+      [(google.api.field_behavior) = REQUIRED];
 
   // If true, ignore safety checks when updating the app profile.
   bool ignore_warnings = 3;
 }
 
 // Request message for BigtableInstanceAdmin.DeleteAppProfile.
 message DeleteAppProfileRequest {
-  // Required. The unique name of the app profile to be deleted. Values are of the form
+  // Required. The unique name of the app profile to be deleted. Values are of
+  // the form
   // `projects/{project}/instances/{instance}/appProfiles/{app_profile}`.
   string name = 1 [
     (google.api.field_behavior) = REQUIRED,
@@ -681,9 +695,7 @@ message DeleteAppProfileRequest {
 }
 
 // The metadata for the Operation returned by UpdateAppProfile.
-message UpdateAppProfileMetadata {
-
-}
+message UpdateAppProfileMetadata {}
 
 // Request message for BigtableInstanceAdmin.ListHotTablets.
 message ListHotTabletsRequest {
diff --git a/google/bigtable/admin/v2/common.proto b/google/bigtable/admin/v2/common.proto
@@ -1,4 +1,4 @@
-// Copyright 2022 Google LLC
+// Copyright 2023 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
diff --git a/google/bigtable/admin/v2/instance.proto b/google/bigtable/admin/v2/instance.proto

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Copyright 2022 Google LLC`
	`1`	`+// Copyright 2023 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.`