REST Resource: services.consumerQuotaMetrics.limits

Resource: ConsumerQuotaLimit

Consumer quota settings for a quota limit.

JSON representation 
{
  "name": string,
  "metric": string,
  "unit": string,
  "isPrecise": boolean,
  "allowsAdminOverrides": boolean,
  "quotaBuckets": [
    {
      object (QuotaBucket)
    }
  ],
  "supportedLocations": [
    string
  ]
}
Fields
name

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.
metric

string

The name of the parent metric of this limit.

An example name would be: compute.googleapis.com/cpus
unit

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.
isPrecise

boolean

Whether this limit is precise or imprecise.
allowsAdminOverrides

boolean

Whether admin overrides are allowed on this limit
quotaBuckets[]

object (QuotaBucket)

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).
supportedLocations[]

string

List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension.

QuotaBucket

A quota bucket is a quota provisioning unit for a specific set of dimensions.

JSON representation 
{
  "effectiveLimit": string,
  "defaultLimit": string,
  "producerOverride": {
    object (QuotaOverride)
  },
  "consumerOverride": {
    object (QuotaOverride)
  },
  "adminOverride": {
    object (QuotaOverride)
  },
  "producerQuotaPolicy": {
    object (ProducerQuotaPolicy)
  },
  "dimensions": {
    string: string,
    ...
  },
  "rolloutInfo": {
    object (RolloutInfo)
  }
}
Fields
effectiveLimit

string (int64 format)

The effective limit of this quota bucket. Equal to defaultLimit if there are no overrides.
defaultLimit

string (int64 format)

The default limit of this quota bucket, as specified by the service configuration.
producerOverride

object (QuotaOverride)

Producer override on this quota bucket.
consumerOverride

object (QuotaOverride)

Consumer override on this quota bucket.
adminOverride

object (QuotaOverride)

Admin override on this quota bucket.
producerQuotaPolicy

object (ProducerQuotaPolicy)

Producer policy inherited from the closet ancestor of the current consumer.
dimensions

map (key: string, value: string)

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.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
rolloutInfo

object (RolloutInfo)

Rollout information of this quota bucket. This field is present only if the effective limit will change due to the ongoing rollout of the service config.

ProducerQuotaPolicy

Quota policy created by service producer.

JSON representation 
{
  "name": string,
  "policyValue": string,
  "dimensions": {
    string: string,
    ...
  },
  "metric": string,
  "unit": string,
  "container": string
}
Fields
name

string

The resource name of the policy. This name is generated by the server when the policy is created.

Example names would be: organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/producerQuotaPolicies/4a3f2c1d
policyValue

string (int64 format)

The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota).
dimensions

map (key: string, value: string)

If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit.

For example, a policy on a limit with the unit 1/{project}/{region} could contain an entry with the key region and the value us-east-1; the policy 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 policies 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.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
metric

string

The name of the metric to which this policy applies.

An example name would be: compute.googleapis.com/cpus
unit

string

The limit unit of the limit to which this policy 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.
container

string

The cloud resource container at which the quota policy is created. The format is {container_type}/{container_number}

RolloutInfo

[Output only] Rollout information of a quota.

JSON representation 
{
  "defaultLimitOngoingRollout": boolean
}
Fields
defaultLimitOngoingRollout

boolean

Whether there is an ongoing rollout for the default limit or not.

Methods

get

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