Some or all of the information on this page might not apply to Trusted Cloud by S3NS.
Class MetricRule (2.9.6)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version 2.9.6keyboard_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
Static Fields
METRIC_COSTS_FIELD_NUMBER
public static final int METRIC_COSTS_FIELD_NUMBER
Field Value
SELECTOR_FIELD_NUMBER
public static final int SELECTOR_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static MetricRule getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static MetricRule . Builder newBuilder ()
Returns
newBuilder(MetricRule prototype)
public static MetricRule . Builder newBuilder ( MetricRule prototype )
Parameter
Returns
public static MetricRule parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static MetricRule parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static MetricRule parseFrom ( byte [] data )
Parameter
Name Description
data byte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static MetricRule parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static MetricRule parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static MetricRule parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static MetricRule parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static MetricRule parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static MetricRule parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static MetricRule parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static MetricRule parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static MetricRule parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<MetricRule> parser ()
Returns
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
Returns
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getDefaultInstanceForType()
public MetricRule getDefaultInstanceForType ()
Returns
getMetricCosts()
public Map<String , Long > getMetricCosts ()
Returns
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
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;
Returns
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
Returns
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
Returns
getParserForType()
public Parser<MetricRule> getParserForType ()
Returns
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
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField ( int number )
Parameter
Name Description
number int
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public MetricRule . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected MetricRule . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public MetricRule . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
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-08-07 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[]]
