blob: 0eae3b828a58b7364e7113c1986d4df4cd4e0a5b [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="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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="serviceconsumermanagement_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">
83 <code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
84<p class="firstline">Retrieves a summary of quota information for a specific quota metric.</p>
85<p class="toc_element">
86 <code><a href="#importProducerOverrides">importProducerOverrides(parent, body=None, x__xgafv=None)</a></code></p>
87<p class="firstline">Create or update multiple producer overrides atomically, all on the</p>
88<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070089 <code><a href="#list">list(parent, pageToken=None, pageSize=None, view=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070090<p class="firstline">Retrieves a summary of all quota information about this consumer that is</p>
91<p class="toc_element">
92 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
93<p class="firstline">Retrieves the next page of results.</p>
94<h3>Method Details</h3>
95<div class="method">
96 <code class="details" id="get">get(name, view=None, x__xgafv=None)</code>
97 <pre>Retrieves a summary of quota information for a specific quota metric.
98
99Args:
100 name: string, The resource name of the quota metric, returned by a
101ListConsumerQuotaMetrics call.
102
103An example name would be:
104`services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus` (required)
105 view: string, Specifies the level of detail for quota information in the response.
106 x__xgafv: string, V1 error format.
107 Allowed values
108 1 - v1 error format
109 2 - v2 error format
110
111Returns:
112 An object of the form:
113
114 { # Consumer quota settings for a quota metric.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700115 &quot;name&quot;: &quot;A String&quot;, # The resource name of the quota settings on this metric for this consumer.
116 #
117 # An example name would be:
118 # `services/serviceconsumermanagement.googleapis.com/projects/123/quota/metrics/compute.googleapis.com%2Fcpus
119 #
120 # The resource name is intended to be opaque and should not be parsed for
121 # its component strings, since its representation could change in the future.
122 &quot;unit&quot;: &quot;A String&quot;, # The units in which the metric value is reported.
123 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the metric.
124 #
125 # An example name would be:
126 # &quot;CPUs&quot;
Bu Sun Kim65020912020-05-20 12:08:20 -0700127 &quot;consumerQuotaLimits&quot;: [ # The consumer quota for each quota limit defined on the metric.
128 { # Consumer quota settings for a quota limit.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700129 &quot;unit&quot;: &quot;A String&quot;, # The limit unit.
130 #
131 # An example unit would be:
132 # `1/{project}/{region}`
133 # Note that `{project}` and `{region}` are not placeholders in this example;
134 # the literal characters `{` and `}` occur in the string.
135 &quot;metric&quot;: &quot;A String&quot;, # The name of the parent metric of this limit.
136 #
137 # An example name would be:
138 # `compute.googleapis.com/cpus`
Bu Sun Kim65020912020-05-20 12:08:20 -0700139 &quot;isPrecise&quot;: True or False, # Whether this limit is precise or imprecise.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700140 &quot;name&quot;: &quot;A String&quot;, # The resource name of the quota limit.
141 #
142 # An example name would be:
143 # `services/compute.googleapis.com/projects/123/quotas/metrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`
144 #
145 # The resource name is intended to be opaque and should not be parsed for
146 # its component strings, since its representation could change in the future.
Bu Sun Kim65020912020-05-20 12:08:20 -0700147 &quot;quotaBuckets&quot;: [ # Summary of the enforced quota buckets, organized by quota dimension,
148 # ordered from least specific to most specific (for example, the global
149 # default bucket, with no quota dimensions, will always appear first).
150 { # A quota bucket is a quota provisioning unit for a specific set of dimensions.
151 &quot;effectiveLimit&quot;: &quot;A String&quot;, # The effective limit of this quota bucket. Equal to default_limit if there
152 # are no overrides.
Bu Sun Kim65020912020-05-20 12:08:20 -0700153 &quot;dimensions&quot;: { # The dimensions of this quota bucket.
154 #
155 # If this map is empty, this is the global bucket, which is the default quota
156 # value applied to all requests that do not have a more specific override.
157 #
158 # If this map is nonempty, the default limit, effective limit, and quota
159 # overrides apply only to requests that have the dimensions given in the map.
160 #
161 # For example, if the map has key &quot;region&quot; and value &quot;us-east-1&quot;, then the
162 # specified effective limit is only effective in that region, and the
163 # specified overrides apply only in that region.
164 &quot;a_key&quot;: &quot;A String&quot;,
165 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700166 &quot;defaultLimit&quot;: &quot;A String&quot;, # The default limit of this quota bucket, as specified by the service
167 # configuration.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700168 &quot;producerOverride&quot;: { # A quota override # Producer override on this quota bucket.
169 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example:
170 # &quot;organizations/12345&quot; or &quot;folders/67890&quot;.
171 # Used by admin overrides only.
172 &quot;dimensions&quot;: { #
173 # If this map is nonempty, then this override applies only to specific values
174 # for dimensions defined in the limit unit.
175 #
176 # For example, an override on a limit with the unit 1/{project}/{region}
177 # could contain an entry with the key &quot;region&quot; and the value &quot;us-east-1&quot;;
178 # the override is only applied to quota consumed in that region.
179 #
180 # This map has the following restrictions:
181 #
182 # * Keys that are not defined in the limit&#x27;s unit are not valid keys.
183 # Any string appearing in {brackets} in the unit (besides {project} or
184 # {user}) is a defined key.
185 # * &quot;project&quot; is not a valid key; the project is already specified in
186 # the parent resource name.
187 # * &quot;user&quot; is not a valid key; the API does not support quota overrides
188 # that apply only to a specific user.
189 # * If &quot;region&quot; appears as a key, its value must be a valid Cloud region.
190 # * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone.
191 # * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then
192 # all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the
193 # map.
194 &quot;a_key&quot;: &quot;A String&quot;,
195 },
196 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value.
197 # Can be any nonnegative integer, or -1 (unlimited quota).
198 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies.
199 #
200 # An example name would be:
201 # `compute.googleapis.com/cpus`
202 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this override applies.
203 #
204 # An example unit would be:
205 # `1/{project}/{region}`
206 # Note that `{project}` and `{region}` are not placeholders in this example;
207 # the literal characters `{` and `}` occur in the string.
208 &quot;name&quot;: &quot;A String&quot;, # The resource name of the producer override.
209 # An example name would be:
210 # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`
211 },
212 &quot;consumerOverride&quot;: { # A quota override # Consumer override on this quota bucket.
213 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example:
214 # &quot;organizations/12345&quot; or &quot;folders/67890&quot;.
215 # Used by admin overrides only.
216 &quot;dimensions&quot;: { #
217 # If this map is nonempty, then this override applies only to specific values
218 # for dimensions defined in the limit unit.
219 #
220 # For example, an override on a limit with the unit 1/{project}/{region}
221 # could contain an entry with the key &quot;region&quot; and the value &quot;us-east-1&quot;;
222 # the override is only applied to quota consumed in that region.
223 #
224 # This map has the following restrictions:
225 #
226 # * Keys that are not defined in the limit&#x27;s unit are not valid keys.
227 # Any string appearing in {brackets} in the unit (besides {project} or
228 # {user}) is a defined key.
229 # * &quot;project&quot; is not a valid key; the project is already specified in
230 # the parent resource name.
231 # * &quot;user&quot; is not a valid key; the API does not support quota overrides
232 # that apply only to a specific user.
233 # * If &quot;region&quot; appears as a key, its value must be a valid Cloud region.
234 # * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone.
235 # * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then
236 # all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the
237 # map.
238 &quot;a_key&quot;: &quot;A String&quot;,
239 },
240 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value.
241 # Can be any nonnegative integer, or -1 (unlimited quota).
242 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies.
243 #
244 # An example name would be:
245 # `compute.googleapis.com/cpus`
246 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this override applies.
247 #
248 # An example unit would be:
249 # `1/{project}/{region}`
250 # Note that `{project}` and `{region}` are not placeholders in this example;
251 # the literal characters `{` and `}` occur in the string.
252 &quot;name&quot;: &quot;A String&quot;, # The resource name of the producer override.
253 # An example name would be:
254 # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`
255 },
256 &quot;adminOverride&quot;: { # A quota override # Admin override on this quota bucket.
257 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example:
258 # &quot;organizations/12345&quot; or &quot;folders/67890&quot;.
259 # Used by admin overrides only.
260 &quot;dimensions&quot;: { #
261 # If this map is nonempty, then this override applies only to specific values
262 # for dimensions defined in the limit unit.
263 #
264 # For example, an override on a limit with the unit 1/{project}/{region}
265 # could contain an entry with the key &quot;region&quot; and the value &quot;us-east-1&quot;;
266 # the override is only applied to quota consumed in that region.
267 #
268 # This map has the following restrictions:
269 #
270 # * Keys that are not defined in the limit&#x27;s unit are not valid keys.
271 # Any string appearing in {brackets} in the unit (besides {project} or
272 # {user}) is a defined key.
273 # * &quot;project&quot; is not a valid key; the project is already specified in
274 # the parent resource name.
275 # * &quot;user&quot; is not a valid key; the API does not support quota overrides
276 # that apply only to a specific user.
277 # * If &quot;region&quot; appears as a key, its value must be a valid Cloud region.
278 # * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone.
279 # * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then
280 # all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the
281 # map.
282 &quot;a_key&quot;: &quot;A String&quot;,
283 },
284 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value.
285 # Can be any nonnegative integer, or -1 (unlimited quota).
286 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies.
287 #
288 # An example name would be:
289 # `compute.googleapis.com/cpus`
290 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this override applies.
291 #
292 # An example unit would be:
293 # `1/{project}/{region}`
294 # Note that `{project}` and `{region}` are not placeholders in this example;
295 # the literal characters `{` and `}` occur in the string.
296 &quot;name&quot;: &quot;A String&quot;, # The resource name of the producer override.
297 # An example name would be:
298 # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`
299 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700300 },
301 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700302 },
303 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700304 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric.
305 #
306 # An example name would be:
307 # `compute.googleapis.com/cpus`
308 }</pre>
309</div>
310
311<div class="method">
312 <code class="details" id="importProducerOverrides">importProducerOverrides(parent, body=None, x__xgafv=None)</code>
313 <pre>Create or update multiple producer overrides atomically, all on the
314same consumer, but on many different metrics or limits.
315The name field in the quota override message should not be set.
316
317Args:
318 parent: string, The resource name of the consumer.
319
320An example name would be:
321`services/compute.googleapis.com/projects/123` (required)
322 body: object, The request body.
323 The object takes the form of:
324
325{ # Request message for ImportProducerOverrides
Bu Sun Kim65020912020-05-20 12:08:20 -0700326 &quot;inlineSource&quot;: { # Import data embedded in the request message # The import data is specified in the request message itself
327 &quot;overrides&quot;: [ # The overrides to create.
328 # Each override must have a value for &#x27;metric&#x27; and &#x27;unit&#x27;, to specify
329 # which metric and which limit the override should be applied to.
330 { # A quota override
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700331 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example:
332 # &quot;organizations/12345&quot; or &quot;folders/67890&quot;.
333 # Used by admin overrides only.
Bu Sun Kim65020912020-05-20 12:08:20 -0700334 &quot;dimensions&quot;: { #
335 # If this map is nonempty, then this override applies only to specific values
336 # for dimensions defined in the limit unit.
337 #
338 # For example, an override on a limit with the unit 1/{project}/{region}
339 # could contain an entry with the key &quot;region&quot; and the value &quot;us-east-1&quot;;
340 # the override is only applied to quota consumed in that region.
341 #
342 # This map has the following restrictions:
343 #
344 # * Keys that are not defined in the limit&#x27;s unit are not valid keys.
345 # Any string appearing in {brackets} in the unit (besides {project} or
346 # {user}) is a defined key.
347 # * &quot;project&quot; is not a valid key; the project is already specified in
348 # the parent resource name.
349 # * &quot;user&quot; is not a valid key; the API does not support quota overrides
350 # that apply only to a specific user.
351 # * If &quot;region&quot; appears as a key, its value must be a valid Cloud region.
352 # * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone.
353 # * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then
354 # all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the
355 # map.
356 &quot;a_key&quot;: &quot;A String&quot;,
357 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700358 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value.
359 # Can be any nonnegative integer, or -1 (unlimited quota).
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700360 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies.
361 #
362 # An example name would be:
363 # `compute.googleapis.com/cpus`
364 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this override applies.
365 #
366 # An example unit would be:
367 # `1/{project}/{region}`
368 # Note that `{project}` and `{region}` are not placeholders in this example;
369 # the literal characters `{` and `}` occur in the string.
370 &quot;name&quot;: &quot;A String&quot;, # The resource name of the producer override.
371 # An example name would be:
372 # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`
Bu Sun Kim65020912020-05-20 12:08:20 -0700373 },
374 ],
375 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700376 &quot;force&quot;: True or False, # Whether to force the creation of the quota overrides.
377 # If creating an override would cause the effective quota for the consumer to
378 # decrease by more than 10 percent, the call is rejected, as a safety measure
379 # to avoid accidentally decreasing quota too quickly. Setting the force
380 # parameter to true ignores this restriction.
Bu Sun Kim65020912020-05-20 12:08:20 -0700381 }
382
383 x__xgafv: string, V1 error format.
384 Allowed values
385 1 - v1 error format
386 2 - v2 error format
387
388Returns:
389 An object of the form:
390
391 { # This resource represents a long-running operation that is the result of a
392 # network API call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700393 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
394 # method returns no data on success, such as `Delete`, the response is
395 # `google.protobuf.Empty`. If the original method is standard
396 # `Get`/`Create`/`Update`, the response should be the resource. For other
397 # methods, the response should have the type `XxxResponse`, where `Xxx`
398 # is the original method name. For example, if the original method name
399 # is `TakeSnapshot()`, the inferred response type is
400 # `TakeSnapshotResponse`.
401 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
402 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700403 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
404 # If `true`, the operation is completed, and either `error` or `response` is
405 # available.
406 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
407 # originally returns it. If you use the default HTTP mapping, the
408 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700409 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
410 # different programming environments, including REST APIs and RPC APIs. It is
411 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
412 # three pieces of data: error code, error message, and error details.
413 #
414 # You can find out more about this error model and how to work with it in the
415 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700416 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
417 # user-facing error message should be localized and sent in the
418 # google.rpc.Status.details field, or localized by the client.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700419 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700420 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
421 # message types for APIs to use.
422 {
423 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
424 },
425 ],
426 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700427 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
428 # contains progress information and common metadata such as create time.
429 # Some services might not provide such metadata. Any method that returns a
430 # long-running operation should document the metadata type, if any.
431 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
432 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700433 }</pre>
434</div>
435
436<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700437 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, view=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700438 <pre>Retrieves a summary of all quota information about this consumer that is
439visible to the service producer, for each quota metric defined by the
440service. Each metric includes information about all of its defined limits.
441Each limit includes the limit configuration (quota unit, preciseness,
442default value), the current effective limit value, and all of the overrides
443applied to the limit.
444
445Args:
446 parent: string, Parent of the quotas resource.
447
448An example parent would be:
449`services/serviceconsumermanagement.googleapis.com/projects/123` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700450 pageToken: string, Token identifying which result to start with; returned by a previous list
451call.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700452 pageSize: integer, Requested size of the next page of data.
453 view: string, Specifies the level of detail for quota information in the response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700454 x__xgafv: string, V1 error format.
455 Allowed values
456 1 - v1 error format
457 2 - v2 error format
458
459Returns:
460 An object of the form:
461
462 { # Response message for ListConsumerQuotaMetrics.
463 &quot;metrics&quot;: [ # Quota settings for the consumer, organized by quota metric.
464 { # Consumer quota settings for a quota metric.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700465 &quot;name&quot;: &quot;A String&quot;, # The resource name of the quota settings on this metric for this consumer.
466 #
467 # An example name would be:
468 # `services/serviceconsumermanagement.googleapis.com/projects/123/quota/metrics/compute.googleapis.com%2Fcpus
469 #
470 # The resource name is intended to be opaque and should not be parsed for
471 # its component strings, since its representation could change in the future.
472 &quot;unit&quot;: &quot;A String&quot;, # The units in which the metric value is reported.
473 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the metric.
474 #
475 # An example name would be:
476 # &quot;CPUs&quot;
Bu Sun Kim65020912020-05-20 12:08:20 -0700477 &quot;consumerQuotaLimits&quot;: [ # The consumer quota for each quota limit defined on the metric.
478 { # Consumer quota settings for a quota limit.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700479 &quot;unit&quot;: &quot;A String&quot;, # The limit unit.
480 #
481 # An example unit would be:
482 # `1/{project}/{region}`
483 # Note that `{project}` and `{region}` are not placeholders in this example;
484 # the literal characters `{` and `}` occur in the string.
485 &quot;metric&quot;: &quot;A String&quot;, # The name of the parent metric of this limit.
486 #
487 # An example name would be:
488 # `compute.googleapis.com/cpus`
Bu Sun Kim65020912020-05-20 12:08:20 -0700489 &quot;isPrecise&quot;: True or False, # Whether this limit is precise or imprecise.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700490 &quot;name&quot;: &quot;A String&quot;, # The resource name of the quota limit.
491 #
492 # An example name would be:
493 # `services/compute.googleapis.com/projects/123/quotas/metrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion`
494 #
495 # The resource name is intended to be opaque and should not be parsed for
496 # its component strings, since its representation could change in the future.
Bu Sun Kim65020912020-05-20 12:08:20 -0700497 &quot;quotaBuckets&quot;: [ # Summary of the enforced quota buckets, organized by quota dimension,
498 # ordered from least specific to most specific (for example, the global
499 # default bucket, with no quota dimensions, will always appear first).
500 { # A quota bucket is a quota provisioning unit for a specific set of dimensions.
501 &quot;effectiveLimit&quot;: &quot;A String&quot;, # The effective limit of this quota bucket. Equal to default_limit if there
502 # are no overrides.
Bu Sun Kim65020912020-05-20 12:08:20 -0700503 &quot;dimensions&quot;: { # The dimensions of this quota bucket.
504 #
505 # If this map is empty, this is the global bucket, which is the default quota
506 # value applied to all requests that do not have a more specific override.
507 #
508 # If this map is nonempty, the default limit, effective limit, and quota
509 # overrides apply only to requests that have the dimensions given in the map.
510 #
511 # For example, if the map has key &quot;region&quot; and value &quot;us-east-1&quot;, then the
512 # specified effective limit is only effective in that region, and the
513 # specified overrides apply only in that region.
514 &quot;a_key&quot;: &quot;A String&quot;,
515 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700516 &quot;defaultLimit&quot;: &quot;A String&quot;, # The default limit of this quota bucket, as specified by the service
517 # configuration.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700518 &quot;producerOverride&quot;: { # A quota override # Producer override on this quota bucket.
519 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example:
520 # &quot;organizations/12345&quot; or &quot;folders/67890&quot;.
521 # Used by admin overrides only.
522 &quot;dimensions&quot;: { #
523 # If this map is nonempty, then this override applies only to specific values
524 # for dimensions defined in the limit unit.
525 #
526 # For example, an override on a limit with the unit 1/{project}/{region}
527 # could contain an entry with the key &quot;region&quot; and the value &quot;us-east-1&quot;;
528 # the override is only applied to quota consumed in that region.
529 #
530 # This map has the following restrictions:
531 #
532 # * Keys that are not defined in the limit&#x27;s unit are not valid keys.
533 # Any string appearing in {brackets} in the unit (besides {project} or
534 # {user}) is a defined key.
535 # * &quot;project&quot; is not a valid key; the project is already specified in
536 # the parent resource name.
537 # * &quot;user&quot; is not a valid key; the API does not support quota overrides
538 # that apply only to a specific user.
539 # * If &quot;region&quot; appears as a key, its value must be a valid Cloud region.
540 # * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone.
541 # * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then
542 # all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the
543 # map.
544 &quot;a_key&quot;: &quot;A String&quot;,
545 },
546 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value.
547 # Can be any nonnegative integer, or -1 (unlimited quota).
548 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies.
549 #
550 # An example name would be:
551 # `compute.googleapis.com/cpus`
552 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this override applies.
553 #
554 # An example unit would be:
555 # `1/{project}/{region}`
556 # Note that `{project}` and `{region}` are not placeholders in this example;
557 # the literal characters `{` and `}` occur in the string.
558 &quot;name&quot;: &quot;A String&quot;, # The resource name of the producer override.
559 # An example name would be:
560 # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`
561 },
562 &quot;consumerOverride&quot;: { # A quota override # Consumer override on this quota bucket.
563 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example:
564 # &quot;organizations/12345&quot; or &quot;folders/67890&quot;.
565 # Used by admin overrides only.
566 &quot;dimensions&quot;: { #
567 # If this map is nonempty, then this override applies only to specific values
568 # for dimensions defined in the limit unit.
569 #
570 # For example, an override on a limit with the unit 1/{project}/{region}
571 # could contain an entry with the key &quot;region&quot; and the value &quot;us-east-1&quot;;
572 # the override is only applied to quota consumed in that region.
573 #
574 # This map has the following restrictions:
575 #
576 # * Keys that are not defined in the limit&#x27;s unit are not valid keys.
577 # Any string appearing in {brackets} in the unit (besides {project} or
578 # {user}) is a defined key.
579 # * &quot;project&quot; is not a valid key; the project is already specified in
580 # the parent resource name.
581 # * &quot;user&quot; is not a valid key; the API does not support quota overrides
582 # that apply only to a specific user.
583 # * If &quot;region&quot; appears as a key, its value must be a valid Cloud region.
584 # * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone.
585 # * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then
586 # all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the
587 # map.
588 &quot;a_key&quot;: &quot;A String&quot;,
589 },
590 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value.
591 # Can be any nonnegative integer, or -1 (unlimited quota).
592 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies.
593 #
594 # An example name would be:
595 # `compute.googleapis.com/cpus`
596 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this override applies.
597 #
598 # An example unit would be:
599 # `1/{project}/{region}`
600 # Note that `{project}` and `{region}` are not placeholders in this example;
601 # the literal characters `{` and `}` occur in the string.
602 &quot;name&quot;: &quot;A String&quot;, # The resource name of the producer override.
603 # An example name would be:
604 # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`
605 },
606 &quot;adminOverride&quot;: { # A quota override # Admin override on this quota bucket.
607 &quot;adminOverrideAncestor&quot;: &quot;A String&quot;, # The resource name of the ancestor that requested the override. For example:
608 # &quot;organizations/12345&quot; or &quot;folders/67890&quot;.
609 # Used by admin overrides only.
610 &quot;dimensions&quot;: { #
611 # If this map is nonempty, then this override applies only to specific values
612 # for dimensions defined in the limit unit.
613 #
614 # For example, an override on a limit with the unit 1/{project}/{region}
615 # could contain an entry with the key &quot;region&quot; and the value &quot;us-east-1&quot;;
616 # the override is only applied to quota consumed in that region.
617 #
618 # This map has the following restrictions:
619 #
620 # * Keys that are not defined in the limit&#x27;s unit are not valid keys.
621 # Any string appearing in {brackets} in the unit (besides {project} or
622 # {user}) is a defined key.
623 # * &quot;project&quot; is not a valid key; the project is already specified in
624 # the parent resource name.
625 # * &quot;user&quot; is not a valid key; the API does not support quota overrides
626 # that apply only to a specific user.
627 # * If &quot;region&quot; appears as a key, its value must be a valid Cloud region.
628 # * If &quot;zone&quot; appears as a key, its value must be a valid Cloud zone.
629 # * If any valid key other than &quot;region&quot; or &quot;zone&quot; appears in the map, then
630 # all valid keys other than &quot;region&quot; or &quot;zone&quot; must also appear in the
631 # map.
632 &quot;a_key&quot;: &quot;A String&quot;,
633 },
634 &quot;overrideValue&quot;: &quot;A String&quot;, # The overriding quota limit value.
635 # Can be any nonnegative integer, or -1 (unlimited quota).
636 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric to which this override applies.
637 #
638 # An example name would be:
639 # `compute.googleapis.com/cpus`
640 &quot;unit&quot;: &quot;A String&quot;, # The limit unit of the limit to which this override applies.
641 #
642 # An example unit would be:
643 # `1/{project}/{region}`
644 # Note that `{project}` and `{region}` are not placeholders in this example;
645 # the literal characters `{` and `}` occur in the string.
646 &quot;name&quot;: &quot;A String&quot;, # The resource name of the producer override.
647 # An example name would be:
648 # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d`
649 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700650 },
651 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700652 },
653 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700654 &quot;metric&quot;: &quot;A String&quot;, # The name of the metric.
655 #
656 # An example name would be:
657 # `compute.googleapis.com/cpus`
658 },
659 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700660 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token identifying which result to start with; returned by a previous list
661 # call.
Bu Sun Kim65020912020-05-20 12:08:20 -0700662 }</pre>
663</div>
664
665<div class="method">
666 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
667 <pre>Retrieves the next page of results.
668
669Args:
670 previous_request: The request for the previous page. (required)
671 previous_response: The response from the request for the previous page. (required)
672
673Returns:
674 A request object that you can call &#x27;execute()&#x27; on to request the next
675 page. Returns None if there are no more items in the collection.
676 </pre>
677</div>
678
679</body></html>