blob: ffeccb20b5d8004499abb9ad7d40e3e1e9a6bc9b [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="serviceconsumermanagement_v1beta1.html">Service Consumer Management API</a> . <a href="serviceconsumermanagement_v1beta1.services.html">services</a> . <a href="serviceconsumermanagement_v1beta1.services.consumerQuotaMetrics.html">consumerQuotaMetrics</a> . <a href="serviceconsumermanagement_v1beta1.services.consumerQuotaMetrics.limits.html">limits</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="serviceconsumermanagement_v1beta1.services.consumerQuotaMetrics.limits.producerOverrides.html">producerOverrides()</a></code>
</p>
<p class="firstline">Returns the producerOverrides Resource.</p>
<p class="toc_element">
<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 limit.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(name, view=None, x__xgafv=None)</code>
<pre>Retrieves a summary of quota information for a specific quota limit.
Args:
name: string, The resource name of the quota limit, returned by a
ListConsumerQuotaMetrics or GetConsumerQuotaMetric call.
An example name would be:
`services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` (required)
view: string, Specifies the level of detail for quota information in the response.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Consumer quota settings for a quota limit.
&quot;unit&quot;: &quot;A String&quot;, # The limit unit.
#
# 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.
&quot;metric&quot;: &quot;A String&quot;, # The name of the parent metric of this limit.
#
# An example name would be:
# `compute.googleapis.com/cpus`
&quot;isPrecise&quot;: True or False, # Whether this limit is precise or imprecise.
&quot;name&quot;: &quot;A String&quot;, # The resource name of the quota limit.
#
# An example name would be:
# `services/compute.googleapis.com/projects/123/quotas/metrics/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.
&quot;quotaBuckets&quot;: [ # 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.
&quot;effectiveLimit&quot;: &quot;A String&quot;, # The effective limit of this quota bucket. Equal to default_limit if there
# are no overrides.
&quot;dimensions&quot;: { # The dimensions of this quota bucket.
#
# If this map is empty, this is the global bucket, which is the default quota
# value applied to all requests that do not have a more specific override.
#
# If this map is nonempty, the default limit, effective limit, and quota
# overrides apply only to requests that have the dimensions given in the map.
#
# For example, if the map has key &quot;region&quot; and value &quot;us-east-1&quot;, then the
# specified effective limit is only effective in that region, and the
# specified overrides apply only in that region.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;defaultLimit&quot;: &quot;A String&quot;, # The default limit of this quota bucket, as specified by the service
# configuration.
&quot;producerOverride&quot;: { # A quota override # Producer override on this quota bucket.
&quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example:
# &quot;organizations/12345&quot; or &quot;folders/67890&quot;.
# Used by admin overrides only.
&quot;dimensions&quot;: { #
# 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 &quot;region&quot; and the value &quot;us-east-1&quot;;
# 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&#x27;s unit are not valid keys.
# Any string appearing in {brackets} in the unit (besides {project} or
# {user}) is a defined key.
# * &quot;project&quot; is not a valid key; the project is already specified in
# the parent resource name.
# * &quot;user&quot; is not a valid key; the API does not support quota overrides
# that apply only to a specific user.
# * If &quot;region&quot; appears as a key, its value must be a valid Cloud region.
# * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone.
# * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then
# all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the
# map.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value.
# Can be any nonnegative integer, or -1 (unlimited quota).
&quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies.
#
# An example name would be:
# `compute.googleapis.com/cpus`
&quot;unit&quot;: &quot;A String&quot;, # 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.
&quot;name&quot;: &quot;A String&quot;, # The resource name of the producer override.
# An example name would be:
# `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`
},
&quot;consumerOverride&quot;: { # A quota override # Consumer override on this quota bucket.
&quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example:
# &quot;organizations/12345&quot; or &quot;folders/67890&quot;.
# Used by admin overrides only.
&quot;dimensions&quot;: { #
# 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 &quot;region&quot; and the value &quot;us-east-1&quot;;
# 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&#x27;s unit are not valid keys.
# Any string appearing in {brackets} in the unit (besides {project} or
# {user}) is a defined key.
# * &quot;project&quot; is not a valid key; the project is already specified in
# the parent resource name.
# * &quot;user&quot; is not a valid key; the API does not support quota overrides
# that apply only to a specific user.
# * If &quot;region&quot; appears as a key, its value must be a valid Cloud region.
# * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone.
# * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then
# all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the
# map.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value.
# Can be any nonnegative integer, or -1 (unlimited quota).
&quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies.
#
# An example name would be:
# `compute.googleapis.com/cpus`
&quot;unit&quot;: &quot;A String&quot;, # 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.
&quot;name&quot;: &quot;A String&quot;, # The resource name of the producer override.
# An example name would be:
# `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`
},
&quot;adminOverride&quot;: { # A quota override # Admin override on this quota bucket.
&quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example:
# &quot;organizations/12345&quot; or &quot;folders/67890&quot;.
# Used by admin overrides only.
&quot;dimensions&quot;: { #
# 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 &quot;region&quot; and the value &quot;us-east-1&quot;;
# 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&#x27;s unit are not valid keys.
# Any string appearing in {brackets} in the unit (besides {project} or
# {user}) is a defined key.
# * &quot;project&quot; is not a valid key; the project is already specified in
# the parent resource name.
# * &quot;user&quot; is not a valid key; the API does not support quota overrides
# that apply only to a specific user.
# * If &quot;region&quot; appears as a key, its value must be a valid Cloud region.
# * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone.
# * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then
# all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the
# map.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value.
# Can be any nonnegative integer, or -1 (unlimited quota).
&quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies.
#
# An example name would be:
# `compute.googleapis.com/cpus`
&quot;unit&quot;: &quot;A String&quot;, # 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.
&quot;name&quot;: &quot;A String&quot;, # The resource name of the producer override.
# An example name would be:
# `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`
},
},
],
}</pre>
</div>
</body></html>