docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.html b/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.html
index 46e2ca7..1984004 100644
--- a/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.html
+++ b/docs/dyn/serviceusage_v1beta1.services.consumerQuotaMetrics.html
@@ -83,7 +83,7 @@
<code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a summary of quota information for a specific quota metric</p>
<p class="toc_element">
- <code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(parent, pageToken=None, pageSize=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieves a summary of all quota information visible to the service</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -110,18 +110,37 @@
{ # Consumer quota settings for a quota metric.
"consumerQuotaLimits": [ # The consumer quota for each quota limit defined on the metric.
{ # Consumer quota settings for a quota limit.
+ "name": "A String", # The resource name of the quota limit.
+ #
+ # An example name would be:
+ # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`
+ #
+ # The resource name is intended to be opaque and should not be parsed for
+ # its component strings, since its representation could change in the future.
"allowsAdminOverrides": True or False, # Whether admin overrides are allowed on this limit
+ "isPrecise": True or False, # Whether this limit is precise or imprecise.
"quotaBuckets": [ # Summary of the enforced quota buckets, organized by quota dimension,
# ordered from least specific to most specific (for example, the global
# default bucket, with no quota dimensions, will always appear first).
{ # A quota bucket is a quota provisioning unit for a specific set of dimensions.
- "consumerOverride": { # A quota override # Consumer override on this quota bucket.
+ "adminOverride": { # A quota override # Admin override on this quota bucket.
"unit": "A String", # The limit unit of the limit to which this override applies.
#
# An example unit would be:
# `1/{project}/{region}`
# Note that `{project}` and `{region}` are not placeholders in this example;
# the literal characters `{` and `}` occur in the string.
+ "overrideValue": "A String", # The overriding quota limit value.
+ # Can be any nonnegative integer, or -1 (unlimited quota).
+ "name": "A String", # The resource name of the override.
+ # This name is generated by the server when the override is created.
+ #
+ # Example names would be:
+ # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
+ # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`
+ #
+ # The resource name is intended to be opaque and should not be parsed for
+ # its component strings, since its representation could change in the future.
"metric": "A String", # The name of the metric to which this override applies.
#
# An example name would be:
@@ -149,22 +168,7 @@
# map.
"a_key": "A String",
},
- "name": "A String", # The resource name of the override.
- # This name is generated by the server when the override is created.
- #
- # Example names would be:
- # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
- # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`
- #
- # The resource name is intended to be opaque and should not be parsed for
- # its component strings, since its representation could change in the future.
- "overrideValue": "A String", # The overriding quota limit value.
- # Can be any nonnegative integer, or -1 (unlimited quota).
},
- "defaultLimit": "A String", # The default limit of this quota bucket, as specified by the service
- # configuration.
- "effectiveLimit": "A String", # The effective limit of this quota bucket. Equal to default_limit if there
- # are no overrides.
"producerOverride": { # A quota override # Producer override on this quota bucket.
"unit": "A String", # The limit unit of the limit to which this override applies.
#
@@ -172,6 +176,17 @@
# `1/{project}/{region}`
# Note that `{project}` and `{region}` are not placeholders in this example;
# the literal characters `{` and `}` occur in the string.
+ "overrideValue": "A String", # The overriding quota limit value.
+ # Can be any nonnegative integer, or -1 (unlimited quota).
+ "name": "A String", # The resource name of the override.
+ # This name is generated by the server when the override is created.
+ #
+ # Example names would be:
+ # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
+ # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`
+ #
+ # The resource name is intended to be opaque and should not be parsed for
+ # its component strings, since its representation could change in the future.
"metric": "A String", # The name of the metric to which this override applies.
#
# An example name would be:
@@ -199,6 +214,16 @@
# map.
"a_key": "A String",
},
+ },
+ "consumerOverride": { # A quota override # Consumer override on this quota bucket.
+ "unit": "A String", # The limit unit of the limit to which this override applies.
+ #
+ # An example unit would be:
+ # `1/{project}/{region}`
+ # Note that `{project}` and `{region}` are not placeholders in this example;
+ # the literal characters `{` and `}` occur in the string.
+ "overrideValue": "A String", # The overriding quota limit value.
+ # Can be any nonnegative integer, or -1 (unlimited quota).
"name": "A String", # The resource name of the override.
# This name is generated by the server when the override is created.
#
@@ -208,9 +233,38 @@
#
# The resource name is intended to be opaque and should not be parsed for
# its component strings, since its representation could change in the future.
- "overrideValue": "A String", # The overriding quota limit value.
- # Can be any nonnegative integer, or -1 (unlimited quota).
+ "metric": "A String", # The name of the metric to which this override applies.
+ #
+ # An example name would be:
+ # `compute.googleapis.com/cpus`
+ "dimensions": { # If this map is nonempty, then this override applies only to specific values
+ # for dimensions defined in the limit unit.
+ #
+ # For example, an override on a limit with the unit 1/{project}/{region}
+ # could contain an entry with the key "region" and the value "us-east-1";
+ # the override is only applied to quota consumed in that region.
+ #
+ # This map has the following restrictions:
+ #
+ # * Keys that are not defined in the limit's unit are not valid keys.
+ # Any string appearing in {brackets} in the unit (besides {project} or
+ # {user}) is a defined key.
+ # * "project" is not a valid key; the project is already specified in
+ # the parent resource name.
+ # * "user" is not a valid key; the API does not support quota overrides
+ # that apply only to a specific user.
+ # * If "region" appears as a key, its value must be a valid Cloud region.
+ # * If "zone" appears as a key, its value must be a valid Cloud zone.
+ # * If any valid key other than "region" or "zone" appears in the map, then
+ # all valid keys other than "region" or "zone" must also appear in the
+ # map.
+ "a_key": "A String",
+ },
},
+ "defaultLimit": "A String", # The default limit of this quota bucket, as specified by the service
+ # configuration.
+ "effectiveLimit": "A String", # The effective limit of this quota bucket. Equal to default_limit if there
+ # are no overrides.
"dimensions": { # The dimensions of this quota bucket.
#
# If this map is empty, this is the global bucket, which is the default quota
@@ -224,61 +278,8 @@
# specified overrides apply only in that region.
"a_key": "A String",
},
- "adminOverride": { # A quota override # Admin override on this quota bucket.
- "unit": "A String", # The limit unit of the limit to which this override applies.
- #
- # An example unit would be:
- # `1/{project}/{region}`
- # Note that `{project}` and `{region}` are not placeholders in this example;
- # the literal characters `{` and `}` occur in the string.
- "metric": "A String", # The name of the metric to which this override applies.
- #
- # An example name would be:
- # `compute.googleapis.com/cpus`
- "dimensions": { # If this map is nonempty, then this override applies only to specific values
- # for dimensions defined in the limit unit.
- #
- # For example, an override on a limit with the unit 1/{project}/{region}
- # could contain an entry with the key "region" and the value "us-east-1";
- # the override is only applied to quota consumed in that region.
- #
- # This map has the following restrictions:
- #
- # * Keys that are not defined in the limit's unit are not valid keys.
- # Any string appearing in {brackets} in the unit (besides {project} or
- # {user}) is a defined key.
- # * "project" is not a valid key; the project is already specified in
- # the parent resource name.
- # * "user" is not a valid key; the API does not support quota overrides
- # that apply only to a specific user.
- # * If "region" appears as a key, its value must be a valid Cloud region.
- # * If "zone" appears as a key, its value must be a valid Cloud zone.
- # * If any valid key other than "region" or "zone" appears in the map, then
- # all valid keys other than "region" or "zone" must also appear in the
- # map.
- "a_key": "A String",
- },
- "name": "A String", # The resource name of the override.
- # This name is generated by the server when the override is created.
- #
- # Example names would be:
- # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
- # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`
- #
- # The resource name is intended to be opaque and should not be parsed for
- # its component strings, since its representation could change in the future.
- "overrideValue": "A String", # The overriding quota limit value.
- # Can be any nonnegative integer, or -1 (unlimited quota).
- },
},
],
- "name": "A String", # The resource name of the quota limit.
- #
- # An example name would be:
- # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`
- #
- # The resource name is intended to be opaque and should not be parsed for
- # its component strings, since its representation could change in the future.
"unit": "A String", # The limit unit.
#
# An example unit would be
@@ -289,7 +290,6 @@
#
# An example name would be:
# `compute.googleapis.com/cpus`
- "isPrecise": True or False, # Whether this limit is precise or imprecise.
},
],
"displayName": "A String", # The display name of the metric.
@@ -311,7 +311,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(parent, pageToken=None, pageSize=None, view=None, x__xgafv=None)</code>
<pre>Retrieves a summary of all quota information visible to the service
consumer, organized by service metric. Each metric includes information
about all of its defined limits. Each limit includes the limit
@@ -325,9 +325,9 @@
projects/123/services/serviceconsumermanagement.googleapis.com
folders/345/services/serviceconsumermanagement.googleapis.com
organizations/456/services/serviceconsumermanagement.googleapis.com (required)
- pageSize: integer, Requested size of the next page of data.
pageToken: string, Token identifying which result to start with; returned by a previous list
call.
+ pageSize: integer, Requested size of the next page of data.
view: string, Specifies the level of detail for quota information in the response.
x__xgafv: string, V1 error format.
Allowed values
@@ -342,18 +342,37 @@
{ # Consumer quota settings for a quota metric.
"consumerQuotaLimits": [ # The consumer quota for each quota limit defined on the metric.
{ # Consumer quota settings for a quota limit.
+ "name": "A String", # The resource name of the quota limit.
+ #
+ # An example name would be:
+ # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`
+ #
+ # The resource name is intended to be opaque and should not be parsed for
+ # its component strings, since its representation could change in the future.
"allowsAdminOverrides": True or False, # Whether admin overrides are allowed on this limit
+ "isPrecise": True or False, # Whether this limit is precise or imprecise.
"quotaBuckets": [ # Summary of the enforced quota buckets, organized by quota dimension,
# ordered from least specific to most specific (for example, the global
# default bucket, with no quota dimensions, will always appear first).
{ # A quota bucket is a quota provisioning unit for a specific set of dimensions.
- "consumerOverride": { # A quota override # Consumer override on this quota bucket.
+ "adminOverride": { # A quota override # Admin override on this quota bucket.
"unit": "A String", # The limit unit of the limit to which this override applies.
#
# An example unit would be:
# `1/{project}/{region}`
# Note that `{project}` and `{region}` are not placeholders in this example;
# the literal characters `{` and `}` occur in the string.
+ "overrideValue": "A String", # The overriding quota limit value.
+ # Can be any nonnegative integer, or -1 (unlimited quota).
+ "name": "A String", # The resource name of the override.
+ # This name is generated by the server when the override is created.
+ #
+ # Example names would be:
+ # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
+ # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`
+ #
+ # The resource name is intended to be opaque and should not be parsed for
+ # its component strings, since its representation could change in the future.
"metric": "A String", # The name of the metric to which this override applies.
#
# An example name would be:
@@ -381,22 +400,7 @@
# map.
"a_key": "A String",
},
- "name": "A String", # The resource name of the override.
- # This name is generated by the server when the override is created.
- #
- # Example names would be:
- # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
- # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`
- #
- # The resource name is intended to be opaque and should not be parsed for
- # its component strings, since its representation could change in the future.
- "overrideValue": "A String", # The overriding quota limit value.
- # Can be any nonnegative integer, or -1 (unlimited quota).
},
- "defaultLimit": "A String", # The default limit of this quota bucket, as specified by the service
- # configuration.
- "effectiveLimit": "A String", # The effective limit of this quota bucket. Equal to default_limit if there
- # are no overrides.
"producerOverride": { # A quota override # Producer override on this quota bucket.
"unit": "A String", # The limit unit of the limit to which this override applies.
#
@@ -404,6 +408,17 @@
# `1/{project}/{region}`
# Note that `{project}` and `{region}` are not placeholders in this example;
# the literal characters `{` and `}` occur in the string.
+ "overrideValue": "A String", # The overriding quota limit value.
+ # Can be any nonnegative integer, or -1 (unlimited quota).
+ "name": "A String", # The resource name of the override.
+ # This name is generated by the server when the override is created.
+ #
+ # Example names would be:
+ # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
+ # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`
+ #
+ # The resource name is intended to be opaque and should not be parsed for
+ # its component strings, since its representation could change in the future.
"metric": "A String", # The name of the metric to which this override applies.
#
# An example name would be:
@@ -431,6 +446,16 @@
# map.
"a_key": "A String",
},
+ },
+ "consumerOverride": { # A quota override # Consumer override on this quota bucket.
+ "unit": "A String", # The limit unit of the limit to which this override applies.
+ #
+ # An example unit would be:
+ # `1/{project}/{region}`
+ # Note that `{project}` and `{region}` are not placeholders in this example;
+ # the literal characters `{` and `}` occur in the string.
+ "overrideValue": "A String", # The overriding quota limit value.
+ # Can be any nonnegative integer, or -1 (unlimited quota).
"name": "A String", # The resource name of the override.
# This name is generated by the server when the override is created.
#
@@ -440,9 +465,38 @@
#
# The resource name is intended to be opaque and should not be parsed for
# its component strings, since its representation could change in the future.
- "overrideValue": "A String", # The overriding quota limit value.
- # Can be any nonnegative integer, or -1 (unlimited quota).
+ "metric": "A String", # The name of the metric to which this override applies.
+ #
+ # An example name would be:
+ # `compute.googleapis.com/cpus`
+ "dimensions": { # If this map is nonempty, then this override applies only to specific values
+ # for dimensions defined in the limit unit.
+ #
+ # For example, an override on a limit with the unit 1/{project}/{region}
+ # could contain an entry with the key "region" and the value "us-east-1";
+ # the override is only applied to quota consumed in that region.
+ #
+ # This map has the following restrictions:
+ #
+ # * Keys that are not defined in the limit's unit are not valid keys.
+ # Any string appearing in {brackets} in the unit (besides {project} or
+ # {user}) is a defined key.
+ # * "project" is not a valid key; the project is already specified in
+ # the parent resource name.
+ # * "user" is not a valid key; the API does not support quota overrides
+ # that apply only to a specific user.
+ # * If "region" appears as a key, its value must be a valid Cloud region.
+ # * If "zone" appears as a key, its value must be a valid Cloud zone.
+ # * If any valid key other than "region" or "zone" appears in the map, then
+ # all valid keys other than "region" or "zone" must also appear in the
+ # map.
+ "a_key": "A String",
+ },
},
+ "defaultLimit": "A String", # The default limit of this quota bucket, as specified by the service
+ # configuration.
+ "effectiveLimit": "A String", # The effective limit of this quota bucket. Equal to default_limit if there
+ # are no overrides.
"dimensions": { # The dimensions of this quota bucket.
#
# If this map is empty, this is the global bucket, which is the default quota
@@ -456,61 +510,8 @@
# specified overrides apply only in that region.
"a_key": "A String",
},
- "adminOverride": { # A quota override # Admin override on this quota bucket.
- "unit": "A String", # The limit unit of the limit to which this override applies.
- #
- # An example unit would be:
- # `1/{project}/{region}`
- # Note that `{project}` and `{region}` are not placeholders in this example;
- # the literal characters `{` and `}` occur in the string.
- "metric": "A String", # The name of the metric to which this override applies.
- #
- # An example name would be:
- # `compute.googleapis.com/cpus`
- "dimensions": { # If this map is nonempty, then this override applies only to specific values
- # for dimensions defined in the limit unit.
- #
- # For example, an override on a limit with the unit 1/{project}/{region}
- # could contain an entry with the key "region" and the value "us-east-1";
- # the override is only applied to quota consumed in that region.
- #
- # This map has the following restrictions:
- #
- # * Keys that are not defined in the limit's unit are not valid keys.
- # Any string appearing in {brackets} in the unit (besides {project} or
- # {user}) is a defined key.
- # * "project" is not a valid key; the project is already specified in
- # the parent resource name.
- # * "user" is not a valid key; the API does not support quota overrides
- # that apply only to a specific user.
- # * If "region" appears as a key, its value must be a valid Cloud region.
- # * If "zone" appears as a key, its value must be a valid Cloud zone.
- # * If any valid key other than "region" or "zone" appears in the map, then
- # all valid keys other than "region" or "zone" must also appear in the
- # map.
- "a_key": "A String",
- },
- "name": "A String", # The resource name of the override.
- # This name is generated by the server when the override is created.
- #
- # Example names would be:
- # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d`
- # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d`
- #
- # The resource name is intended to be opaque and should not be parsed for
- # its component strings, since its representation could change in the future.
- "overrideValue": "A String", # The overriding quota limit value.
- # Can be any nonnegative integer, or -1 (unlimited quota).
- },
},
],
- "name": "A String", # The resource name of the quota limit.
- #
- # An example name would be:
- # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`
- #
- # The resource name is intended to be opaque and should not be parsed for
- # its component strings, since its representation could change in the future.
"unit": "A String", # The limit unit.
#
# An example unit would be
@@ -521,7 +522,6 @@
#
# An example name would be:
# `compute.googleapis.com/cpus`
- "isPrecise": True or False, # Whether this limit is precise or imprecise.
},
],
"displayName": "A String", # The display name of the metric.