feat: Added support for hierarchical enrollment in Quota Adjuster consumer API

Google APIs · copybara-github · commit 818eab111d50 · 2025-06-06T06:44:56.000-07:00
docs: Added 2 new fields in `.google.api.cloudquotas.v1beta.QuotaAdjusterSettings`
docs: Added inherited and inherited_from in `.google.api.cloudquotas.v1beta.QuotaAdjusterSettings`
docs: Added support for folder and organization level enrollment

PiperOrigin-RevId: 768053907
diff --git a/google/api/cloudquotas/v1beta/quota_adjuster_settings.proto b/google/api/cloudquotas/v1beta/quota_adjuster_settings.proto
@@ -48,6 +48,14 @@ service QuotaAdjusterSettingsManager {
     option (google.api.http) = {
       patch: "/v1beta/{quota_adjuster_settings.name=projects/*/locations/*/quotaAdjusterSettings}"
       body: "quota_adjuster_settings"
+      additional_bindings {
+        patch: "/v1beta/{quota_adjuster_settings.name=folders/*/locations/*/quotaAdjusterSettings}"
+        body: "quota_adjuster_settings"
+      }
+      additional_bindings {
+        patch: "/v1beta/{quota_adjuster_settings.name=organizations/*/locations/*/quotaAdjusterSettings}"
+        body: "quota_adjuster_settings"
+      }
     };
     option (google.api.method_signature) =
         "quota_adjuster_settings,update_mask";
@@ -58,6 +66,12 @@ service QuotaAdjusterSettingsManager {
       returns (QuotaAdjusterSettings) {
     option (google.api.http) = {
       get: "/v1beta/{name=projects/*/locations/*/quotaAdjusterSettings}"
+      additional_bindings {
+        get: "/v1beta/{name=folders/*/locations/*/quotaAdjusterSettings}"
+      }
+      additional_bindings {
+        get: "/v1beta/{name=organizations/*/locations/*/quotaAdjusterSettings}"
+      }
     };
     option (google.api.method_signature) = "name";
   }
@@ -97,6 +111,8 @@ message QuotaAdjusterSettings {
   option (google.api.resource) = {
     type: "cloudquotas.googleapis.com/QuotaAdjusterSettings"
     pattern: "projects/{project}/locations/{location}/quotaAdjusterSettings"
+    pattern: "organizations/{organization}/locations/{location}/quotaAdjusterSettings"
+    pattern: "folders/{folder}/locations/{location}/quotaAdjusterSettings"
     plural: "quotaAdjusterSettings"
     singular: "quotaAdjusterSettings"
     style: DECLARATIVE_FRIENDLY
@@ -114,13 +130,14 @@ message QuotaAdjusterSettings {
     DISABLED = 3;
   }
 
-  // Identifier. Name of the configuration, in the following format:
-  //   `projects/PROJECT_NUMBER/locations/global/quotaAdjusterSettings`.
-  // Replace PROJECT_NUMBER with the project number for your project.
+  // Identifier. Name of the config would be of the format:
+  //   projects/PROJECT_NUMBER/locations/global/quotaAdjusterSettings
+  //   folders/FOLDER_NUMBER/locations/global/quotaAdjusterSettings
+  //   organizations/ORGANIZATION_NUMBER/locations/global/quotaAdjusterSettings
   string name = 1 [(google.api.field_behavior) = IDENTIFIER];
 
-  // Required. The configured value of the enablement at the given resource.
-  Enablement enablement = 2 [(google.api.field_behavior) = REQUIRED];
+  // Optional. The configured value of the enablement at the given resource.
+  Enablement enablement = 2 [(google.api.field_behavior) = OPTIONAL];
 
   // Output only. The timestamp when the QuotaAdjusterSettings resource was last
   // updated.
@@ -132,4 +149,16 @@ message QuotaAdjusterSettings {
   // QuotaAdjusterSettings, the request is blocked and returns an ABORTED error.
   // See https://google.aip.dev/134#etags for more details on ETags.
   string etag = 6 [(google.api.field_behavior) = OPTIONAL];
+
+  // Optional. Indicates whether the setting is inherited or explicitly
+  // specified.
+  bool inherited = 7 [(google.api.field_behavior) = OPTIONAL];
+
+  // Output only. The resource container from which the setting is inherited.
+  // This refers to the  nearest ancestor with enablement set (either ENABLED or
+  // DISABLED). The value can be an organizations/{organization_id},
+  // folders/{folder_id}, or can be 'default' if no ancestor exists with
+  // enablement set. The value will be empty when enablement is directly set on
+  // this container.
+  string inherited_from = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
 }
diff --git a/google/api/cloudquotas/v1beta/resources.proto b/google/api/cloudquotas/v1beta/resources.proto
@@ -70,21 +70,21 @@ message QuotaInfo {
 
   // Resource name of this QuotaInfo.
   // The ID component following "locations/" must be "global".
-  // Example:
+  // For example,
   // `projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion`
   string name = 1;
 
   // The id of the quota, which is unquie within the service.
-  // Example: `CpusPerProjectPerRegion`
+  // For example, `CpusPerProjectPerRegion`
   string quota_id = 2;
 
   // The metric of the quota. It specifies the resources consumption the quota
   // is defined for.
-  // Example: `compute.googleapis.com/cpus`
+  // For example, `compute.googleapis.com/cpus`
   string metric = 3;
 
   // The name of the service in which the quota is defined.
-  // Example: `compute.googleapis.com`
+  // For example, `compute.googleapis.com`
   string service = 4;
 
   // Whether this is a precise quota. A precise quota is tracked with absolute
@@ -93,8 +93,8 @@ message QuotaInfo {
 
   // The reset time interval for the quota. Refresh interval applies to rate
   // quota only.
-  // Example: "minute" for per minute, "day" for per day, or "10 seconds" for
-  // every 10 seconds.
+  // For example, "minute" for per minute, "day" for per day, or "10 seconds"
+  // for every 10 seconds.
   string refresh_interval = 6;
 
   // The container type of the QuotaInfo.
@@ -175,25 +175,26 @@ message QuotaPreference {
 
   // Required except in the CREATE requests.
   // The resource name of the quota preference.
-  // The ID component following "locations/" must be "global".
-  // Example:
+  // The path that follows `/locations` must be `/global`.
+  // For example:
   // `projects/123/locations/global/quotaPreferences/my-config-for-us-east1`
   string name = 1;
 
   // Immutable. The dimensions that this quota preference applies to. The key of
-  // the map entry is the name of a dimension, such as "region", "zone",
-  // "network_id", and the value of the map entry is the dimension value.
+  // the map entry is the name of a dimension, such as `region`, `zone`,
+  // `network_id`, and the value of the map entry is the dimension value.
   //
   // If a dimension is missing from the map of dimensions, the quota preference
   // applies to all the dimension values except for those that have other quota
   // preferences configured for the specific value.
   //
-  // NOTE: QuotaPreferences can only be applied across all values of "user" and
-  // "resource" dimension. Do not set values for "user" or "resource" in the
+  // Note: QuotaPreferences can only be applied across all values of `user` and
+  // `resource` dimension. Do not set values for `user` or `resource` in the
   // dimension map.
   //
-  // Example: {"provider", "Foo Inc"} where "provider" is a service specific
-  // dimension.
+  // For example: `{"provider" : "Example Organization"}` where `provider` is a
+  // service-specific quota dimension and `Example Organization` is the provider
+  // name.
   map<string, string> dimensions = 2 [(google.api.field_behavior) = IMMUTABLE];
 
   // Required. Preferred quota configuration.
@@ -217,7 +218,7 @@ message QuotaPreference {
   string service = 7 [(google.api.field_behavior) = REQUIRED];
 
   // Required. The id of the quota to which the quota preference is applied. A
-  // quota name is unique in the service. Example: `CpusPerProjectPerRegion`
+  // quota name is unique in the service. For example, `CpusPerProjectPerRegion`
   string quota_id = 8 [(google.api.field_behavior) = REQUIRED];
 
   // Output only. Is the quota preference pending Google Cloud approval and
@@ -227,9 +228,9 @@ message QuotaPreference {
   // The reason / justification for this quota preference.
   string justification = 11;
 
-  // Input only. An email address that can be used to contact the the user, in
-  // case Google Cloud needs more information to make a decision before
-  // additional quota can be granted.
+  // Input only. An email address that can be used to contact the user, in case
+  // Google Cloud needs more information to make a decision before additional
+  // quota can be granted.
   //
   // When requesting a quota increase, the email address is required.
   // When requesting a quota decrease, the email address is optional.
@@ -283,20 +284,21 @@ message QuotaConfig {
 // The detailed quota information such as effective quota value for a
 // combination of dimensions.
 message DimensionsInfo {
-  // The map of dimensions for this dimensions info. The key of a map entry
-  // is "region", "zone" or the name of a service specific dimension, and the
-  // value of a map entry is the value of the dimension.  If a dimension does
+  // The map of dimensions in key-value pairs. The key of a map entry
+  // is "region", "zone", or the name of a service-specific dimension, and the
+  // value of a map entry is the value of the dimension. If a dimension does
   // not appear in the map of dimensions, the dimensions info applies to all
-  // the dimension values except for those that have another DimenisonInfo
+  // the dimension values except for those that have another DimensionInfo
   // instance configured for the specific value.
-  // Example: {"provider" : "Foo Inc"} where "provider" is a service specific
-  // dimension of a quota.
+  // For example: `{"provider" : "Example Organization"}` where `provider` is a
+  // service-specific quota dimension and `Example Organization` is the provider
+  // name.
   map<string, string> dimensions = 1;
 
   // Quota details for the specified dimensions.
   QuotaDetails details = 2;
 
-  // The applicable regions or zones of this dimensions info. The field will be
+  // The applicable regions or zones of this dimension. The field is
   // set to ['global'] for quotas that are not per region or per zone.
   // Otherwise, it will be set to the list of locations this dimension info is
   // applicable to.
