| 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> . <a href="serviceusage_v1beta1.services.consumerQuotaMetrics.limits.html">limits</a> . <a href="serviceusage_v1beta1.services.consumerQuotaMetrics.limits.consumerOverrides.html">consumerOverrides</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#create">create(parent, body=None, force=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Creates a consumer override.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#delete">delete(name, force=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Deletes a consumer override.</p> |
| 83 | <p class="toc_element"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 84 | <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 85 | <p class="firstline">Lists all consumer overrides on this limit.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 88 | <p class="firstline">Retrieves the next page of results.</p> |
| 89 | <p class="toc_element"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 90 | <code><a href="#patch">patch(name, body=None, force=None, updateMask=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 91 | <p class="firstline">Updates a consumer override.</p> |
| 92 | <h3>Method Details</h3> |
| 93 | <div class="method"> |
| 94 | <code class="details" id="create">create(parent, body=None, force=None, x__xgafv=None)</code> |
| 95 | <pre>Creates a consumer override. |
| 96 | A consumer override is applied to the consumer on its own authority to |
| 97 | limit its own quota usage. Consumer overrides cannot be used to grant more |
| 98 | quota than would be allowed by admin overrides, producer overrides, or the |
| 99 | default limit of the service. |
| 100 | |
| 101 | Args: |
| 102 | parent: string, The resource name of the parent quota limit, returned by a |
| 103 | ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. |
| 104 | |
| 105 | An example name would be: |
| 106 | `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` (required) |
| 107 | body: object, The request body. |
| 108 | The object takes the form of: |
| 109 | |
| 110 | { # A quota override |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 111 | "name": "A String", # The resource name of the override. |
| 112 | # This name is generated by the server when the override is created. |
| 113 | # |
| 114 | # Example names would be: |
| 115 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` |
| 116 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` |
| 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 | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 120 | "overrideValue": "A String", # The overriding quota limit value. |
| 121 | # Can be any nonnegative integer, or -1 (unlimited quota). |
| 122 | "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: |
| 123 | # "organizations/12345" or "folders/67890". |
| 124 | # Used by admin overrides only. |
| 125 | "unit": "A String", # The limit unit of the limit to which this override applies. |
| 126 | # |
| 127 | # An example unit would be: |
| 128 | # `1/{project}/{region}` |
| 129 | # Note that `{project}` and `{region}` are not placeholders in this example; |
| 130 | # the literal characters `{` and `}` occur in the string. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 131 | "metric": "A String", # The name of the metric to which this override applies. |
| 132 | # |
| 133 | # An example name would be: |
| 134 | # `compute.googleapis.com/cpus` |
| 135 | "dimensions": { # If this map is nonempty, then this override applies only to specific values |
| 136 | # for dimensions defined in the limit unit. |
| 137 | # |
| 138 | # For example, an override on a limit with the unit 1/{project}/{region} |
| 139 | # could contain an entry with the key "region" and the value "us-east-1"; |
| 140 | # the override is only applied to quota consumed in that region. |
| 141 | # |
| 142 | # This map has the following restrictions: |
| 143 | # |
| 144 | # * Keys that are not defined in the limit's unit are not valid keys. |
| 145 | # Any string appearing in {brackets} in the unit (besides {project} or |
| 146 | # {user}) is a defined key. |
| 147 | # * "project" is not a valid key; the project is already specified in |
| 148 | # the parent resource name. |
| 149 | # * "user" is not a valid key; the API does not support quota overrides |
| 150 | # that apply only to a specific user. |
| 151 | # * If "region" appears as a key, its value must be a valid Cloud region. |
| 152 | # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| 153 | # * If any valid key other than "region" or "zone" appears in the map, then |
| 154 | # all valid keys other than "region" or "zone" must also appear in the |
| 155 | # map. |
| 156 | "a_key": "A String", |
| 157 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 158 | } |
| 159 | |
| 160 | force: boolean, Whether to force the creation of the quota override. |
| 161 | If creating an override would cause the effective quota for the consumer to |
| 162 | decrease by more than 10 percent, the call is rejected, as a safety measure |
| 163 | to avoid accidentally decreasing quota too quickly. Setting the force |
| 164 | parameter to true ignores this restriction. |
| 165 | x__xgafv: string, V1 error format. |
| 166 | Allowed values |
| 167 | 1 - v1 error format |
| 168 | 2 - v2 error format |
| 169 | |
| 170 | Returns: |
| 171 | An object of the form: |
| 172 | |
| 173 | { # This resource represents a long-running operation that is the result of a |
| 174 | # network API call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 175 | "response": { # The normal response of the operation in case of success. If the original |
| 176 | # method returns no data on success, such as `Delete`, the response is |
| 177 | # `google.protobuf.Empty`. If the original method is standard |
| 178 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 179 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 180 | # is the original method name. For example, if the original method name |
| 181 | # is `TakeSnapshot()`, the inferred response type is |
| 182 | # `TakeSnapshotResponse`. |
| 183 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 184 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 185 | "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. |
| 186 | # different programming environments, including REST APIs and RPC APIs. It is |
| 187 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 188 | # three pieces of data: error code, error message, and error details. |
| 189 | # |
| 190 | # You can find out more about this error model and how to work with it in the |
| 191 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 192 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 193 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 194 | # user-facing error message should be localized and sent in the |
| 195 | # google.rpc.Status.details field, or localized by the client. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 196 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 197 | # message types for APIs to use. |
| 198 | { |
| 199 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 200 | }, |
| 201 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 202 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 203 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 204 | # contains progress information and common metadata such as create time. |
| 205 | # Some services might not provide such metadata. Any method that returns a |
| 206 | # long-running operation should document the metadata type, if any. |
| 207 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 208 | }, |
| 209 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 210 | # originally returns it. If you use the default HTTP mapping, the |
| 211 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 212 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 213 | # If `true`, the operation is completed, and either `error` or `response` is |
| 214 | # available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 215 | }</pre> |
| 216 | </div> |
| 217 | |
| 218 | <div class="method"> |
| 219 | <code class="details" id="delete">delete(name, force=None, x__xgafv=None)</code> |
| 220 | <pre>Deletes a consumer override. |
| 221 | |
| 222 | Args: |
| 223 | name: string, The resource name of the override to delete. |
| 224 | |
| 225 | An example name would be: |
| 226 | `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` (required) |
| 227 | force: boolean, Whether to force the deletion of the quota override. |
| 228 | If deleting an override would cause the effective quota for the consumer to |
| 229 | decrease by more than 10 percent, the call is rejected, as a safety measure |
| 230 | to avoid accidentally decreasing quota too quickly. Setting the force |
| 231 | parameter to true ignores this restriction. |
| 232 | x__xgafv: string, V1 error format. |
| 233 | Allowed values |
| 234 | 1 - v1 error format |
| 235 | 2 - v2 error format |
| 236 | |
| 237 | Returns: |
| 238 | An object of the form: |
| 239 | |
| 240 | { # This resource represents a long-running operation that is the result of a |
| 241 | # network API call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 242 | "response": { # The normal response of the operation in case of success. If the original |
| 243 | # method returns no data on success, such as `Delete`, the response is |
| 244 | # `google.protobuf.Empty`. If the original method is standard |
| 245 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 246 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 247 | # is the original method name. For example, if the original method name |
| 248 | # is `TakeSnapshot()`, the inferred response type is |
| 249 | # `TakeSnapshotResponse`. |
| 250 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 251 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 252 | "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. |
| 253 | # different programming environments, including REST APIs and RPC APIs. It is |
| 254 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 255 | # three pieces of data: error code, error message, and error details. |
| 256 | # |
| 257 | # You can find out more about this error model and how to work with it in the |
| 258 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 259 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 260 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 261 | # user-facing error message should be localized and sent in the |
| 262 | # google.rpc.Status.details field, or localized by the client. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 263 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 264 | # message types for APIs to use. |
| 265 | { |
| 266 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 267 | }, |
| 268 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 269 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 270 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 271 | # contains progress information and common metadata such as create time. |
| 272 | # Some services might not provide such metadata. Any method that returns a |
| 273 | # long-running operation should document the metadata type, if any. |
| 274 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 275 | }, |
| 276 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 277 | # originally returns it. If you use the default HTTP mapping, the |
| 278 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 279 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 280 | # If `true`, the operation is completed, and either `error` or `response` is |
| 281 | # available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 282 | }</pre> |
| 283 | </div> |
| 284 | |
| 285 | <div class="method"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 286 | <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 287 | <pre>Lists all consumer overrides on this limit. |
| 288 | |
| 289 | Args: |
| 290 | parent: string, The resource name of the parent quota limit, returned by a |
| 291 | ListConsumerQuotaMetrics or GetConsumerQuotaMetric call. |
| 292 | |
| 293 | An example name would be: |
| 294 | `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` (required) |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 295 | pageToken: string, Token identifying which result to start with; returned by a previous list |
| 296 | call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 297 | pageSize: integer, Requested size of the next page of data. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 298 | x__xgafv: string, V1 error format. |
| 299 | Allowed values |
| 300 | 1 - v1 error format |
| 301 | 2 - v2 error format |
| 302 | |
| 303 | Returns: |
| 304 | An object of the form: |
| 305 | |
| 306 | { # Response message for ListConsumerOverrides. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 307 | "overrides": [ # Consumer overrides on this limit. |
| 308 | { # A quota override |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 309 | "name": "A String", # The resource name of the override. |
| 310 | # This name is generated by the server when the override is created. |
| 311 | # |
| 312 | # Example names would be: |
| 313 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` |
| 314 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` |
| 315 | # |
| 316 | # The resource name is intended to be opaque and should not be parsed for |
| 317 | # its component strings, since its representation could change in the future. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 318 | "overrideValue": "A String", # The overriding quota limit value. |
| 319 | # Can be any nonnegative integer, or -1 (unlimited quota). |
| 320 | "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: |
| 321 | # "organizations/12345" or "folders/67890". |
| 322 | # Used by admin overrides only. |
| 323 | "unit": "A String", # The limit unit of the limit to which this override applies. |
| 324 | # |
| 325 | # An example unit would be: |
| 326 | # `1/{project}/{region}` |
| 327 | # Note that `{project}` and `{region}` are not placeholders in this example; |
| 328 | # the literal characters `{` and `}` occur in the string. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 329 | "metric": "A String", # The name of the metric to which this override applies. |
| 330 | # |
| 331 | # An example name would be: |
| 332 | # `compute.googleapis.com/cpus` |
| 333 | "dimensions": { # If this map is nonempty, then this override applies only to specific values |
| 334 | # for dimensions defined in the limit unit. |
| 335 | # |
| 336 | # For example, an override on a limit with the unit 1/{project}/{region} |
| 337 | # could contain an entry with the key "region" and the value "us-east-1"; |
| 338 | # the override is only applied to quota consumed in that region. |
| 339 | # |
| 340 | # This map has the following restrictions: |
| 341 | # |
| 342 | # * Keys that are not defined in the limit's unit are not valid keys. |
| 343 | # Any string appearing in {brackets} in the unit (besides {project} or |
| 344 | # {user}) is a defined key. |
| 345 | # * "project" is not a valid key; the project is already specified in |
| 346 | # the parent resource name. |
| 347 | # * "user" is not a valid key; the API does not support quota overrides |
| 348 | # that apply only to a specific user. |
| 349 | # * If "region" appears as a key, its value must be a valid Cloud region. |
| 350 | # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| 351 | # * If any valid key other than "region" or "zone" appears in the map, then |
| 352 | # all valid keys other than "region" or "zone" must also appear in the |
| 353 | # map. |
| 354 | "a_key": "A String", |
| 355 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 356 | }, |
| 357 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 358 | "nextPageToken": "A String", # Token identifying which result to start with; returned by a previous list |
| 359 | # call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 360 | }</pre> |
| 361 | </div> |
| 362 | |
| 363 | <div class="method"> |
| 364 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 365 | <pre>Retrieves the next page of results. |
| 366 | |
| 367 | Args: |
| 368 | previous_request: The request for the previous page. (required) |
| 369 | previous_response: The response from the request for the previous page. (required) |
| 370 | |
| 371 | Returns: |
| 372 | A request object that you can call 'execute()' on to request the next |
| 373 | page. Returns None if there are no more items in the collection. |
| 374 | </pre> |
| 375 | </div> |
| 376 | |
| 377 | <div class="method"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 378 | <code class="details" id="patch">patch(name, body=None, force=None, updateMask=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 379 | <pre>Updates a consumer override. |
| 380 | |
| 381 | Args: |
| 382 | name: string, The resource name of the override to update. |
| 383 | |
| 384 | An example name would be: |
| 385 | `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` (required) |
| 386 | body: object, The request body. |
| 387 | The object takes the form of: |
| 388 | |
| 389 | { # A quota override |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 390 | "name": "A String", # The resource name of the override. |
| 391 | # This name is generated by the server when the override is created. |
| 392 | # |
| 393 | # Example names would be: |
| 394 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` |
| 395 | # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` |
| 396 | # |
| 397 | # The resource name is intended to be opaque and should not be parsed for |
| 398 | # its component strings, since its representation could change in the future. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 399 | "overrideValue": "A String", # The overriding quota limit value. |
| 400 | # Can be any nonnegative integer, or -1 (unlimited quota). |
| 401 | "adminOverrideAncestor": "A String", # The resource name of the ancestor that requested the override. For example: |
| 402 | # "organizations/12345" or "folders/67890". |
| 403 | # Used by admin overrides only. |
| 404 | "unit": "A String", # The limit unit of the limit to which this override applies. |
| 405 | # |
| 406 | # An example unit would be: |
| 407 | # `1/{project}/{region}` |
| 408 | # Note that `{project}` and `{region}` are not placeholders in this example; |
| 409 | # the literal characters `{` and `}` occur in the string. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 410 | "metric": "A String", # The name of the metric to which this override applies. |
| 411 | # |
| 412 | # An example name would be: |
| 413 | # `compute.googleapis.com/cpus` |
| 414 | "dimensions": { # If this map is nonempty, then this override applies only to specific values |
| 415 | # for dimensions defined in the limit unit. |
| 416 | # |
| 417 | # For example, an override on a limit with the unit 1/{project}/{region} |
| 418 | # could contain an entry with the key "region" and the value "us-east-1"; |
| 419 | # the override is only applied to quota consumed in that region. |
| 420 | # |
| 421 | # This map has the following restrictions: |
| 422 | # |
| 423 | # * Keys that are not defined in the limit's unit are not valid keys. |
| 424 | # Any string appearing in {brackets} in the unit (besides {project} or |
| 425 | # {user}) is a defined key. |
| 426 | # * "project" is not a valid key; the project is already specified in |
| 427 | # the parent resource name. |
| 428 | # * "user" is not a valid key; the API does not support quota overrides |
| 429 | # that apply only to a specific user. |
| 430 | # * If "region" appears as a key, its value must be a valid Cloud region. |
| 431 | # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| 432 | # * If any valid key other than "region" or "zone" appears in the map, then |
| 433 | # all valid keys other than "region" or "zone" must also appear in the |
| 434 | # map. |
| 435 | "a_key": "A String", |
| 436 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 437 | } |
| 438 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 439 | force: boolean, Whether to force the update of the quota override. |
| 440 | If updating an override would cause the effective quota for the consumer to |
| 441 | decrease by more than 10 percent, the call is rejected, as a safety measure |
| 442 | to avoid accidentally decreasing quota too quickly. Setting the force |
| 443 | parameter to true ignores this restriction. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 444 | updateMask: string, Update only the specified fields of the override. |
| 445 | If unset, all fields will be updated. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 446 | x__xgafv: string, V1 error format. |
| 447 | Allowed values |
| 448 | 1 - v1 error format |
| 449 | 2 - v2 error format |
| 450 | |
| 451 | Returns: |
| 452 | An object of the form: |
| 453 | |
| 454 | { # This resource represents a long-running operation that is the result of a |
| 455 | # network API call. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 456 | "response": { # The normal response of the operation in case of success. If the original |
| 457 | # method returns no data on success, such as `Delete`, the response is |
| 458 | # `google.protobuf.Empty`. If the original method is standard |
| 459 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 460 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 461 | # is the original method name. For example, if the original method name |
| 462 | # is `TakeSnapshot()`, the inferred response type is |
| 463 | # `TakeSnapshotResponse`. |
| 464 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 465 | }, |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 466 | "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. |
| 467 | # different programming environments, including REST APIs and RPC APIs. It is |
| 468 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 469 | # three pieces of data: error code, error message, and error details. |
| 470 | # |
| 471 | # You can find out more about this error model and how to work with it in the |
| 472 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 473 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 474 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 475 | # user-facing error message should be localized and sent in the |
| 476 | # google.rpc.Status.details field, or localized by the client. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 477 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 478 | # message types for APIs to use. |
| 479 | { |
| 480 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 481 | }, |
| 482 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 483 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 484 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 485 | # contains progress information and common metadata such as create time. |
| 486 | # Some services might not provide such metadata. Any method that returns a |
| 487 | # long-running operation should document the metadata type, if any. |
| 488 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 489 | }, |
| 490 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 491 | # originally returns it. If you use the default HTTP mapping, the |
| 492 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| 493 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 494 | # If `true`, the operation is completed, and either `error` or `response` is |
| 495 | # available. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 496 | }</pre> |
| 497 | </div> |
| 498 | |
| 499 | </body></html> |