com.google.api.services.serviceusage.v1.model

Class QuotaOverride

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.serviceusage.v1.model.QuotaOverride

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class QuotaOverride
extends GenericJson

A quota override

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Service Usage API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
QuotaOverride()

Method Summary

Modifier and Type	Method and Description
QuotaOverride	clone()
String	getAdminOverrideAncestor() The resource name of the ancestor that requested the override.
Map<String,String>	getDimensions() If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
String	getMetric() The name of the metric to which this override applies.
String	getName() The resource name of the override.
Long	getOverrideValue() The overriding quota limit value.
String	getUnit() The limit unit of the limit to which this override applies.
QuotaOverride	set(String fieldName, Object value)
QuotaOverride	setAdminOverrideAncestor(String adminOverrideAncestor) The resource name of the ancestor that requested the override.
QuotaOverride	setDimensions(Map<String,String> dimensions) If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.
QuotaOverride	setMetric(String metric) The name of the metric to which this override applies.
QuotaOverride	setName(String name) The resource name of the override.
QuotaOverride	setOverrideValue(Long overrideValue) The overriding quota limit value.
QuotaOverride	setUnit(String unit) The limit unit of the limit to which this override applies.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

QuotaOverride

public QuotaOverride()

Method Detail

getAdminOverrideAncestor

public String getAdminOverrideAncestor()

The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only.

Returns:

value or null for none

setAdminOverrideAncestor

public QuotaOverride setAdminOverrideAncestor(String adminOverrideAncestor)

The resource name of the ancestor that requested the override. For example: `organizations/12345` or `folders/67890`. Used by admin overrides only.

Parameters:

adminOverrideAncestor - adminOverrideAncestor or null for none

getDimensions

public Map<String,String> getDimensions()

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.

Returns:

value or null for none

setDimensions

public QuotaOverride setDimensions(Map<String,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.

Parameters:

dimensions - dimensions or null for none

getMetric

public String getMetric()

The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus`

Returns:

value or null for none

setMetric

public QuotaOverride setMetric(String metric)

The name of the metric to which this override applies. An example name would be: `compute.googleapis.com/cpus`

Parameters:

metric - metric or null for none

getName

public String getName()

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/consumerQuotaMet rics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` `project s/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.

Returns:

value or null for none

setName

public QuotaOverride setName(String name)

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/consumerQuotaMet rics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d` `project s/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.

Parameters:

name - name or null for none

getOverrideValue

public Long getOverrideValue()

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

Returns:

value or null for none

setOverrideValue

public QuotaOverride setOverrideValue(Long overrideValue)

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

Parameters:

overrideValue - overrideValue or null for none

getUnit

public String getUnit()

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.

Returns:

value or null for none

setUnit

public QuotaOverride setUnit(String unit)

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.

Parameters:

unit - unit or null for none

set

public QuotaOverride set(String fieldName,
                         Object value)

Overrides:

set in class GenericJson

clone

public QuotaOverride clone()

Overrides:

clone in class GenericJson