| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <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> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="serviceusage_v1beta1.services.consumerQuotaMetrics.limits.html">limits()</a></code> |
| </p> |
| <p class="firstline">Returns the limits Resource.</p> |
| |
| <p class="toc_element"> |
| <code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves a summary of quota information for a specific quota metric</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageToken=None, pageSize=None, view=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves a summary of all quota information visible to the service</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="get">get(name, view=None, x__xgafv=None)</code> |
| <pre>Retrieves a summary of quota information for a specific quota metric |
| |
| Args: |
| name: string, The resource name of the quota limit. |
| |
| An example name would be: |
| projects/123/services/serviceusage.googleapis.com/quotas/metrics/serviceusage.googleapis.com%2Fmutate_requests (required) |
| view: string, Specifies the level of detail for quota information in the response. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Consumer quota settings for a quota metric. |
| "consumerQuotaLimits": [ # The consumer quota for each quota limit defined on the metric. |
| { # Consumer quota settings for a quota limit. |
| "name": "A String", # The resource name of the quota limit. |
| # |
| # An example name would be: |
| # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` |
| # |
| # The resource name is intended to be opaque and should not be parsed for |
| # its component strings, since its representation could change in the future. |
| "allowsAdminOverrides": True or False, # Whether admin overrides are allowed on this limit |
| "isPrecise": True or False, # Whether this limit is precise or imprecise. |
| "quotaBuckets": [ # Summary of the enforced quota buckets, organized by quota dimension, |
| # ordered from least specific to most specific (for example, the global |
| # default bucket, with no quota dimensions, will always appear first). |
| { # A quota bucket is a quota provisioning unit for a specific set of dimensions. |
| "adminOverride": { # A quota override # Admin override on this quota bucket. |
| "unit": "A String", # The limit unit of the limit to which this override applies. |
| # |
| # An example unit would be: |
| # `1/{project}/{region}` |
| # Note that `{project}` and `{region}` are not placeholders in this example; |
| # the literal characters `{` and `}` occur in the string. |
| "overrideValue": "A String", # The overriding quota limit value. |
| # Can be any nonnegative integer, or -1 (unlimited quota). |
| "name": "A String", # The resource name of the override. |
| # This name is generated by the server when the override is created. |
| # |
| # Example names would be: |
| # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` |
| # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` |
| # |
| # The resource name is intended to be opaque and should not be parsed for |
| # its component strings, since its representation could change in the future. |
| "metric": "A String", # The name of the metric to which this override applies. |
| # |
| # An example name would be: |
| # `compute.googleapis.com/cpus` |
| "dimensions": { # If this map is nonempty, then this override applies only to specific values |
| # for dimensions defined in the limit unit. |
| # |
| # For example, an override on a limit with the unit 1/{project}/{region} |
| # could contain an entry with the key "region" and the value "us-east-1"; |
| # the override is only applied to quota consumed in that region. |
| # |
| # This map has the following restrictions: |
| # |
| # * Keys that are not defined in the limit's unit are not valid keys. |
| # Any string appearing in {brackets} in the unit (besides {project} or |
| # {user}) is a defined key. |
| # * "project" is not a valid key; the project is already specified in |
| # the parent resource name. |
| # * "user" is not a valid key; the API does not support quota overrides |
| # that apply only to a specific user. |
| # * If "region" appears as a key, its value must be a valid Cloud region. |
| # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| # * If any valid key other than "region" or "zone" appears in the map, then |
| # all valid keys other than "region" or "zone" must also appear in the |
| # map. |
| "a_key": "A String", |
| }, |
| }, |
| "producerOverride": { # A quota override # Producer override on this quota bucket. |
| "unit": "A String", # The limit unit of the limit to which this override applies. |
| # |
| # An example unit would be: |
| # `1/{project}/{region}` |
| # Note that `{project}` and `{region}` are not placeholders in this example; |
| # the literal characters `{` and `}` occur in the string. |
| "overrideValue": "A String", # The overriding quota limit value. |
| # Can be any nonnegative integer, or -1 (unlimited quota). |
| "name": "A String", # The resource name of the override. |
| # This name is generated by the server when the override is created. |
| # |
| # Example names would be: |
| # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` |
| # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` |
| # |
| # The resource name is intended to be opaque and should not be parsed for |
| # its component strings, since its representation could change in the future. |
| "metric": "A String", # The name of the metric to which this override applies. |
| # |
| # An example name would be: |
| # `compute.googleapis.com/cpus` |
| "dimensions": { # If this map is nonempty, then this override applies only to specific values |
| # for dimensions defined in the limit unit. |
| # |
| # For example, an override on a limit with the unit 1/{project}/{region} |
| # could contain an entry with the key "region" and the value "us-east-1"; |
| # the override is only applied to quota consumed in that region. |
| # |
| # This map has the following restrictions: |
| # |
| # * Keys that are not defined in the limit's unit are not valid keys. |
| # Any string appearing in {brackets} in the unit (besides {project} or |
| # {user}) is a defined key. |
| # * "project" is not a valid key; the project is already specified in |
| # the parent resource name. |
| # * "user" is not a valid key; the API does not support quota overrides |
| # that apply only to a specific user. |
| # * If "region" appears as a key, its value must be a valid Cloud region. |
| # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| # * If any valid key other than "region" or "zone" appears in the map, then |
| # all valid keys other than "region" or "zone" must also appear in the |
| # map. |
| "a_key": "A String", |
| }, |
| }, |
| "consumerOverride": { # A quota override # Consumer override on this quota bucket. |
| "unit": "A String", # The limit unit of the limit to which this override applies. |
| # |
| # An example unit would be: |
| # `1/{project}/{region}` |
| # Note that `{project}` and `{region}` are not placeholders in this example; |
| # the literal characters `{` and `}` occur in the string. |
| "overrideValue": "A String", # The overriding quota limit value. |
| # Can be any nonnegative integer, or -1 (unlimited quota). |
| "name": "A String", # The resource name of the override. |
| # This name is generated by the server when the override is created. |
| # |
| # Example names would be: |
| # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` |
| # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` |
| # |
| # The resource name is intended to be opaque and should not be parsed for |
| # its component strings, since its representation could change in the future. |
| "metric": "A String", # The name of the metric to which this override applies. |
| # |
| # An example name would be: |
| # `compute.googleapis.com/cpus` |
| "dimensions": { # If this map is nonempty, then this override applies only to specific values |
| # for dimensions defined in the limit unit. |
| # |
| # For example, an override on a limit with the unit 1/{project}/{region} |
| # could contain an entry with the key "region" and the value "us-east-1"; |
| # the override is only applied to quota consumed in that region. |
| # |
| # This map has the following restrictions: |
| # |
| # * Keys that are not defined in the limit's unit are not valid keys. |
| # Any string appearing in {brackets} in the unit (besides {project} or |
| # {user}) is a defined key. |
| # * "project" is not a valid key; the project is already specified in |
| # the parent resource name. |
| # * "user" is not a valid key; the API does not support quota overrides |
| # that apply only to a specific user. |
| # * If "region" appears as a key, its value must be a valid Cloud region. |
| # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| # * If any valid key other than "region" or "zone" appears in the map, then |
| # all valid keys other than "region" or "zone" must also appear in the |
| # map. |
| "a_key": "A String", |
| }, |
| }, |
| "defaultLimit": "A String", # The default limit of this quota bucket, as specified by the service |
| # configuration. |
| "effectiveLimit": "A String", # The effective limit of this quota bucket. Equal to default_limit if there |
| # are no overrides. |
| "dimensions": { # The dimensions of this quota bucket. |
| # |
| # If this map is empty, this is the global bucket, which is the default quota |
| # value applied to all requests that do not have a more specific override. |
| # |
| # If this map is nonempty, the default limit, effective limit, and quota |
| # overrides apply only to requests that have the dimensions given in the map. |
| # |
| # For example, if the map has key "region" and value "us-east-1", then the |
| # specified effective limit is only effective in that region, and the |
| # specified overrides apply only in that region. |
| "a_key": "A String", |
| }, |
| }, |
| ], |
| "unit": "A String", # The limit unit. |
| # |
| # An example unit would be |
| # `1/{project}/{region}` |
| # Note that `{project}` and `{region}` are not placeholders in this example; |
| # the literal characters `{` and `}` occur in the string. |
| "metric": "A String", # The name of the parent metric of this limit. |
| # |
| # An example name would be: |
| # `compute.googleapis.com/cpus` |
| }, |
| ], |
| "displayName": "A String", # The display name of the metric. |
| # |
| # An example name would be: |
| # "CPUs" |
| "name": "A String", # The resource name of the quota settings on this metric for this consumer. |
| # |
| # An example name would be: |
| # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus |
| # |
| # The resource name is intended to be opaque and should not be parsed for |
| # its component strings, since its representation could change in the future. |
| "metric": "A String", # The name of the metric. |
| # |
| # An example name would be: |
| # `compute.googleapis.com/cpus` |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageToken=None, pageSize=None, view=None, x__xgafv=None)</code> |
| <pre>Retrieves a summary of all quota information visible to the service |
| consumer, organized by service metric. Each metric includes information |
| about all of its defined limits. Each limit includes the limit |
| configuration (quota unit, preciseness, default value), the current |
| effective limit value, and all of the overrides applied to the limit. |
| |
| Args: |
| parent: string, Parent of the quotas resource. |
| |
| Some example names would be: |
| projects/123/services/serviceconsumermanagement.googleapis.com |
| folders/345/services/serviceconsumermanagement.googleapis.com |
| organizations/456/services/serviceconsumermanagement.googleapis.com (required) |
| pageToken: string, Token identifying which result to start with; returned by a previous list |
| call. |
| pageSize: integer, Requested size of the next page of data. |
| view: string, Specifies the level of detail for quota information in the response. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for ListConsumerQuotaMetrics |
| "metrics": [ # Quota settings for the consumer, organized by quota metric. |
| { # Consumer quota settings for a quota metric. |
| "consumerQuotaLimits": [ # The consumer quota for each quota limit defined on the metric. |
| { # Consumer quota settings for a quota limit. |
| "name": "A String", # The resource name of the quota limit. |
| # |
| # An example name would be: |
| # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion` |
| # |
| # The resource name is intended to be opaque and should not be parsed for |
| # its component strings, since its representation could change in the future. |
| "allowsAdminOverrides": True or False, # Whether admin overrides are allowed on this limit |
| "isPrecise": True or False, # Whether this limit is precise or imprecise. |
| "quotaBuckets": [ # Summary of the enforced quota buckets, organized by quota dimension, |
| # ordered from least specific to most specific (for example, the global |
| # default bucket, with no quota dimensions, will always appear first). |
| { # A quota bucket is a quota provisioning unit for a specific set of dimensions. |
| "adminOverride": { # A quota override # Admin override on this quota bucket. |
| "unit": "A String", # The limit unit of the limit to which this override applies. |
| # |
| # An example unit would be: |
| # `1/{project}/{region}` |
| # Note that `{project}` and `{region}` are not placeholders in this example; |
| # the literal characters `{` and `}` occur in the string. |
| "overrideValue": "A String", # The overriding quota limit value. |
| # Can be any nonnegative integer, or -1 (unlimited quota). |
| "name": "A String", # The resource name of the override. |
| # This name is generated by the server when the override is created. |
| # |
| # Example names would be: |
| # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` |
| # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` |
| # |
| # The resource name is intended to be opaque and should not be parsed for |
| # its component strings, since its representation could change in the future. |
| "metric": "A String", # The name of the metric to which this override applies. |
| # |
| # An example name would be: |
| # `compute.googleapis.com/cpus` |
| "dimensions": { # If this map is nonempty, then this override applies only to specific values |
| # for dimensions defined in the limit unit. |
| # |
| # For example, an override on a limit with the unit 1/{project}/{region} |
| # could contain an entry with the key "region" and the value "us-east-1"; |
| # the override is only applied to quota consumed in that region. |
| # |
| # This map has the following restrictions: |
| # |
| # * Keys that are not defined in the limit's unit are not valid keys. |
| # Any string appearing in {brackets} in the unit (besides {project} or |
| # {user}) is a defined key. |
| # * "project" is not a valid key; the project is already specified in |
| # the parent resource name. |
| # * "user" is not a valid key; the API does not support quota overrides |
| # that apply only to a specific user. |
| # * If "region" appears as a key, its value must be a valid Cloud region. |
| # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| # * If any valid key other than "region" or "zone" appears in the map, then |
| # all valid keys other than "region" or "zone" must also appear in the |
| # map. |
| "a_key": "A String", |
| }, |
| }, |
| "producerOverride": { # A quota override # Producer override on this quota bucket. |
| "unit": "A String", # The limit unit of the limit to which this override applies. |
| # |
| # An example unit would be: |
| # `1/{project}/{region}` |
| # Note that `{project}` and `{region}` are not placeholders in this example; |
| # the literal characters `{` and `}` occur in the string. |
| "overrideValue": "A String", # The overriding quota limit value. |
| # Can be any nonnegative integer, or -1 (unlimited quota). |
| "name": "A String", # The resource name of the override. |
| # This name is generated by the server when the override is created. |
| # |
| # Example names would be: |
| # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` |
| # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` |
| # |
| # The resource name is intended to be opaque and should not be parsed for |
| # its component strings, since its representation could change in the future. |
| "metric": "A String", # The name of the metric to which this override applies. |
| # |
| # An example name would be: |
| # `compute.googleapis.com/cpus` |
| "dimensions": { # If this map is nonempty, then this override applies only to specific values |
| # for dimensions defined in the limit unit. |
| # |
| # For example, an override on a limit with the unit 1/{project}/{region} |
| # could contain an entry with the key "region" and the value "us-east-1"; |
| # the override is only applied to quota consumed in that region. |
| # |
| # This map has the following restrictions: |
| # |
| # * Keys that are not defined in the limit's unit are not valid keys. |
| # Any string appearing in {brackets} in the unit (besides {project} or |
| # {user}) is a defined key. |
| # * "project" is not a valid key; the project is already specified in |
| # the parent resource name. |
| # * "user" is not a valid key; the API does not support quota overrides |
| # that apply only to a specific user. |
| # * If "region" appears as a key, its value must be a valid Cloud region. |
| # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| # * If any valid key other than "region" or "zone" appears in the map, then |
| # all valid keys other than "region" or "zone" must also appear in the |
| # map. |
| "a_key": "A String", |
| }, |
| }, |
| "consumerOverride": { # A quota override # Consumer override on this quota bucket. |
| "unit": "A String", # The limit unit of the limit to which this override applies. |
| # |
| # An example unit would be: |
| # `1/{project}/{region}` |
| # Note that `{project}` and `{region}` are not placeholders in this example; |
| # the literal characters `{` and `}` occur in the string. |
| "overrideValue": "A String", # The overriding quota limit value. |
| # Can be any nonnegative integer, or -1 (unlimited quota). |
| "name": "A String", # The resource name of the override. |
| # This name is generated by the server when the override is created. |
| # |
| # Example names would be: |
| # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` |
| # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d` |
| # |
| # The resource name is intended to be opaque and should not be parsed for |
| # its component strings, since its representation could change in the future. |
| "metric": "A String", # The name of the metric to which this override applies. |
| # |
| # An example name would be: |
| # `compute.googleapis.com/cpus` |
| "dimensions": { # If this map is nonempty, then this override applies only to specific values |
| # for dimensions defined in the limit unit. |
| # |
| # For example, an override on a limit with the unit 1/{project}/{region} |
| # could contain an entry with the key "region" and the value "us-east-1"; |
| # the override is only applied to quota consumed in that region. |
| # |
| # This map has the following restrictions: |
| # |
| # * Keys that are not defined in the limit's unit are not valid keys. |
| # Any string appearing in {brackets} in the unit (besides {project} or |
| # {user}) is a defined key. |
| # * "project" is not a valid key; the project is already specified in |
| # the parent resource name. |
| # * "user" is not a valid key; the API does not support quota overrides |
| # that apply only to a specific user. |
| # * If "region" appears as a key, its value must be a valid Cloud region. |
| # * If "zone" appears as a key, its value must be a valid Cloud zone. |
| # * If any valid key other than "region" or "zone" appears in the map, then |
| # all valid keys other than "region" or "zone" must also appear in the |
| # map. |
| "a_key": "A String", |
| }, |
| }, |
| "defaultLimit": "A String", # The default limit of this quota bucket, as specified by the service |
| # configuration. |
| "effectiveLimit": "A String", # The effective limit of this quota bucket. Equal to default_limit if there |
| # are no overrides. |
| "dimensions": { # The dimensions of this quota bucket. |
| # |
| # If this map is empty, this is the global bucket, which is the default quota |
| # value applied to all requests that do not have a more specific override. |
| # |
| # If this map is nonempty, the default limit, effective limit, and quota |
| # overrides apply only to requests that have the dimensions given in the map. |
| # |
| # For example, if the map has key "region" and value "us-east-1", then the |
| # specified effective limit is only effective in that region, and the |
| # specified overrides apply only in that region. |
| "a_key": "A String", |
| }, |
| }, |
| ], |
| "unit": "A String", # The limit unit. |
| # |
| # An example unit would be |
| # `1/{project}/{region}` |
| # Note that `{project}` and `{region}` are not placeholders in this example; |
| # the literal characters `{` and `}` occur in the string. |
| "metric": "A String", # The name of the parent metric of this limit. |
| # |
| # An example name would be: |
| # `compute.googleapis.com/cpus` |
| }, |
| ], |
| "displayName": "A String", # The display name of the metric. |
| # |
| # An example name would be: |
| # "CPUs" |
| "name": "A String", # The resource name of the quota settings on this metric for this consumer. |
| # |
| # An example name would be: |
| # `projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus |
| # |
| # The resource name is intended to be opaque and should not be parsed for |
| # its component strings, since its representation could change in the future. |
| "metric": "A String", # The name of the metric. |
| # |
| # An example name would be: |
| # `compute.googleapis.com/cpus` |
| }, |
| ], |
| "nextPageToken": "A String", # Token identifying which result to start with; returned by a previous list |
| # call. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |