Service Usage API . services . consumerQuotaMetrics . limits

Instance Methods

adminOverrides()

Returns the adminOverrides Resource.

consumerOverrides()

Returns the consumerOverrides Resource.

get(name=None, x__xgafv=None, view=None)

Retrieves a summary of quota information for a specific quota limit.

Method Details

get(name=None, x__xgafv=None, view=None)
Retrieves a summary of quota information for a specific quota limit.

Args:
  name: string, The resource name of the quota limit.

Use the quota limit resource name returned by previous
ListConsumerQuotaMetrics and GetConsumerQuotaMetric API calls. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format
  view: string, Specifies the level of detail for quota information in the response.

Returns:
  An object of the form:

    { # 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.
    "isPrecise": True or False, # Whether this limit is precise or imprecise.
    "metric": "A String", # The name of the parent metric of this limit.
        #
        # An example name would be:
        # `compute.googleapis.com/cpus`
    "allowsAdminOverrides": True or False, # Whether admin overrides are allowed on this limit
    "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.
        "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",
        },
        "producerOverride": { # A quota override # Producer override on this quota bucket.
          "metric": "A String", # The name of the metric to which this override applies.
              #
              # An example name would be:
              # `compute.googleapis.com/cpus`
          "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.
          "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",
          },
          "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.
        },
        "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.
        "adminOverride": { # A quota override # Admin override on this quota bucket.
          "metric": "A String", # The name of the metric to which this override applies.
              #
              # An example name would be:
              # `compute.googleapis.com/cpus`
          "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.
          "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",
          },
          "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.
        },
        "consumerOverride": { # A quota override # Consumer override on this quota bucket.
          "metric": "A String", # The name of the metric to which this override applies.
              #
              # An example name would be:
              # `compute.googleapis.com/cpus`
          "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.
          "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",
          },
          "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.
        },
      },
    ],
    "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.
  }