REST Resource: folders.locations.quotaPreferences

Resource: QuotaPreference

QuotaPreference represents the preferred quota configuration specified for a project, folder or organization. There is only one QuotaPreference resource for a quota value targeting a unique set of dimensions.

JSON representation
{
  "name": string,
  "dimensions": {
    string: string,
    ...
  },
  "quotaConfig": {
    object (QuotaConfig)
  },
  "etag": string,
  "createTime": string,
  "updateTime": string,
  "service": string,
  "quotaId": string,
  "reconciling": boolean,
  "justification": string,
  "contactEmail": string
}
Fields
name

string

Required except in the CREATE requests. The resource name of the quota preference. The ID component following "locations/" must be "global". Example: projects/123/locations/global/quotaPreferences/my-config-for-us-east1

dimensions

map (key: string, value: string)

Immutable. The dimensions that this quota preference applies to. The key of the map entry is the name of a dimension, such as "region", "zone", "network_id", and the value of the map entry is the dimension value.

If a dimension is missing from the map of dimensions, the quota preference applies to all the dimension values except for those that have other quota preferences configured for the specific value.

NOTE: QuotaPreferences can only be applied across all values of "user" and "resource" dimension. Do not set values for "user" or "resource" in the dimension map.

Example: {"provider", "Foo Inc"} where "provider" is a service specific dimension.

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

quotaConfig

object (QuotaConfig)

Required. Preferred quota configuration.

etag

string

Optional. The current etag of the quota preference. If an etag is provided on update and does not match the current server's etag of the quota preference, the request will be blocked and an ABORTED error will be returned. See https://google.aip.dev/134#etags for more details on etags.

createTime

string (Timestamp format)

Output only. Create time stamp

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. Update time stamp

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

service

string

Required. The name of the service to which the quota preference is applied.

quotaId

string

Required. The id of the quota to which the quota preference is applied. A quota name is unique in the service. Example: CpusPerProjectPerRegion

reconciling

boolean

Output only. Is the quota preference pending Google Cloud approval and fulfillment.

justification

string

The reason / justification for this quota preference.

contactEmail

string

Required. Input only. An email address that can be used for quota related communication between the Google Cloud and the user in case the Google Cloud needs further information to make a decision on whether the user preferred quota can be granted.

The Google account for the email address must have quota update permission for the project, folder or organization this quota preference is for.

QuotaConfig

The preferred quota configuration.

JSON representation
{
  "preferredValue": string,
  "stateDetail": string,
  "grantedValue": string,
  "traceId": string,
  "annotations": {
    string: string,
    ...
  },
  "requestOrigin": enum (Origin)
}
Fields
preferredValue

string (int64 format)

Required. The preferred value. Must be greater than or equal to -1. If set to -1, it means the value is "unlimited".

stateDetail

string

Output only. Optional details about the state of this quota preference.

grantedValue

string (Int64Value format)

Output only. Granted quota value.

traceId

string

Output only. The trace id that the Google Cloud uses to provision the requested quota. This trace id may be used by the client to contact Cloud support to track the state of a quota preference request. The trace id is only produced for increase requests and is unique for each request. The quota decrease requests do not have a trace id.

annotations

map (key: string, value: string)

Optional. The annotations map for clients to store small amounts of arbitrary data. Do not put PII or other sensitive information here. See https://google.aip.dev/128#annotations

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

requestOrigin

enum (Origin)

Output only. The origin of the quota preference request.

Origin

The enumeration of the origins of quota preference requests.

Enums
ORIGIN_UNSPECIFIED The unspecified value.
CLOUD_CONSOLE Created through Cloud Console.
AUTO_ADJUSTER Generated by automatic quota adjustment.

Methods

create

Creates a new QuotaPreference that declares the desired value for a quota.

get

Gets details of a single QuotaPreference.

list

Lists QuotaPreferences in a given project, folder or organization.

patch

Updates the parameters of a single QuotaPreference.