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)
    }
  ]
}
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).

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)
  },
  "dimensions": {
    string: string,
    ...
  }
}
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.

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" }.

Methods

get

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