Send feedback
Class MetricRule (2.45.1)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.45.1 keyboard_arrow_down
public final class MetricRule extends GeneratedMessageV3 implements MetricRuleOrBuilder
Bind API methods to metrics. Binding a method to a metric causes that
metric's configured quota behaviors to apply to the method call.
Protobuf type google.api.MetricRule
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
METRIC_COSTS_FIELD_NUMBER
public static final int METRIC_COSTS_FIELD_NUMBER
Field Value
Type Description
int
SELECTOR_FIELD_NUMBER
public static final int SELECTOR_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static MetricRule getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static MetricRule . Builder newBuilder ()
newBuilder(MetricRule prototype)
public static MetricRule . Builder newBuilder ( MetricRule prototype )
public static MetricRule parseDelimitedFrom ( InputStream input )
public static MetricRule parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static MetricRule parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static MetricRule parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static MetricRule parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static MetricRule parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static MetricRule parseFrom ( CodedInputStream input )
public static MetricRule parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static MetricRule parseFrom ( InputStream input )
public static MetricRule parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static MetricRule parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static MetricRule parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<MetricRule> parser ()
Methods
containsMetricCosts(String key)
public boolean containsMetricCosts ( String key )
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.
map<string, int64> metric_costs = 2;
Parameter
Name Description
keyString
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public MetricRule getDefaultInstanceForType ()
getMetricCosts() (deprecated)
public Map<String , Long > getMetricCosts ()
getMetricCostsCount()
public int getMetricCostsCount ()
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.
map<string, int64> metric_costs = 2;
Returns
Type Description
int
getMetricCostsMap()
public Map<String , Long > getMetricCostsMap ()
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.
map<string, int64> metric_costs = 2;
getMetricCostsOrDefault(String key, long defaultValue)
public long getMetricCostsOrDefault ( String key , long defaultValue )
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.
map<string, int64> metric_costs = 2;
Parameters
Name Description
keyString
defaultValuelong
Returns
Type Description
long
getMetricCostsOrThrow(String key)
public long getMetricCostsOrThrow ( String key )
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.
map<string, int64> metric_costs = 2;
Parameter
Name Description
keyString
Returns
Type Description
long
getParserForType()
public Parser<MetricRule> getParserForType ()
Overrides
getSelector()
public String getSelector ()
Selects the methods to which this rule applies.
Refer to selector for syntax
details.
string selector = 1;
Returns
Type Description
String The selector.
getSelectorBytes()
public ByteString getSelectorBytes ()
Selects the methods to which this rule applies.
Refer to selector for syntax
details.
string selector = 1;
Returns
Type Description
ByteString The bytes for selector.
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection ( int number )
Parameter
Name Description
numberint
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public MetricRule . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected MetricRule . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public MetricRule . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
