com.google.api

Class MetricRule

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.api.MetricRule

All Implemented Interfaces:

MetricRuleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class MetricRule
extends com.google.protobuf.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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetricRule.Builder Bind API methods to metrics.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	METRIC_COSTS_FIELD_NUMBER
static int	SELECTOR_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsMetricCosts(String key) Metrics to update when the selected methods are called, and the associated cost applied to each metric.
boolean	equals(Object obj)
static MetricRule	getDefaultInstance()
MetricRule	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Map<String,Long>	getMetricCosts() Deprecated.
int	getMetricCostsCount() Metrics to update when the selected methods are called, and the associated cost applied to each metric.
Map<String,Long>	getMetricCostsMap() Metrics to update when the selected methods are called, and the associated cost applied to each metric.
long	getMetricCostsOrDefault(String key, long defaultValue) Metrics to update when the selected methods are called, and the associated cost applied to each metric.
long	getMetricCostsOrThrow(String key) Metrics to update when the selected methods are called, and the associated cost applied to each metric.
com.google.protobuf.Parser<MetricRule>	getParserForType()
String	getSelector() Selects the methods to which this rule applies.
com.google.protobuf.ByteString	getSelectorBytes() Selects the methods to which this rule applies.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static MetricRule.Builder	newBuilder()
static MetricRule.Builder	newBuilder(MetricRule prototype)
MetricRule.Builder	newBuilderForType()
protected MetricRule.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static MetricRule	parseDelimitedFrom(InputStream input)
static MetricRule	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MetricRule	parseFrom(byte[] data)
static MetricRule	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MetricRule	parseFrom(ByteBuffer data)
static MetricRule	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MetricRule	parseFrom(com.google.protobuf.ByteString data)
static MetricRule	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MetricRule	parseFrom(com.google.protobuf.CodedInputStream input)
static MetricRule	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static MetricRule	parseFrom(InputStream input)
static MetricRule	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<MetricRule>	parser()
MetricRule.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SELECTOR_FIELD_NUMBER

public static final int SELECTOR_FIELD_NUMBER

See Also:

Constant Field Values

METRIC_COSTS_FIELD_NUMBER

public static final int METRIC_COSTS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getSelector

public String getSelector()

 Selects the methods to which this rule applies.
 Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
 

string selector = 1;

Specified by:

getSelector in interface MetricRuleOrBuilder

Returns:

The selector.

getSelectorBytes

public com.google.protobuf.ByteString getSelectorBytes()

 Selects the methods to which this rule applies.
 Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
 

string selector = 1;

Specified by:

getSelectorBytes in interface MetricRuleOrBuilder

Returns:

The bytes for selector.

getMetricCostsCount

public int getMetricCostsCount()

Description copied from interface: MetricRuleOrBuilder

 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;

Specified by:

getMetricCostsCount in interface MetricRuleOrBuilder

containsMetricCosts

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;

Specified by:

containsMetricCosts in interface MetricRuleOrBuilder

getMetricCosts

@Deprecated
public Map<String,Long> getMetricCosts()

Deprecated.

Use getMetricCostsMap() instead.

Specified by:

getMetricCosts in interface MetricRuleOrBuilder

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;

Specified by:

getMetricCostsMap in interface MetricRuleOrBuilder

getMetricCostsOrDefault

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;

Specified by:

getMetricCostsOrDefault in interface MetricRuleOrBuilder

getMetricCostsOrThrow

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;

Specified by:

getMetricCostsOrThrow in interface MetricRuleOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static MetricRule parseFrom(ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MetricRule parseFrom(ByteBuffer data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MetricRule parseFrom(com.google.protobuf.ByteString data)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MetricRule parseFrom(com.google.protobuf.ByteString data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MetricRule parseFrom(byte[] data)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MetricRule parseFrom(byte[] data,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static MetricRule parseFrom(InputStream input)
                            throws IOException

Throws:

IOException

parseFrom

public static MetricRule parseFrom(InputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static MetricRule parseDelimitedFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

public static MetricRule parseDelimitedFrom(InputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Throws:

IOException

parseFrom

public static MetricRule parseFrom(com.google.protobuf.CodedInputStream input)
                            throws IOException

Throws:

IOException

parseFrom

public static MetricRule parseFrom(com.google.protobuf.CodedInputStream input,
                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                            throws IOException

Throws:

IOException

newBuilderForType

public MetricRule.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static MetricRule.Builder newBuilder()

newBuilder

public static MetricRule.Builder newBuilder(MetricRule prototype)

toBuilder

public MetricRule.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected MetricRule.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static MetricRule getDefaultInstance()

parser

public static com.google.protobuf.Parser<MetricRule> parser()

getParserForType

public com.google.protobuf.Parser<MetricRule> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public MetricRule getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder