public final class MetricRule extends GeneratedMessageV3 implements MetricRuleOrBuilderBind 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
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > MetricRuleImplements
MetricRuleOrBuilderStatic Fields
METRIC_COSTS_FIELD_NUMBER
public static final int METRIC_COSTS_FIELD_NUMBER| Type | Description |
int |
SELECTOR_FIELD_NUMBER
public static final int SELECTOR_FIELD_NUMBER| Type | Description |
int |
Static Methods
getDefaultInstance()
public static MetricRule getDefaultInstance()| Type | Description |
MetricRule |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
Descriptor |
newBuilder()
public static MetricRule.Builder newBuilder()| Type | Description |
MetricRule.Builder |
newBuilder(MetricRule prototype)
public static MetricRule.Builder newBuilder(MetricRule prototype)| Name | Description |
prototype | MetricRule |
| Type | Description |
MetricRule.Builder |
parseDelimitedFrom(InputStream input)
public static MetricRule parseDelimitedFrom(InputStream input)| Name | Description |
input | InputStream |
| Type | Description |
MetricRule |
| Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static MetricRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
MetricRule |
| Type | Description |
IOException |
parseFrom(byte[] data)
public static MetricRule parseFrom(byte[] data)| Name | Description |
data | byte[] |
| Type | Description |
MetricRule |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static MetricRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
MetricRule |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static MetricRule parseFrom(ByteString data)| Name | Description |
data | ByteString |
| Type | Description |
MetricRule |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static MetricRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
MetricRule |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static MetricRule parseFrom(CodedInputStream input)| Name | Description |
input | CodedInputStream |
| Type | Description |
MetricRule |
| Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static MetricRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
MetricRule |
| Type | Description |
IOException |
parseFrom(InputStream input)
public static MetricRule parseFrom(InputStream input)| Name | Description |
input | InputStream |
| Type | Description |
MetricRule |
| Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static MetricRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
MetricRule |
| Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static MetricRule parseFrom(ByteBuffer data)| Name | Description |
data | ByteBuffer |
| Type | Description |
MetricRule |
| Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static MetricRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
| Type | Description |
MetricRule |
| Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<MetricRule> parser()| Type | Description |
Parser<MetricRule> |
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;
| Name | Description |
key | String |
| Type | Description |
boolean |
equals(Object obj)
public boolean equals(Object obj)| Name | Description |
obj | Object |
| Type | Description |
boolean |
getDefaultInstanceForType()
public MetricRule getDefaultInstanceForType()| Type | Description |
MetricRule |
getMetricCosts()
public Map<String,Long> getMetricCosts()Use #getMetricCostsMap() instead.
| Type | Description |
Map<String,Long> |
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;
| 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;
| Type | Description |
Map<String,Long> |
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;
| Name | Description |
key | String |
defaultValue | long |
| 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;
| Name | Description |
key | String |
| Type | Description |
long |
getParserForType()
public Parser<MetricRule> getParserForType()| Type | Description |
Parser<MetricRule> |
getSelector()
public String getSelector()Selects the methods to which this rule applies. Refer to selector for syntax details.
string selector = 1;
| 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;
| Type | Description |
ByteString | The bytes for selector. |
getSerializedSize()
public int getSerializedSize()| Type | Description |
int |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()| Type | Description |
UnknownFieldSet |
hashCode()
public int hashCode()| Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
FieldAccessorTable |
internalGetMapField(int number)
protected MapField internalGetMapField(int number)| Name | Description |
number | int |
| Type | Description |
MapField |
isInitialized()
public final boolean isInitialized()| Type | Description |
boolean |
newBuilderForType()
public MetricRule.Builder newBuilderForType()| Type | Description |
MetricRule.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected MetricRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Name | Description |
parent | BuilderParent |
| Type | Description |
MetricRule.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Name | Description |
unused | UnusedPrivateParameter |
| Type | Description |
Object |
toBuilder()
public MetricRule.Builder toBuilder()| Type | Description |
MetricRule.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Name | Description |
output | CodedOutputStream |
| Type | Description |
IOException |