| 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="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"> |
| 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"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 86 | <code><a href="#list">list(parent, pageToken=None, pageSize=None, view=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 87 | <p class="firstline">Retrieves a summary of all quota information visible to the service</p> |
| 88 | <p class="toc_element"> |
| 89 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 90 | <p class="firstline">Retrieves the next page of results.</p> |
| 91 | <h3>Method Details</h3> |
| 92 | <div class="method"> |
| 93 | <code class="details" id="get">get(name, view=None, x__xgafv=None)</code> |
| 94 | <pre>Retrieves a summary of quota information for a specific quota metric |
| 95 | |
| 96 | Args: |
| 97 | name: string, The resource name of the quota limit. |
| 98 | |
| 99 | An example name would be: |
| 100 | projects/123/services/serviceusage.googleapis.com/quotas/metrics/serviceusage.googleapis.com%2Fmutate_requests (required) |
| 101 | view: string, Specifies the level of detail for quota information in the response. |
| 102 | x__xgafv: string, V1 error format. |
| 103 | Allowed values |
| 104 | 1 - v1 error format |
| 105 | 2 - v2 error format |
| 106 | |
| 107 | Returns: |
| 108 | An object of the form: |
| 109 | |
| 110 | { # Consumer quota settings for a quota metric. |
| 111 | "consumerQuotaLimits": [ # The consumer quota for each quota limit defined on the metric. |
| 112 | { # Consumer quota settings for a quota limit. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 113 | "name": "A String", # The resource name of the quota limit. |
| 114 | # |
| 115 | # An example name would be: |
| 116 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` |
| 117 | # |
| 118 | # The resource name is intended to be opaque and should not be parsed for |
| 119 | # its component strings, since its representation could change in the future. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 120 | "allowsAdminOverrides": True or False, # Whether admin overrides are allowed on this limit |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 121 | "isPrecise": True or False, # Whether this limit is precise or imprecise. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 122 | "quotaBuckets": [ # Summary of the enforced quota buckets, organized by quota dimension, |
| 123 | # ordered from least specific to most specific (for example, the global |
| 124 | # default bucket, with no quota dimensions, will always appear first). |
| 125 | { # A quota bucket is a quota provisioning unit for a specific set of dimensions. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 126 | "adminOverride": { # A quota override # Admin override on this quota bucket. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 127 | "unit": "A String", # The limit unit of the limit to which this override applies. |
| 128 | # |
| 129 | # An example unit would be: |
| 130 | # `1/{project}/{region}` |
| 131 | # Note that `{project}` and `{region}` are not placeholders in this example; |
| 132 | # the literal characters `{` and `}` occur in the string. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 133 | "overrideValue": "A String", # The overriding quota limit value. |
| 134 | # Can be any nonnegative integer, or -1 (unlimited quota). |
| 135 | "name": "A String", # The resource name of the override. |
| 136 | # This name is generated by the server when the override is created. |
| 137 | # |
| 138 | # Example names would be: |
| 139 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` |
| 140 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` |
| 141 | # |
| 142 | # The resource name is intended to be opaque and should not be parsed for |
| 143 | # its component strings, since its representation could change in the future. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 144 | "metric": "A String", # The name of the metric to which this override applies. |
| 145 | # |
| 146 | # An example name would be: |
| 147 | # `compute.googleapis.com/cpus` |
| 148 | "dimensions": { # If this map is nonempty, then this override applies only to specific values |
| 149 | # for dimensions defined in the limit unit. |
| 150 | # |
| 151 | # For example, an override on a limit with the unit 1/{project}/{region} |
| 152 | # could contain an entry with the key "region" and the value "us-east-1"; |
| 153 | # the override is only applied to quota consumed in that region. |
| 154 | # |
| 155 | # This map has the following restrictions: |
| 156 | # |
| 157 | # * Keys that are not defined in the limit's unit are not valid keys. |
| 158 | # Any string appearing in {brackets} in the unit (besides {project} or |
| 159 | # {user}) is a defined key. |
| 160 | # * "project" is not a valid key; the project is already specified in |
| 161 | # the parent resource name. |
| 162 | # * "user" is not a valid key; the API does not support quota overrides |
| 163 | # that apply only to a specific user. |
| 164 | # * If "region" appears as a key, its value must be a valid Cloud region. |
| 165 | # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| 166 | # * If any valid key other than "region" or "zone" appears in the map, then |
| 167 | # all valid keys other than "region" or "zone" must also appear in the |
| 168 | # map. |
| 169 | "a_key": "A String", |
| 170 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 171 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 172 | "producerOverride": { # A quota override # Producer override on this quota bucket. |
| 173 | "unit": "A String", # The limit unit of the limit to which this override applies. |
| 174 | # |
| 175 | # An example unit would be: |
| 176 | # `1/{project}/{region}` |
| 177 | # Note that `{project}` and `{region}` are not placeholders in this example; |
| 178 | # the literal characters `{` and `}` occur in the string. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 179 | "overrideValue": "A String", # The overriding quota limit value. |
| 180 | # Can be any nonnegative integer, or -1 (unlimited quota). |
| 181 | "name": "A String", # The resource name of the override. |
| 182 | # This name is generated by the server when the override is created. |
| 183 | # |
| 184 | # Example names would be: |
| 185 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` |
| 186 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` |
| 187 | # |
| 188 | # The resource name is intended to be opaque and should not be parsed for |
| 189 | # its component strings, since its representation could change in the future. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 190 | "metric": "A String", # The name of the metric to which this override applies. |
| 191 | # |
| 192 | # An example name would be: |
| 193 | # `compute.googleapis.com/cpus` |
| 194 | "dimensions": { # If this map is nonempty, then this override applies only to specific values |
| 195 | # for dimensions defined in the limit unit. |
| 196 | # |
| 197 | # For example, an override on a limit with the unit 1/{project}/{region} |
| 198 | # could contain an entry with the key "region" and the value "us-east-1"; |
| 199 | # the override is only applied to quota consumed in that region. |
| 200 | # |
| 201 | # This map has the following restrictions: |
| 202 | # |
| 203 | # * Keys that are not defined in the limit's unit are not valid keys. |
| 204 | # Any string appearing in {brackets} in the unit (besides {project} or |
| 205 | # {user}) is a defined key. |
| 206 | # * "project" is not a valid key; the project is already specified in |
| 207 | # the parent resource name. |
| 208 | # * "user" is not a valid key; the API does not support quota overrides |
| 209 | # that apply only to a specific user. |
| 210 | # * If "region" appears as a key, its value must be a valid Cloud region. |
| 211 | # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| 212 | # * If any valid key other than "region" or "zone" appears in the map, then |
| 213 | # all valid keys other than "region" or "zone" must also appear in the |
| 214 | # map. |
| 215 | "a_key": "A String", |
| 216 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 217 | }, |
| 218 | "consumerOverride": { # A quota override # Consumer override on this quota bucket. |
| 219 | "unit": "A String", # The limit unit of the limit to which this override applies. |
| 220 | # |
| 221 | # An example unit would be: |
| 222 | # `1/{project}/{region}` |
| 223 | # Note that `{project}` and `{region}` are not placeholders in this example; |
| 224 | # the literal characters `{` and `}` occur in the string. |
| 225 | "overrideValue": "A String", # The overriding quota limit value. |
| 226 | # Can be any nonnegative integer, or -1 (unlimited quota). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 227 | "name": "A String", # The resource name of the override. |
| 228 | # This name is generated by the server when the override is created. |
| 229 | # |
| 230 | # Example names would be: |
| 231 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` |
| 232 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` |
| 233 | # |
| 234 | # The resource name is intended to be opaque and should not be parsed for |
| 235 | # its component strings, since its representation could change in the future. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 236 | "metric": "A String", # The name of the metric to which this override applies. |
| 237 | # |
| 238 | # An example name would be: |
| 239 | # `compute.googleapis.com/cpus` |
| 240 | "dimensions": { # If this map is nonempty, then this override applies only to specific values |
| 241 | # for dimensions defined in the limit unit. |
| 242 | # |
| 243 | # For example, an override on a limit with the unit 1/{project}/{region} |
| 244 | # could contain an entry with the key "region" and the value "us-east-1"; |
| 245 | # the override is only applied to quota consumed in that region. |
| 246 | # |
| 247 | # This map has the following restrictions: |
| 248 | # |
| 249 | # * Keys that are not defined in the limit's unit are not valid keys. |
| 250 | # Any string appearing in {brackets} in the unit (besides {project} or |
| 251 | # {user}) is a defined key. |
| 252 | # * "project" is not a valid key; the project is already specified in |
| 253 | # the parent resource name. |
| 254 | # * "user" is not a valid key; the API does not support quota overrides |
| 255 | # that apply only to a specific user. |
| 256 | # * If "region" appears as a key, its value must be a valid Cloud region. |
| 257 | # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| 258 | # * If any valid key other than "region" or "zone" appears in the map, then |
| 259 | # all valid keys other than "region" or "zone" must also appear in the |
| 260 | # map. |
| 261 | "a_key": "A String", |
| 262 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 263 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 264 | "defaultLimit": "A String", # The default limit of this quota bucket, as specified by the service |
| 265 | # configuration. |
| 266 | "effectiveLimit": "A String", # The effective limit of this quota bucket. Equal to default_limit if there |
| 267 | # are no overrides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 268 | "dimensions": { # The dimensions of this quota bucket. |
| 269 | # |
| 270 | # If this map is empty, this is the global bucket, which is the default quota |
| 271 | # value applied to all requests that do not have a more specific override. |
| 272 | # |
| 273 | # If this map is nonempty, the default limit, effective limit, and quota |
| 274 | # overrides apply only to requests that have the dimensions given in the map. |
| 275 | # |
| 276 | # For example, if the map has key "region" and value "us-east-1", then the |
| 277 | # specified effective limit is only effective in that region, and the |
| 278 | # specified overrides apply only in that region. |
| 279 | "a_key": "A String", |
| 280 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 281 | }, |
| 282 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 283 | "unit": "A String", # The limit unit. |
| 284 | # |
| 285 | # An example unit would be |
| 286 | # `1/{project}/{region}` |
| 287 | # Note that `{project}` and `{region}` are not placeholders in this example; |
| 288 | # the literal characters `{` and `}` occur in the string. |
| 289 | "metric": "A String", # The name of the parent metric of this limit. |
| 290 | # |
| 291 | # An example name would be: |
| 292 | # `compute.googleapis.com/cpus` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 293 | }, |
| 294 | ], |
| 295 | "displayName": "A String", # The display name of the metric. |
| 296 | # |
| 297 | # An example name would be: |
| 298 | # "CPUs" |
| 299 | "name": "A String", # The resource name of the quota settings on this metric for this consumer. |
| 300 | # |
| 301 | # An example name would be: |
| 302 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus |
| 303 | # |
| 304 | # The resource name is intended to be opaque and should not be parsed for |
| 305 | # its component strings, since its representation could change in the future. |
| 306 | "metric": "A String", # The name of the metric. |
| 307 | # |
| 308 | # An example name would be: |
| 309 | # `compute.googleapis.com/cpus` |
| 310 | }</pre> |
| 311 | </div> |
| 312 | |
| 313 | <div class="method"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 314 | <code class="details" id="list">list(parent, pageToken=None, pageSize=None, view=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 315 | <pre>Retrieves a summary of all quota information visible to the service |
| 316 | consumer, organized by service metric. Each metric includes information |
| 317 | about all of its defined limits. Each limit includes the limit |
| 318 | configuration (quota unit, preciseness, default value), the current |
| 319 | effective limit value, and all of the overrides applied to the limit. |
| 320 | |
| 321 | Args: |
| 322 | parent: string, Parent of the quotas resource. |
| 323 | |
| 324 | Some example names would be: |
| 325 | projects/123/services/serviceconsumermanagement.googleapis.com |
| 326 | folders/345/services/serviceconsumermanagement.googleapis.com |
| 327 | organizations/456/services/serviceconsumermanagement.googleapis.com (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 328 | pageToken: string, Token identifying which result to start with; returned by a previous list |
| 329 | call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 330 | pageSize: integer, Requested size of the next page of data. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 331 | view: string, Specifies the level of detail for quota information in the response. |
| 332 | x__xgafv: string, V1 error format. |
| 333 | Allowed values |
| 334 | 1 - v1 error format |
| 335 | 2 - v2 error format |
| 336 | |
| 337 | Returns: |
| 338 | An object of the form: |
| 339 | |
| 340 | { # Response message for ListConsumerQuotaMetrics |
| 341 | "metrics": [ # Quota settings for the consumer, organized by quota metric. |
| 342 | { # Consumer quota settings for a quota metric. |
| 343 | "consumerQuotaLimits": [ # The consumer quota for each quota limit defined on the metric. |
| 344 | { # Consumer quota settings for a quota limit. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 345 | "name": "A String", # The resource name of the quota limit. |
| 346 | # |
| 347 | # An example name would be: |
| 348 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` |
| 349 | # |
| 350 | # The resource name is intended to be opaque and should not be parsed for |
| 351 | # its component strings, since its representation could change in the future. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 352 | "allowsAdminOverrides": True or False, # Whether admin overrides are allowed on this limit |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 353 | "isPrecise": True or False, # Whether this limit is precise or imprecise. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 354 | "quotaBuckets": [ # Summary of the enforced quota buckets, organized by quota dimension, |
| 355 | # ordered from least specific to most specific (for example, the global |
| 356 | # default bucket, with no quota dimensions, will always appear first). |
| 357 | { # A quota bucket is a quota provisioning unit for a specific set of dimensions. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 358 | "adminOverride": { # A quota override # Admin override on this quota bucket. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 359 | "unit": "A String", # The limit unit of the limit to which this override applies. |
| 360 | # |
| 361 | # An example unit would be: |
| 362 | # `1/{project}/{region}` |
| 363 | # Note that `{project}` and `{region}` are not placeholders in this example; |
| 364 | # the literal characters `{` and `}` occur in the string. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 365 | "overrideValue": "A String", # The overriding quota limit value. |
| 366 | # Can be any nonnegative integer, or -1 (unlimited quota). |
| 367 | "name": "A String", # The resource name of the override. |
| 368 | # This name is generated by the server when the override is created. |
| 369 | # |
| 370 | # Example names would be: |
| 371 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` |
| 372 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` |
| 373 | # |
| 374 | # The resource name is intended to be opaque and should not be parsed for |
| 375 | # its component strings, since its representation could change in the future. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 376 | "metric": "A String", # The name of the metric to which this override applies. |
| 377 | # |
| 378 | # An example name would be: |
| 379 | # `compute.googleapis.com/cpus` |
| 380 | "dimensions": { # If this map is nonempty, then this override applies only to specific values |
| 381 | # for dimensions defined in the limit unit. |
| 382 | # |
| 383 | # For example, an override on a limit with the unit 1/{project}/{region} |
| 384 | # could contain an entry with the key "region" and the value "us-east-1"; |
| 385 | # the override is only applied to quota consumed in that region. |
| 386 | # |
| 387 | # This map has the following restrictions: |
| 388 | # |
| 389 | # * Keys that are not defined in the limit's unit are not valid keys. |
| 390 | # Any string appearing in {brackets} in the unit (besides {project} or |
| 391 | # {user}) is a defined key. |
| 392 | # * "project" is not a valid key; the project is already specified in |
| 393 | # the parent resource name. |
| 394 | # * "user" is not a valid key; the API does not support quota overrides |
| 395 | # that apply only to a specific user. |
| 396 | # * If "region" appears as a key, its value must be a valid Cloud region. |
| 397 | # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| 398 | # * If any valid key other than "region" or "zone" appears in the map, then |
| 399 | # all valid keys other than "region" or "zone" must also appear in the |
| 400 | # map. |
| 401 | "a_key": "A String", |
| 402 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 403 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 404 | "producerOverride": { # A quota override # Producer override on this quota bucket. |
| 405 | "unit": "A String", # The limit unit of the limit to which this override applies. |
| 406 | # |
| 407 | # An example unit would be: |
| 408 | # `1/{project}/{region}` |
| 409 | # Note that `{project}` and `{region}` are not placeholders in this example; |
| 410 | # the literal characters `{` and `}` occur in the string. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 411 | "overrideValue": "A String", # The overriding quota limit value. |
| 412 | # Can be any nonnegative integer, or -1 (unlimited quota). |
| 413 | "name": "A String", # The resource name of the override. |
| 414 | # This name is generated by the server when the override is created. |
| 415 | # |
| 416 | # Example names would be: |
| 417 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` |
| 418 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` |
| 419 | # |
| 420 | # The resource name is intended to be opaque and should not be parsed for |
| 421 | # its component strings, since its representation could change in the future. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 422 | "metric": "A String", # The name of the metric to which this override applies. |
| 423 | # |
| 424 | # An example name would be: |
| 425 | # `compute.googleapis.com/cpus` |
| 426 | "dimensions": { # If this map is nonempty, then this override applies only to specific values |
| 427 | # for dimensions defined in the limit unit. |
| 428 | # |
| 429 | # For example, an override on a limit with the unit 1/{project}/{region} |
| 430 | # could contain an entry with the key "region" and the value "us-east-1"; |
| 431 | # the override is only applied to quota consumed in that region. |
| 432 | # |
| 433 | # This map has the following restrictions: |
| 434 | # |
| 435 | # * Keys that are not defined in the limit's unit are not valid keys. |
| 436 | # Any string appearing in {brackets} in the unit (besides {project} or |
| 437 | # {user}) is a defined key. |
| 438 | # * "project" is not a valid key; the project is already specified in |
| 439 | # the parent resource name. |
| 440 | # * "user" is not a valid key; the API does not support quota overrides |
| 441 | # that apply only to a specific user. |
| 442 | # * If "region" appears as a key, its value must be a valid Cloud region. |
| 443 | # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| 444 | # * If any valid key other than "region" or "zone" appears in the map, then |
| 445 | # all valid keys other than "region" or "zone" must also appear in the |
| 446 | # map. |
| 447 | "a_key": "A String", |
| 448 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 449 | }, |
| 450 | "consumerOverride": { # A quota override # Consumer override on this quota bucket. |
| 451 | "unit": "A String", # The limit unit of the limit to which this override applies. |
| 452 | # |
| 453 | # An example unit would be: |
| 454 | # `1/{project}/{region}` |
| 455 | # Note that `{project}` and `{region}` are not placeholders in this example; |
| 456 | # the literal characters `{` and `}` occur in the string. |
| 457 | "overrideValue": "A String", # The overriding quota limit value. |
| 458 | # Can be any nonnegative integer, or -1 (unlimited quota). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 459 | "name": "A String", # The resource name of the override. |
| 460 | # This name is generated by the server when the override is created. |
| 461 | # |
| 462 | # Example names would be: |
| 463 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` |
| 464 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` |
| 465 | # |
| 466 | # The resource name is intended to be opaque and should not be parsed for |
| 467 | # its component strings, since its representation could change in the future. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 468 | "metric": "A String", # The name of the metric to which this override applies. |
| 469 | # |
| 470 | # An example name would be: |
| 471 | # `compute.googleapis.com/cpus` |
| 472 | "dimensions": { # If this map is nonempty, then this override applies only to specific values |
| 473 | # for dimensions defined in the limit unit. |
| 474 | # |
| 475 | # For example, an override on a limit with the unit 1/{project}/{region} |
| 476 | # could contain an entry with the key "region" and the value "us-east-1"; |
| 477 | # the override is only applied to quota consumed in that region. |
| 478 | # |
| 479 | # This map has the following restrictions: |
| 480 | # |
| 481 | # * Keys that are not defined in the limit's unit are not valid keys. |
| 482 | # Any string appearing in {brackets} in the unit (besides {project} or |
| 483 | # {user}) is a defined key. |
| 484 | # * "project" is not a valid key; the project is already specified in |
| 485 | # the parent resource name. |
| 486 | # * "user" is not a valid key; the API does not support quota overrides |
| 487 | # that apply only to a specific user. |
| 488 | # * If "region" appears as a key, its value must be a valid Cloud region. |
| 489 | # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| 490 | # * If any valid key other than "region" or "zone" appears in the map, then |
| 491 | # all valid keys other than "region" or "zone" must also appear in the |
| 492 | # map. |
| 493 | "a_key": "A String", |
| 494 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 495 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 496 | "defaultLimit": "A String", # The default limit of this quota bucket, as specified by the service |
| 497 | # configuration. |
| 498 | "effectiveLimit": "A String", # The effective limit of this quota bucket. Equal to default_limit if there |
| 499 | # are no overrides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 500 | "dimensions": { # The dimensions of this quota bucket. |
| 501 | # |
| 502 | # If this map is empty, this is the global bucket, which is the default quota |
| 503 | # value applied to all requests that do not have a more specific override. |
| 504 | # |
| 505 | # If this map is nonempty, the default limit, effective limit, and quota |
| 506 | # overrides apply only to requests that have the dimensions given in the map. |
| 507 | # |
| 508 | # For example, if the map has key "region" and value "us-east-1", then the |
| 509 | # specified effective limit is only effective in that region, and the |
| 510 | # specified overrides apply only in that region. |
| 511 | "a_key": "A String", |
| 512 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 513 | }, |
| 514 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 515 | "unit": "A String", # The limit unit. |
| 516 | # |
| 517 | # An example unit would be |
| 518 | # `1/{project}/{region}` |
| 519 | # Note that `{project}` and `{region}` are not placeholders in this example; |
| 520 | # the literal characters `{` and `}` occur in the string. |
| 521 | "metric": "A String", # The name of the parent metric of this limit. |
| 522 | # |
| 523 | # An example name would be: |
| 524 | # `compute.googleapis.com/cpus` |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 525 | }, |
| 526 | ], |
| 527 | "displayName": "A String", # The display name of the metric. |
| 528 | # |
| 529 | # An example name would be: |
| 530 | # "CPUs" |
| 531 | "name": "A String", # The resource name of the quota settings on this metric for this consumer. |
| 532 | # |
| 533 | # An example name would be: |
| 534 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus |
| 535 | # |
| 536 | # The resource name is intended to be opaque and should not be parsed for |
| 537 | # its component strings, since its representation could change in the future. |
| 538 | "metric": "A String", # The name of the metric. |
| 539 | # |
| 540 | # An example name would be: |
| 541 | # `compute.googleapis.com/cpus` |
| 542 | }, |
| 543 | ], |
| 544 | "nextPageToken": "A String", # Token identifying which result to start with; returned by a previous list |
| 545 | # call. |
| 546 | }</pre> |
| 547 | </div> |
| 548 | |
| 549 | <div class="method"> |
| 550 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 551 | <pre>Retrieves the next page of results. |
| 552 | |
| 553 | Args: |
| 554 | previous_request: The request for the previous page. (required) |
| 555 | previous_response: The response from the request for the previous page. (required) |
| 556 | |
| 557 | Returns: |
| 558 | A request object that you can call 'execute()' on to request the next |
| 559 | page. Returns None if there are no more items in the collection. |
| 560 | </pre> |
| 561 | </div> |
| 562 | |
| 563 | </body></html> |