com.google.api.services.serviceconsumermanagement.v1.model

Class Quota

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.serviceconsumermanagement.v1.model.Quota

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Quota
extends GenericJson

Quota configuration helps to achieve fairness and budgeting in service usage. The metric based quota configuration works this way: - The service configuration defines a set of metrics. - For API calls, the quota.metric_rules maps methods to metrics with corresponding costs. - The quota.limits defines limits on the metrics, which will be used for quota checks at runtime. An example quota configuration in yaml format: quota: limits: - name: apiWriteQpsPerProject metric: library.googleapis.com/write_calls unit: "1/min/{project}" # rate limit for consumer projects values: STANDARD: 10000 # The metric rules bind all methods to the read_calls metric, # except for the UpdateBook and DeleteBook methods. These two methods # are mapped to the write_calls metric, with the UpdateBook method # consuming at twice rate as the DeleteBook method. metric_rules: - selector: "*" metric_costs: library.googleapis.com/read_calls: 1 - selector: google.example.library.v1.LibraryService.UpdateBook metric_costs: library.googleapis.com/write_calls: 2 - selector: google.example.library.v1.LibraryService.DeleteBook metric_costs: library.googleapis.com/write_calls: 1 Corresponding Metric definition: metrics: - name: library.googleapis.com/read_calls display_name: Read requests metric_kind: DELTA value_type: INT64 - name: library.googleapis.com/write_calls display_name: Write requests metric_kind: DELTA value_type: INT64

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 Consumer Management 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
Quota()

Method Summary

Modifier and Type	Method and Description
Quota	clone()
List<QuotaLimit>	getLimits() List of `QuotaLimit` definitions for the service.
List<MetricRule>	getMetricRules() List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.
Quota	set(String fieldName, Object value)
Quota	setLimits(List<QuotaLimit> limits) List of `QuotaLimit` definitions for the service.
Quota	setMetricRules(List<MetricRule> metricRules) List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.

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

Quota

public Quota()

Method Detail

getLimits

public List<QuotaLimit> getLimits()

List of `QuotaLimit` definitions for the service.

Returns:

value or null for none

setLimits

public Quota setLimits(List<QuotaLimit> limits)

List of `QuotaLimit` definitions for the service.

Parameters:

limits - limits or null for none

getMetricRules

public List<MetricRule> getMetricRules()

List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.

Returns:

value or null for none

setMetricRules

public Quota setMetricRules(List<MetricRule> metricRules)

List of `MetricRule` definitions, each one mapping a selected method to one or more metrics.

Parameters:

metricRules - metricRules or null for none

set

public Quota set(String fieldName,
                 Object value)

Overrides:

set in class GenericJson

clone

public Quota clone()

Overrides:

clone in class GenericJson