target.apidocs.com.google.api.services.servicemanagement.model.MetricRule.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-servicemanagement Show documentation

There is a newer version: v1-rev20241106-2.0.0

Show newest version







MetricRule (Service Management API v1-rev20240823-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.servicemanagement.model
Class MetricRule



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.servicemanagement.model.MetricRule













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class MetricRule
extends com.google.api.client.json.GenericJson
Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota
 behaviors to apply to the method call.

  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 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
com.google.api.client.util.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


MetricRule() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


MetricRule
clone() 


Map<String,Long>
getMetricCosts()
Metrics to update when the selected methods are called, and the associated cost applied to each
 metric.



String
getSelector()
Selects the methods to which this rule applies.



MetricRule
set(String fieldName,
   Object value) 


MetricRule
setMetricCosts(Map<String,Long> metricCosts)
Metrics to update when the selected methods are called, and the associated cost applied to each
 metric.



MetricRule
setSelector(String selector)
Selects the methods to which this rule 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





MetricRule
public MetricRule()









Method Detail





getMetricCosts
public Map<String,Long> getMetricCosts()
Metrics to update when the selected methods are called, and the associated cost applied to each
 metric. The key of the map is the metric name, and the values are the amount increased for the
 metric against which the quota limits are defined. The value must not be negative.

Returns:
value or null for none








setMetricCosts
public MetricRule setMetricCosts(Map<String,Long> metricCosts)
Metrics to update when the selected methods are called, and the associated cost applied to each
 metric. The key of the map is the metric name, and the values are the amount increased for the
 metric against which the quota limits are defined. The value must not be negative.

Parameters:
metricCosts - metricCosts or null for none








getSelector
public String getSelector()
Selects the methods to which this rule applies. Refer to selector for syntax details.

Returns:
value or null for none








setSelector
public MetricRule setSelector(String selector)
Selects the methods to which this rule applies. Refer to selector for syntax details.

Parameters:
selector - selector or null for none








set
public MetricRule set(String fieldName,
                      Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public MetricRule clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`MetricRule`	`clone()`
`Map<String,Long>`	`getMetricCosts()` Metrics to update when the selected methods are called, and the associated cost applied to each metric.
`String`	`getSelector()` Selects the methods to which this rule applies.
`MetricRule`	`set(String fieldName, Object value)`
`MetricRule`	`setMetricCosts(Map<String,Long> metricCosts)` Metrics to update when the selected methods are called, and the associated cost applied to each metric.
`MetricRule`	`setSelector(String selector)` Selects the methods to which this rule applies.