blob: cbb7d4720ebd4390043f7ea6bd4dba97683f7e46 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="serviceusage_v1beta1.html">Service Usage API</a> . <a href="serviceusage_v1beta1.services.html">services</a> . <a href="serviceusage_v1beta1.services.consumerQuotaMetrics.html">consumerQuotaMetrics</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="serviceusage_v1beta1.services.consumerQuotaMetrics.limits.html">limits()</a></code>
79</p>
80<p class="firstline">Returns the limits Resource.</p>
81
82<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070083 <code><a href="#close">close()</a></code></p>
84<p class="firstline">Close httplib2 connections.</p>
85<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070086 <code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
87<p class="firstline">Retrieves a summary of quota information for a specific quota metric</p>
88<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070089 <code><a href="#importAdminOverrides">importAdminOverrides(parent, body=None, x__xgafv=None)</a></code></p>
yoshi-code-botf0c2fa62021-04-23 08:24:04 -070090<p class="firstline">Creates or updates multiple admin overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.</p>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070091<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070092 <code><a href="#importConsumerOverrides">importConsumerOverrides(parent, body=None, x__xgafv=None)</a></code></p>
yoshi-code-botf0c2fa62021-04-23 08:24:04 -070093<p class="firstline">Creates or updates multiple consumer overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.</p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070094<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080095 <code><a href="#list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070096<p class="firstline">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 configuration (quota unit, preciseness, default value), the current effective limit value, and all of the overrides applied to the limit.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070097<p class="toc_element">
98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
99<p class="firstline">Retrieves the next page of results.</p>
100<h3>Method Details</h3>
101<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700102 <code class="details" id="close">close()</code>
103 <pre>Close httplib2 connections.</pre>
104</div>
105
106<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700107 <code class="details" id="get">get(name, view=None, x__xgafv=None)</code>
108 <pre>Retrieves a summary of quota information for a specific quota metric
109
110Args:
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700111 name: string, The resource name of the quota limit. An example name would be: `projects/123/services/serviceusage.googleapis.com/quotas/metrics/serviceusage.googleapis.com%2Fmutate_requests` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700112 view: string, Specifies the level of detail for quota information in the response.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700113 Allowed values
114 QUOTA_VIEW_UNSPECIFIED - No quota view specified. Requests that do not specify a quota view will typically default to the BASIC view.
115 BASIC - Only buckets with overrides are shown in the response.
116 FULL - Include per-location buckets even if they do not have overrides. When the view is FULL, and a limit has regional or zonal quota, the limit will include buckets for all regions or zones that could support overrides, even if none are currently present. In some cases this will cause the response to become very large; callers that do not need this extra information should use the BASIC view instead.
Bu Sun Kim65020912020-05-20 12:08:20 -0700117 x__xgafv: string, V1 error format.
118 Allowed values
119 1 - v1 error format
120 2 - v2 error format
121
122Returns:
123 An object of the form:
124
125 { # Consumer quota settings for a quota metric.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800126 &quot;consumerQuotaLimits&quot;: [ # The consumer quota for each quota limit defined on the metric.
127 { # Consumer quota settings for a quota limit.
128 &quot;allowsAdminOverrides&quot;: True or False, # Whether admin overrides are allowed on this limit
129 &quot;isPrecise&quot;: True or False, # Whether this limit is precise or imprecise.
130 &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`
131 &quot;name&quot;: &quot;A String&quot;, # 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.
132 &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).
133 { # A quota bucket is a quota provisioning unit for a specific set of dimensions.
134 &quot;adminOverride&quot;: { # A quota override # Admin override on this quota bucket.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700135 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only.
136 &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 `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&#x27;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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800137 &quot;a_key&quot;: &quot;A String&quot;,
138 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800139 &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`
140 &quot;name&quot;: &quot;A String&quot;, # 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.
141 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
142 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700143 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800144 &quot;consumerOverride&quot;: { # A quota override # Consumer override on this quota bucket.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700145 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only.
146 &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 `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&#x27;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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800147 &quot;a_key&quot;: &quot;A String&quot;,
148 },
149 &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`
150 &quot;name&quot;: &quot;A String&quot;, # 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.
151 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
152 &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.
153 },
154 &quot;defaultLimit&quot;: &quot;A String&quot;, # The default limit of this quota bucket, as specified by the service configuration.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700155 &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 `region` and value `us-east-1`, then the specified effective limit is only effective in that region, and the specified overrides apply only in that region.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800156 &quot;a_key&quot;: &quot;A String&quot;,
157 },
158 &quot;effectiveLimit&quot;: &quot;A String&quot;, # The effective limit of this quota bucket. Equal to default_limit if there are no overrides.
159 &quot;producerOverride&quot;: { # A quota override # Producer override on this quota bucket.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700160 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only.
161 &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 `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&#x27;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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800162 &quot;a_key&quot;: &quot;A String&quot;,
163 },
164 &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`
165 &quot;name&quot;: &quot;A String&quot;, # 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.
166 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
167 &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.
168 },
169 },
170 ],
171 &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.
172 },
173 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800174 &quot;descendantConsumerQuotaLimits&quot;: [ # The quota limits targeting the descendant containers of the consumer in request. If the consumer in request is of type `organizations` or `folders`, the field will list per-project limits in the metric; if the consumer in request is of type `project`, the field will be empty. The `quota_buckets` field of each descendant consumer quota limit will not be populated.
175 { # Consumer quota settings for a quota limit.
176 &quot;allowsAdminOverrides&quot;: True or False, # Whether admin overrides are allowed on this limit
177 &quot;isPrecise&quot;: True or False, # Whether this limit is precise or imprecise.
178 &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`
179 &quot;name&quot;: &quot;A String&quot;, # 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.
180 &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).
181 { # A quota bucket is a quota provisioning unit for a specific set of dimensions.
182 &quot;adminOverride&quot;: { # A quota override # Admin override on this quota bucket.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700183 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only.
184 &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 `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&#x27;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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800185 &quot;a_key&quot;: &quot;A String&quot;,
186 },
187 &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`
188 &quot;name&quot;: &quot;A String&quot;, # 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.
189 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
190 &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.
191 },
192 &quot;consumerOverride&quot;: { # A quota override # Consumer override on this quota bucket.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700193 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only.
194 &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 `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&#x27;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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800195 &quot;a_key&quot;: &quot;A String&quot;,
196 },
197 &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`
198 &quot;name&quot;: &quot;A String&quot;, # 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.
199 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
200 &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.
201 },
202 &quot;defaultLimit&quot;: &quot;A String&quot;, # The default limit of this quota bucket, as specified by the service configuration.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700203 &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 `region` and value `us-east-1`, then the specified effective limit is only effective in that region, and the specified overrides apply only in that region.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800204 &quot;a_key&quot;: &quot;A String&quot;,
205 },
206 &quot;effectiveLimit&quot;: &quot;A String&quot;, # The effective limit of this quota bucket. Equal to default_limit if there are no overrides.
207 &quot;producerOverride&quot;: { # A quota override # Producer override on this quota bucket.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700208 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only.
209 &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 `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&#x27;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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800210 &quot;a_key&quot;: &quot;A String&quot;,
211 },
212 &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`
213 &quot;name&quot;: &quot;A String&quot;, # 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.
214 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
215 &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.
216 },
217 },
218 ],
219 &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.
220 },
221 ],
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700222 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the metric. An example name would be: `CPUs`
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800223 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric. An example name would be: `compute.googleapis.com/cpus`
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700224 &quot;name&quot;: &quot;A String&quot;, # The resource name of the quota settings on this metric for this consumer. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus` 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800225 &quot;unit&quot;: &quot;A String&quot;, # The units in which the metric value is reported.
226}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700227</div>
228
229<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700230 <code class="details" id="importAdminOverrides">importAdminOverrides(parent, body=None, x__xgafv=None)</code>
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700231 <pre>Creates or updates multiple admin overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700232
233Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700234 parent: string, The resource name of the consumer. An example name would be: `projects/123/services/compute.googleapis.com` (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700235 body: object, The request body.
236 The object takes the form of:
237
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700238{ # Request message for ImportAdminOverrides
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800239 &quot;force&quot;: True or False, # Whether to force the creation of the quota overrides. Setting the force parameter to &#x27;true&#x27; ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.
240 &quot;forceOnly&quot;: [ # The list of quota safety checks to ignore before the override mutation. Unlike &#x27;force&#x27; field that ignores all the quota safety checks, the &#x27;force_only&#x27; field ignores only the specified checks; other checks are still enforced. The &#x27;force&#x27; and &#x27;force_only&#x27; fields cannot both be set.
241 &quot;A String&quot;,
242 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800243 &quot;inlineSource&quot;: { # Import data embedded in the request message # The import data is specified in the request message itself
244 &quot;overrides&quot;: [ # The overrides to create. Each override must have a value for &#x27;metric&#x27; and &#x27;unit&#x27;, to specify which metric and which limit the override should be applied to. The &#x27;name&#x27; field of the override does not need to be set; it is ignored.
245 { # A quota override
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700246 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only.
247 &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 `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&#x27;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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800248 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700249 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800250 &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`
251 &quot;name&quot;: &quot;A String&quot;, # 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.
252 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
253 &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.
254 },
255 ],
256 },
257}
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700258
259 x__xgafv: string, V1 error format.
260 Allowed values
261 1 - v1 error format
262 2 - v2 error format
263
264Returns:
265 An object of the form:
266
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700267 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800268 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
269 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
270 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
271 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
272 {
273 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
274 },
275 ],
276 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
277 },
278 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
279 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
280 },
281 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
282 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
283 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
284 },
285}</pre>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700286</div>
287
288<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700289 <code class="details" id="importConsumerOverrides">importConsumerOverrides(parent, body=None, x__xgafv=None)</code>
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700290 <pre>Creates or updates multiple consumer overrides atomically, all on the same consumer, but on many different metrics or limits. The name field in the quota override message should not be set.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700291
292Args:
293 parent: string, The resource name of the consumer. An example name would be: `projects/123/services/compute.googleapis.com` (required)
294 body: object, The request body.
295 The object takes the form of:
296
297{ # Request message for ImportConsumerOverrides
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800298 &quot;force&quot;: True or False, # Whether to force the creation of the quota overrides. Setting the force parameter to &#x27;true&#x27; ignores all quota safety checks that would fail the request. QuotaSafetyCheck lists all such validations.
299 &quot;forceOnly&quot;: [ # The list of quota safety checks to ignore before the override mutation. Unlike &#x27;force&#x27; field that ignores all the quota safety checks, the &#x27;force_only&#x27; field ignores only the specified checks; other checks are still enforced. The &#x27;force&#x27; and &#x27;force_only&#x27; fields cannot both be set.
300 &quot;A String&quot;,
301 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800302 &quot;inlineSource&quot;: { # Import data embedded in the request message # The import data is specified in the request message itself
303 &quot;overrides&quot;: [ # The overrides to create. Each override must have a value for &#x27;metric&#x27; and &#x27;unit&#x27;, to specify which metric and which limit the override should be applied to. The &#x27;name&#x27; field of the override does not need to be set; it is ignored.
304 { # A quota override
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700305 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only.
306 &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 `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&#x27;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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800307 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700308 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800309 &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`
310 &quot;name&quot;: &quot;A String&quot;, # 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.
311 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
312 &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.
313 },
314 ],
315 },
316}
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700317
318 x__xgafv: string, V1 error format.
319 Allowed values
320 1 - v1 error format
321 2 - v2 error format
322
323Returns:
324 An object of the form:
325
326 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800327 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
328 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
329 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
330 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
331 {
332 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
333 },
334 ],
335 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
336 },
337 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
338 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
339 },
340 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
341 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
342 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
343 },
344}</pre>
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700345</div>
346
347<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800348 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700349 <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 configuration (quota unit, preciseness, default value), the current effective limit value, and all of the overrides applied to the limit.
Bu Sun Kim65020912020-05-20 12:08:20 -0700350
351Args:
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700352 parent: string, Parent of the quotas resource. Some example names would be: `projects/123/services/serviceconsumermanagement.googleapis.com` `folders/345/services/serviceconsumermanagement.googleapis.com` `organizations/456/services/serviceconsumermanagement.googleapis.com` (required)
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800353 pageSize: integer, Requested size of the next page of data.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800354 pageToken: string, Token identifying which result to start with; returned by a previous list call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700355 view: string, Specifies the level of detail for quota information in the response.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700356 Allowed values
357 QUOTA_VIEW_UNSPECIFIED - No quota view specified. Requests that do not specify a quota view will typically default to the BASIC view.
358 BASIC - Only buckets with overrides are shown in the response.
359 FULL - Include per-location buckets even if they do not have overrides. When the view is FULL, and a limit has regional or zonal quota, the limit will include buckets for all regions or zones that could support overrides, even if none are currently present. In some cases this will cause the response to become very large; callers that do not need this extra information should use the BASIC view instead.
Bu Sun Kim65020912020-05-20 12:08:20 -0700360 x__xgafv: string, V1 error format.
361 Allowed values
362 1 - v1 error format
363 2 - v2 error format
364
365Returns:
366 An object of the form:
367
368 { # Response message for ListConsumerQuotaMetrics
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800369 &quot;metrics&quot;: [ # Quota settings for the consumer, organized by quota metric.
370 { # Consumer quota settings for a quota metric.
371 &quot;consumerQuotaLimits&quot;: [ # The consumer quota for each quota limit defined on the metric.
372 { # Consumer quota settings for a quota limit.
373 &quot;allowsAdminOverrides&quot;: True or False, # Whether admin overrides are allowed on this limit
374 &quot;isPrecise&quot;: True or False, # Whether this limit is precise or imprecise.
375 &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`
376 &quot;name&quot;: &quot;A String&quot;, # 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.
377 &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).
378 { # A quota bucket is a quota provisioning unit for a specific set of dimensions.
379 &quot;adminOverride&quot;: { # A quota override # Admin override on this quota bucket.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700380 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only.
381 &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 `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&#x27;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.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800382 &quot;a_key&quot;: &quot;A String&quot;,
383 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800384 &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`
385 &quot;name&quot;: &quot;A String&quot;, # 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.
386 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
387 &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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700388 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800389 &quot;consumerOverride&quot;: { # A quota override # Consumer override on this quota bucket.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700390 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only.
391 &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 `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&#x27;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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800392 &quot;a_key&quot;: &quot;A String&quot;,
393 },
394 &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`
395 &quot;name&quot;: &quot;A String&quot;, # 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.
396 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
397 &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.
398 },
399 &quot;defaultLimit&quot;: &quot;A String&quot;, # The default limit of this quota bucket, as specified by the service configuration.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700400 &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 `region` and value `us-east-1`, then the specified effective limit is only effective in that region, and the specified overrides apply only in that region.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800401 &quot;a_key&quot;: &quot;A String&quot;,
402 },
403 &quot;effectiveLimit&quot;: &quot;A String&quot;, # The effective limit of this quota bucket. Equal to default_limit if there are no overrides.
404 &quot;producerOverride&quot;: { # A quota override # Producer override on this quota bucket.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700405 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only.
406 &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 `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&#x27;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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800407 &quot;a_key&quot;: &quot;A String&quot;,
408 },
409 &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`
410 &quot;name&quot;: &quot;A String&quot;, # 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.
411 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
412 &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.
413 },
414 },
415 ],
416 &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.
417 },
418 ],
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800419 &quot;descendantConsumerQuotaLimits&quot;: [ # The quota limits targeting the descendant containers of the consumer in request. If the consumer in request is of type `organizations` or `folders`, the field will list per-project limits in the metric; if the consumer in request is of type `project`, the field will be empty. The `quota_buckets` field of each descendant consumer quota limit will not be populated.
420 { # Consumer quota settings for a quota limit.
421 &quot;allowsAdminOverrides&quot;: True or False, # Whether admin overrides are allowed on this limit
422 &quot;isPrecise&quot;: True or False, # Whether this limit is precise or imprecise.
423 &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`
424 &quot;name&quot;: &quot;A String&quot;, # 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.
425 &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).
426 { # A quota bucket is a quota provisioning unit for a specific set of dimensions.
427 &quot;adminOverride&quot;: { # A quota override # Admin override on this quota bucket.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700428 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only.
429 &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 `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&#x27;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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800430 &quot;a_key&quot;: &quot;A String&quot;,
431 },
432 &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`
433 &quot;name&quot;: &quot;A String&quot;, # 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.
434 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
435 &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.
436 },
437 &quot;consumerOverride&quot;: { # A quota override # Consumer override on this quota bucket.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700438 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only.
439 &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 `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&#x27;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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800440 &quot;a_key&quot;: &quot;A String&quot;,
441 },
442 &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`
443 &quot;name&quot;: &quot;A String&quot;, # 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.
444 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
445 &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.
446 },
447 &quot;defaultLimit&quot;: &quot;A String&quot;, # The default limit of this quota bucket, as specified by the service configuration.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700448 &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 `region` and value `us-east-1`, then the specified effective limit is only effective in that region, and the specified overrides apply only in that region.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800449 &quot;a_key&quot;: &quot;A String&quot;,
450 },
451 &quot;effectiveLimit&quot;: &quot;A String&quot;, # The effective limit of this quota bucket. Equal to default_limit if there are no overrides.
452 &quot;producerOverride&quot;: { # A quota override # Producer override on this quota bucket.
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700453 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only.
454 &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 `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&#x27;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.
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800455 &quot;a_key&quot;: &quot;A String&quot;,
456 },
457 &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`
458 &quot;name&quot;: &quot;A String&quot;, # 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.
459 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).
460 &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.
461 },
462 },
463 ],
464 &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.
465 },
466 ],
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700467 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the metric. An example name would be: `CPUs`
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800468 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric. An example name would be: `compute.googleapis.com/cpus`
yoshi-code-botf0c2fa62021-04-23 08:24:04 -0700469 &quot;name&quot;: &quot;A String&quot;, # The resource name of the quota settings on this metric for this consumer. An example name would be: `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus` 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800470 &quot;unit&quot;: &quot;A String&quot;, # The units in which the metric value is reported.
471 },
472 ],
473 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token identifying which result to start with; returned by a previous list call.
474}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700475</div>
476
477<div class="method">
478 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
479 <pre>Retrieves the next page of results.
480
481Args:
482 previous_request: The request for the previous page. (required)
483 previous_response: The response from the request for the previous page. (required)
484
485Returns:
486 A request object that you can call &#x27;execute()&#x27; on to request the next
487 page. Returns None if there are no more items in the collection.
488 </pre>
489</div>
490
491</body></html>