REST Resource: projects.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

Input only. An email address that can be used to contact the the user, in case Google Cloud needs more information to make a decision before additional quota can be granted.

When requesting a quota increase, the email address is required. When requesting a quota decrease, the email address is optional. For example, the email address is optional when the QuotaConfig.preferred_value is smaller than the QuotaDetails.reset_value.

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.