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

Class AdminQuotaPolicy

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class AdminQuotaPolicy
extends GenericJson

Quota policy created by quota administrator.

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
AdminQuotaPolicy()

Method Summary

Modifier and Type	Method and Description
AdminQuotaPolicy	clone()
String	getContainer() The cloud resource container at which the quota policy is created.
Map<String,String>	getDimensions() If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit.
String	getMetric() The name of the metric to which this policy applies.
String	getName() The resource name of the policy.
Long	getPolicyValue() The quota policy value.
String	getUnit() The limit unit of the limit to which this policy applies.
AdminQuotaPolicy	set(String fieldName, Object value)
AdminQuotaPolicy	setContainer(String container) The cloud resource container at which the quota policy is created.
AdminQuotaPolicy	setDimensions(Map<String,String> dimensions) If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit.
AdminQuotaPolicy	setMetric(String metric) The name of the metric to which this policy applies.
AdminQuotaPolicy	setName(String name) The resource name of the policy.
AdminQuotaPolicy	setPolicyValue(Long policyValue) The quota policy value.
AdminQuotaPolicy	setUnit(String unit) The limit unit of the limit to which this policy 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

AdminQuotaPolicy

public AdminQuotaPolicy()

Method Detail

getContainer

public String getContainer()

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

Returns:

value or null for none

setContainer

public AdminQuotaPolicy setContainer(String container)

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

Parameters:

container - container or null for none

getDimensions

public Map<String,String> getDimensions()

If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, an 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: * 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. * Keys other than `region` or `zone` are not valid.

Returns:

value or null for none

setDimensions

public AdminQuotaPolicy setDimensions(Map<String,String> dimensions)

If this map is nonempty, then this policy applies only to specific values for dimensions defined in the limit unit. For example, an 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: * 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. * Keys other than `region` or `zone` are not valid.

Parameters:

dimensions - dimensions or null for none

getMetric

public String getMetric()

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

Returns:

value or null for none

setMetric

public AdminQuotaPolicy setMetric(String metric)

The name of the metric to which this policy 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 policy. This name is generated by the server when the policy is created. Example names would be: `organizations/123/services/compute.googleapis.com/consumerQuo taMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d`

Returns:

value or null for none

setName

public AdminQuotaPolicy setName(String name)

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/consumerQuo taMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d`

Parameters:

name - name or null for none

getPolicyValue

public Long getPolicyValue()

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

Returns:

value or null for none

setPolicyValue

public AdminQuotaPolicy setPolicyValue(Long policyValue)

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

Parameters:

policyValue - policyValue or null for none

getUnit

public String getUnit()

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.

Returns:

value or null for none

setUnit

public AdminQuotaPolicy setUnit(String unit)

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.

Parameters:

unit - unit or null for none

set

public AdminQuotaPolicy set(String fieldName,
                            Object value)

Overrides:

set in class GenericJson

clone

public AdminQuotaPolicy clone()

Overrides:

clone in class GenericJson