| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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 Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 89 | <code><a href="#list">list(parent, pageSize=None, view=None, pageToken=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 90 | <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 | |
| 99 | Args: |
| 100 | name: string, The resource name of the quota metric, returned by a |
| 101 | ListConsumerQuotaMetrics call. |
| 102 | |
| 103 | An 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 | |
| 111 | Returns: |
| 112 | An object of the form: |
| 113 | |
| 114 | { # Consumer quota settings for a quota metric. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 115 | "consumerQuotaLimits": [ # The consumer quota for each quota limit defined on the metric. |
| 116 | { # Consumer quota settings for a quota limit. |
| 117 | "isPrecise": True or False, # Whether this limit is precise or imprecise. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 118 | "name": "A String", # The resource name of the quota limit. |
| 119 | # |
| 120 | # An example name would be: |
| 121 | # `services/compute.googleapis.com/projects/123/quotas/metrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` |
| 122 | # |
| 123 | # The resource name is intended to be opaque and should not be parsed for |
| 124 | # its component strings, since its representation could change in the future. |
| 125 | "metric": "A String", # The name of the parent metric of this limit. |
| 126 | # |
| 127 | # An example name would be: |
| 128 | # `compute.googleapis.com/cpus` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 129 | "quotaBuckets": [ # Summary of the enforced quota buckets, organized by quota dimension, |
| 130 | # ordered from least specific to most specific (for example, the global |
| 131 | # default bucket, with no quota dimensions, will always appear first). |
| 132 | { # A quota bucket is a quota provisioning unit for a specific set of dimensions. |
| 133 | "effectiveLimit": "A String", # The effective limit of this quota bucket. Equal to default_limit if there |
| 134 | # are no overrides. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 135 | "adminOverride": { # A quota override # Admin override on this quota bucket. |
| 136 | "name": "A String", # The resource name of the producer override. |
| 137 | # An example name would be: |
| 138 | # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` |
| 139 | "unit": "A String", # The limit unit of the limit to which this override applies. |
| 140 | # |
| 141 | # An example unit would be: |
| 142 | # `1/{project}/{region}` |
| 143 | # Note that `{project}` and `{region}` are not placeholders in this example; |
| 144 | # the literal characters `{` and `}` occur in the string. |
| 145 | "metric": "A String", # The name of the metric to which this override applies. |
| 146 | # |
| 147 | # An example name would be: |
| 148 | # `compute.googleapis.com/cpus` |
| 149 | "dimensions": { # |
| 150 | # If this map is nonempty, then this override applies only to specific values |
| 151 | # for dimensions defined in the limit unit. |
| 152 | # |
| 153 | # For example, an override on a limit with the unit 1/{project}/{region} |
| 154 | # could contain an entry with the key "region" and the value "us-east-1"; |
| 155 | # the override is only applied to quota consumed in that region. |
| 156 | # |
| 157 | # This map has the following restrictions: |
| 158 | # |
| 159 | # * Keys that are not defined in the limit's unit are not valid keys. |
| 160 | # Any string appearing in {brackets} in the unit (besides {project} or |
| 161 | # {user}) is a defined key. |
| 162 | # * "project" is not a valid key; the project is already specified in |
| 163 | # the parent resource name. |
| 164 | # * "user" is not a valid key; the API does not support quota overrides |
| 165 | # that apply only to a specific user. |
| 166 | # * If "region" appears as a key, its value must be a valid Cloud region. |
| 167 | # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| 168 | # * If any valid key other than "region" or "zone" appears in the map, then |
| 169 | # all valid keys other than "region" or "zone" must also appear in the |
| 170 | # map. |
| 171 | "a_key": "A String", |
| 172 | }, |
| 173 | "overrideValue": "A String", # The overriding quota limit value. |
| 174 | # Can be any nonnegative integer, or -1 (unlimited quota). |
| 175 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 176 | "dimensions": { # The dimensions of this quota bucket. |
| 177 | # |
| 178 | # If this map is empty, this is the global bucket, which is the default quota |
| 179 | # value applied to all requests that do not have a more specific override. |
| 180 | # |
| 181 | # If this map is nonempty, the default limit, effective limit, and quota |
| 182 | # overrides apply only to requests that have the dimensions given in the map. |
| 183 | # |
| 184 | # For example, if the map has key "region" and value "us-east-1", then the |
| 185 | # specified effective limit is only effective in that region, and the |
| 186 | # specified overrides apply only in that region. |
| 187 | "a_key": "A String", |
| 188 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 189 | "producerOverride": { # A quota override # Producer override on this quota bucket. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 190 | "name": "A String", # The resource name of the producer override. |
| 191 | # An example name would be: |
| 192 | # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 193 | "unit": "A String", # The limit unit of the limit to which this override applies. |
| 194 | # |
| 195 | # An example unit would be: |
| 196 | # `1/{project}/{region}` |
| 197 | # Note that `{project}` and `{region}` are not placeholders in this example; |
| 198 | # the literal characters `{` and `}` occur in the string. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 199 | "metric": "A String", # The name of the metric to which this override applies. |
| 200 | # |
| 201 | # An example name would be: |
| 202 | # `compute.googleapis.com/cpus` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 203 | "dimensions": { # |
| 204 | # If this map is nonempty, then this override applies only to specific values |
| 205 | # for dimensions defined in the limit unit. |
| 206 | # |
| 207 | # For example, an override on a limit with the unit 1/{project}/{region} |
| 208 | # could contain an entry with the key "region" and the value "us-east-1"; |
| 209 | # the override is only applied to quota consumed in that region. |
| 210 | # |
| 211 | # This map has the following restrictions: |
| 212 | # |
| 213 | # * Keys that are not defined in the limit's unit are not valid keys. |
| 214 | # Any string appearing in {brackets} in the unit (besides {project} or |
| 215 | # {user}) is a defined key. |
| 216 | # * "project" is not a valid key; the project is already specified in |
| 217 | # the parent resource name. |
| 218 | # * "user" is not a valid key; the API does not support quota overrides |
| 219 | # that apply only to a specific user. |
| 220 | # * If "region" appears as a key, its value must be a valid Cloud region. |
| 221 | # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| 222 | # * If any valid key other than "region" or "zone" appears in the map, then |
| 223 | # all valid keys other than "region" or "zone" must also appear in the |
| 224 | # map. |
| 225 | "a_key": "A String", |
| 226 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 227 | "overrideValue": "A String", # The overriding quota limit value. |
| 228 | # Can be any nonnegative integer, or -1 (unlimited quota). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 229 | }, |
| 230 | "consumerOverride": { # A quota override # Consumer override on this quota bucket. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 231 | "name": "A String", # The resource name of the producer override. |
| 232 | # An example name would be: |
| 233 | # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 234 | "unit": "A String", # The limit unit of the limit to which this override applies. |
| 235 | # |
| 236 | # An example unit would be: |
| 237 | # `1/{project}/{region}` |
| 238 | # Note that `{project}` and `{region}` are not placeholders in this example; |
| 239 | # the literal characters `{` and `}` occur in the string. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 240 | "metric": "A String", # The name of the metric to which this override applies. |
| 241 | # |
| 242 | # An example name would be: |
| 243 | # `compute.googleapis.com/cpus` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 244 | "dimensions": { # |
| 245 | # If this map is nonempty, then this override applies only to specific values |
| 246 | # for dimensions defined in the limit unit. |
| 247 | # |
| 248 | # For example, an override on a limit with the unit 1/{project}/{region} |
| 249 | # could contain an entry with the key "region" and the value "us-east-1"; |
| 250 | # the override is only applied to quota consumed in that region. |
| 251 | # |
| 252 | # This map has the following restrictions: |
| 253 | # |
| 254 | # * Keys that are not defined in the limit's unit are not valid keys. |
| 255 | # Any string appearing in {brackets} in the unit (besides {project} or |
| 256 | # {user}) is a defined key. |
| 257 | # * "project" is not a valid key; the project is already specified in |
| 258 | # the parent resource name. |
| 259 | # * "user" is not a valid key; the API does not support quota overrides |
| 260 | # that apply only to a specific user. |
| 261 | # * If "region" appears as a key, its value must be a valid Cloud region. |
| 262 | # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| 263 | # * If any valid key other than "region" or "zone" appears in the map, then |
| 264 | # all valid keys other than "region" or "zone" must also appear in the |
| 265 | # map. |
| 266 | "a_key": "A String", |
| 267 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 268 | "overrideValue": "A String", # The overriding quota limit value. |
| 269 | # Can be any nonnegative integer, or -1 (unlimited quota). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 270 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 271 | "defaultLimit": "A String", # The default limit of this quota bucket, as specified by the service |
| 272 | # configuration. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 273 | }, |
| 274 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 275 | "unit": "A String", # The limit unit. |
| 276 | # |
| 277 | # An example unit would be: |
| 278 | # `1/{project}/{region}` |
| 279 | # Note that `{project}` and `{region}` are not placeholders in this example; |
| 280 | # the literal characters `{` and `}` occur in the string. |
| 281 | }, |
| 282 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 283 | "displayName": "A String", # The display name of the metric. |
| 284 | # |
| 285 | # An example name would be: |
| 286 | # "CPUs" |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 287 | "name": "A String", # The resource name of the quota settings on this metric for this consumer. |
| 288 | # |
| 289 | # An example name would be: |
| 290 | # `services/serviceconsumermanagement.googleapis.com/projects/123/quota/metrics/compute.googleapis.com%2Fcpus |
| 291 | # |
| 292 | # The resource name is intended to be opaque and should not be parsed for |
| 293 | # its component strings, since its representation could change in the future. |
| 294 | "metric": "A String", # The name of the metric. |
| 295 | # |
| 296 | # An example name would be: |
| 297 | # `compute.googleapis.com/cpus` |
| 298 | }</pre> |
| 299 | </div> |
| 300 | |
| 301 | <div class="method"> |
| 302 | <code class="details" id="importProducerOverrides">importProducerOverrides(parent, body=None, x__xgafv=None)</code> |
| 303 | <pre>Create or update multiple producer overrides atomically, all on the |
| 304 | same consumer, but on many different metrics or limits. |
| 305 | The name field in the quota override message should not be set. |
| 306 | |
| 307 | Args: |
| 308 | parent: string, The resource name of the consumer. |
| 309 | |
| 310 | An example name would be: |
| 311 | `services/compute.googleapis.com/projects/123` (required) |
| 312 | body: object, The request body. |
| 313 | The object takes the form of: |
| 314 | |
| 315 | { # Request message for ImportProducerOverrides |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 316 | "inlineSource": { # Import data embedded in the request message # The import data is specified in the request message itself |
| 317 | "overrides": [ # The overrides to create. |
| 318 | # Each override must have a value for 'metric' and 'unit', to specify |
| 319 | # which metric and which limit the override should be applied to. |
| 320 | { # A quota override |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 321 | "name": "A String", # The resource name of the producer override. |
| 322 | # An example name would be: |
| 323 | # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 324 | "unit": "A String", # The limit unit of the limit to which this override applies. |
| 325 | # |
| 326 | # An example unit would be: |
| 327 | # `1/{project}/{region}` |
| 328 | # Note that `{project}` and `{region}` are not placeholders in this example; |
| 329 | # the literal characters `{` and `}` occur in the string. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 330 | "metric": "A String", # The name of the metric to which this override applies. |
| 331 | # |
| 332 | # An example name would be: |
| 333 | # `compute.googleapis.com/cpus` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 334 | "dimensions": { # |
| 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 "region" and the value "us-east-1"; |
| 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'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 | # * "project" is not a valid key; the project is already specified in |
| 348 | # the parent resource name. |
| 349 | # * "user" is not a valid key; the API does not support quota overrides |
| 350 | # that apply only to a specific user. |
| 351 | # * If "region" appears as a key, its value must be a valid Cloud region. |
| 352 | # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| 353 | # * If any valid key other than "region" or "zone" appears in the map, then |
| 354 | # all valid keys other than "region" or "zone" must also appear in the |
| 355 | # map. |
| 356 | "a_key": "A String", |
| 357 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 358 | "overrideValue": "A String", # The overriding quota limit value. |
| 359 | # Can be any nonnegative integer, or -1 (unlimited quota). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 360 | }, |
| 361 | ], |
| 362 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 363 | "force": True or False, # Whether to force the creation of the quota overrides. |
| 364 | # If creating an override would cause the effective quota for the consumer to |
| 365 | # decrease by more than 10 percent, the call is rejected, as a safety measure |
| 366 | # to avoid accidentally decreasing quota too quickly. Setting the force |
| 367 | # parameter to true ignores this restriction. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 368 | } |
| 369 | |
| 370 | x__xgafv: string, V1 error format. |
| 371 | Allowed values |
| 372 | 1 - v1 error format |
| 373 | 2 - v2 error format |
| 374 | |
| 375 | Returns: |
| 376 | An object of the form: |
| 377 | |
| 378 | { # This resource represents a long-running operation that is the result of a |
| 379 | # network API call. |
| 380 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 381 | # If `true`, the operation is completed, and either `error` or `response` is |
| 382 | # available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 383 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 384 | # contains progress information and common metadata such as create time. |
| 385 | # Some services might not provide such metadata. Any method that returns a |
| 386 | # long-running operation should document the metadata type, if any. |
| 387 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 388 | }, |
| 389 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 390 | # originally returns it. If you use the default HTTP mapping, the |
| 391 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 392 | "response": { # The normal response of the operation in case of success. If the original |
| 393 | # method returns no data on success, such as `Delete`, the response is |
| 394 | # `google.protobuf.Empty`. If the original method is standard |
| 395 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 396 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 397 | # is the original method name. For example, if the original method name |
| 398 | # is `TakeSnapshot()`, the inferred response type is |
| 399 | # `TakeSnapshotResponse`. |
| 400 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 401 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 402 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 403 | # different programming environments, including REST APIs and RPC APIs. It is |
| 404 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 405 | # three pieces of data: error code, error message, and error details. |
| 406 | # |
| 407 | # You can find out more about this error model and how to work with it in the |
| 408 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 409 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 410 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 411 | # user-facing error message should be localized and sent in the |
| 412 | # google.rpc.Status.details field, or localized by the client. |
| 413 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 414 | # message types for APIs to use. |
| 415 | { |
| 416 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 417 | }, |
| 418 | ], |
| 419 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 420 | }</pre> |
| 421 | </div> |
| 422 | |
| 423 | <div class="method"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 424 | <code class="details" id="list">list(parent, pageSize=None, view=None, pageToken=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 425 | <pre>Retrieves a summary of all quota information about this consumer that is |
| 426 | visible to the service producer, for each quota metric defined by the |
| 427 | service. Each metric includes information about all of its defined limits. |
| 428 | Each limit includes the limit configuration (quota unit, preciseness, |
| 429 | default value), the current effective limit value, and all of the overrides |
| 430 | applied to the limit. |
| 431 | |
| 432 | Args: |
| 433 | parent: string, Parent of the quotas resource. |
| 434 | |
| 435 | An example parent would be: |
| 436 | `services/serviceconsumermanagement.googleapis.com/projects/123` (required) |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 437 | pageSize: integer, Requested size of the next page of data. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 438 | view: string, Specifies the level of detail for quota information in the response. |
| 439 | pageToken: string, Token identifying which result to start with; returned by a previous list |
| 440 | call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 441 | x__xgafv: string, V1 error format. |
| 442 | Allowed values |
| 443 | 1 - v1 error format |
| 444 | 2 - v2 error format |
| 445 | |
| 446 | Returns: |
| 447 | An object of the form: |
| 448 | |
| 449 | { # Response message for ListConsumerQuotaMetrics. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 450 | "nextPageToken": "A String", # Token identifying which result to start with; returned by a previous list |
| 451 | # call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 452 | "metrics": [ # Quota settings for the consumer, organized by quota metric. |
| 453 | { # Consumer quota settings for a quota metric. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 454 | "consumerQuotaLimits": [ # The consumer quota for each quota limit defined on the metric. |
| 455 | { # Consumer quota settings for a quota limit. |
| 456 | "isPrecise": True or False, # Whether this limit is precise or imprecise. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 457 | "name": "A String", # The resource name of the quota limit. |
| 458 | # |
| 459 | # An example name would be: |
| 460 | # `services/compute.googleapis.com/projects/123/quotas/metrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` |
| 461 | # |
| 462 | # The resource name is intended to be opaque and should not be parsed for |
| 463 | # its component strings, since its representation could change in the future. |
| 464 | "metric": "A String", # The name of the parent metric of this limit. |
| 465 | # |
| 466 | # An example name would be: |
| 467 | # `compute.googleapis.com/cpus` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 468 | "quotaBuckets": [ # Summary of the enforced quota buckets, organized by quota dimension, |
| 469 | # ordered from least specific to most specific (for example, the global |
| 470 | # default bucket, with no quota dimensions, will always appear first). |
| 471 | { # A quota bucket is a quota provisioning unit for a specific set of dimensions. |
| 472 | "effectiveLimit": "A String", # The effective limit of this quota bucket. Equal to default_limit if there |
| 473 | # are no overrides. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 474 | "adminOverride": { # A quota override # Admin override on this quota bucket. |
| 475 | "name": "A String", # The resource name of the producer override. |
| 476 | # An example name would be: |
| 477 | # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` |
| 478 | "unit": "A String", # The limit unit of the limit to which this override applies. |
| 479 | # |
| 480 | # An example unit would be: |
| 481 | # `1/{project}/{region}` |
| 482 | # Note that `{project}` and `{region}` are not placeholders in this example; |
| 483 | # the literal characters `{` and `}` occur in the string. |
| 484 | "metric": "A String", # The name of the metric to which this override applies. |
| 485 | # |
| 486 | # An example name would be: |
| 487 | # `compute.googleapis.com/cpus` |
| 488 | "dimensions": { # |
| 489 | # If this map is nonempty, then this override applies only to specific values |
| 490 | # for dimensions defined in the limit unit. |
| 491 | # |
| 492 | # For example, an override on a limit with the unit 1/{project}/{region} |
| 493 | # could contain an entry with the key "region" and the value "us-east-1"; |
| 494 | # the override is only applied to quota consumed in that region. |
| 495 | # |
| 496 | # This map has the following restrictions: |
| 497 | # |
| 498 | # * Keys that are not defined in the limit's unit are not valid keys. |
| 499 | # Any string appearing in {brackets} in the unit (besides {project} or |
| 500 | # {user}) is a defined key. |
| 501 | # * "project" is not a valid key; the project is already specified in |
| 502 | # the parent resource name. |
| 503 | # * "user" is not a valid key; the API does not support quota overrides |
| 504 | # that apply only to a specific user. |
| 505 | # * If "region" appears as a key, its value must be a valid Cloud region. |
| 506 | # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| 507 | # * If any valid key other than "region" or "zone" appears in the map, then |
| 508 | # all valid keys other than "region" or "zone" must also appear in the |
| 509 | # map. |
| 510 | "a_key": "A String", |
| 511 | }, |
| 512 | "overrideValue": "A String", # The overriding quota limit value. |
| 513 | # Can be any nonnegative integer, or -1 (unlimited quota). |
| 514 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 515 | "dimensions": { # The dimensions of this quota bucket. |
| 516 | # |
| 517 | # If this map is empty, this is the global bucket, which is the default quota |
| 518 | # value applied to all requests that do not have a more specific override. |
| 519 | # |
| 520 | # If this map is nonempty, the default limit, effective limit, and quota |
| 521 | # overrides apply only to requests that have the dimensions given in the map. |
| 522 | # |
| 523 | # For example, if the map has key "region" and value "us-east-1", then the |
| 524 | # specified effective limit is only effective in that region, and the |
| 525 | # specified overrides apply only in that region. |
| 526 | "a_key": "A String", |
| 527 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 528 | "producerOverride": { # A quota override # Producer override on this quota bucket. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 529 | "name": "A String", # The resource name of the producer override. |
| 530 | # An example name would be: |
| 531 | # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 532 | "unit": "A String", # The limit unit of the limit to which this override applies. |
| 533 | # |
| 534 | # An example unit would be: |
| 535 | # `1/{project}/{region}` |
| 536 | # Note that `{project}` and `{region}` are not placeholders in this example; |
| 537 | # the literal characters `{` and `}` occur in the string. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 538 | "metric": "A String", # The name of the metric to which this override applies. |
| 539 | # |
| 540 | # An example name would be: |
| 541 | # `compute.googleapis.com/cpus` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 542 | "dimensions": { # |
| 543 | # If this map is nonempty, then this override applies only to specific values |
| 544 | # for dimensions defined in the limit unit. |
| 545 | # |
| 546 | # For example, an override on a limit with the unit 1/{project}/{region} |
| 547 | # could contain an entry with the key "region" and the value "us-east-1"; |
| 548 | # the override is only applied to quota consumed in that region. |
| 549 | # |
| 550 | # This map has the following restrictions: |
| 551 | # |
| 552 | # * Keys that are not defined in the limit's unit are not valid keys. |
| 553 | # Any string appearing in {brackets} in the unit (besides {project} or |
| 554 | # {user}) is a defined key. |
| 555 | # * "project" is not a valid key; the project is already specified in |
| 556 | # the parent resource name. |
| 557 | # * "user" is not a valid key; the API does not support quota overrides |
| 558 | # that apply only to a specific user. |
| 559 | # * If "region" appears as a key, its value must be a valid Cloud region. |
| 560 | # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| 561 | # * If any valid key other than "region" or "zone" appears in the map, then |
| 562 | # all valid keys other than "region" or "zone" must also appear in the |
| 563 | # map. |
| 564 | "a_key": "A String", |
| 565 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 566 | "overrideValue": "A String", # The overriding quota limit value. |
| 567 | # Can be any nonnegative integer, or -1 (unlimited quota). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 568 | }, |
| 569 | "consumerOverride": { # A quota override # Consumer override on this quota bucket. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 570 | "name": "A String", # The resource name of the producer override. |
| 571 | # An example name would be: |
| 572 | # `services/compute.googleapis.com/projects/123/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerOverrides/4a3f2c1d` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 573 | "unit": "A String", # The limit unit of the limit to which this override applies. |
| 574 | # |
| 575 | # An example unit would be: |
| 576 | # `1/{project}/{region}` |
| 577 | # Note that `{project}` and `{region}` are not placeholders in this example; |
| 578 | # the literal characters `{` and `}` occur in the string. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 579 | "metric": "A String", # The name of the metric to which this override applies. |
| 580 | # |
| 581 | # An example name would be: |
| 582 | # `compute.googleapis.com/cpus` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 583 | "dimensions": { # |
| 584 | # If this map is nonempty, then this override applies only to specific values |
| 585 | # for dimensions defined in the limit unit. |
| 586 | # |
| 587 | # For example, an override on a limit with the unit 1/{project}/{region} |
| 588 | # could contain an entry with the key "region" and the value "us-east-1"; |
| 589 | # the override is only applied to quota consumed in that region. |
| 590 | # |
| 591 | # This map has the following restrictions: |
| 592 | # |
| 593 | # * Keys that are not defined in the limit's unit are not valid keys. |
| 594 | # Any string appearing in {brackets} in the unit (besides {project} or |
| 595 | # {user}) is a defined key. |
| 596 | # * "project" is not a valid key; the project is already specified in |
| 597 | # the parent resource name. |
| 598 | # * "user" is not a valid key; the API does not support quota overrides |
| 599 | # that apply only to a specific user. |
| 600 | # * If "region" appears as a key, its value must be a valid Cloud region. |
| 601 | # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| 602 | # * If any valid key other than "region" or "zone" appears in the map, then |
| 603 | # all valid keys other than "region" or "zone" must also appear in the |
| 604 | # map. |
| 605 | "a_key": "A String", |
| 606 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 607 | "overrideValue": "A String", # The overriding quota limit value. |
| 608 | # Can be any nonnegative integer, or -1 (unlimited quota). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 609 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 610 | "defaultLimit": "A String", # The default limit of this quota bucket, as specified by the service |
| 611 | # configuration. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 612 | }, |
| 613 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 614 | "unit": "A String", # The limit unit. |
| 615 | # |
| 616 | # An example unit would be: |
| 617 | # `1/{project}/{region}` |
| 618 | # Note that `{project}` and `{region}` are not placeholders in this example; |
| 619 | # the literal characters `{` and `}` occur in the string. |
| 620 | }, |
| 621 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 622 | "displayName": "A String", # The display name of the metric. |
| 623 | # |
| 624 | # An example name would be: |
| 625 | # "CPUs" |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 626 | "name": "A String", # The resource name of the quota settings on this metric for this consumer. |
| 627 | # |
| 628 | # An example name would be: |
| 629 | # `services/serviceconsumermanagement.googleapis.com/projects/123/quota/metrics/compute.googleapis.com%2Fcpus |
| 630 | # |
| 631 | # The resource name is intended to be opaque and should not be parsed for |
| 632 | # its component strings, since its representation could change in the future. |
| 633 | "metric": "A String", # The name of the metric. |
| 634 | # |
| 635 | # An example name would be: |
| 636 | # `compute.googleapis.com/cpus` |
| 637 | }, |
| 638 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 639 | }</pre> |
| 640 | </div> |
| 641 | |
| 642 | <div class="method"> |
| 643 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 644 | <pre>Retrieves the next page of results. |
| 645 | |
| 646 | Args: |
| 647 | previous_request: The request for the previous page. (required) |
| 648 | previous_response: The response from the request for the previous page. (required) |
| 649 | |
| 650 | Returns: |
| 651 | A request object that you can call 'execute()' on to request the next |
| 652 | page. Returns None if there are no more items in the collection. |
| 653 | </pre> |
| 654 | </div> |
| 655 | |
| 656 | </body></html> |