com.google.api

Class MetricRule.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<MetricRule.Builder>

com.google.api.MetricRule.Builder

All Implemented Interfaces:

MetricRuleOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, java.lang.Cloneable

Enclosing class:

MetricRule

public static final class MetricRule.Builder
extends GeneratedMessageV3.Builder<MetricRule.Builder>
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

Method Summary

Modifier and Type	Method and Description
MetricRule.Builder	addRepeatedField(Descriptors.FieldDescriptor field, java.lang.Object value)
MetricRule	build()
MetricRule	buildPartial()
MetricRule.Builder	clear()
MetricRule.Builder	clearField(Descriptors.FieldDescriptor field)
MetricRule.Builder	clearMetricCosts()
MetricRule.Builder	clearOneof(Descriptors.OneofDescriptor oneof)
MetricRule.Builder	clearSelector() Selects the methods to which this rule applies.
MetricRule.Builder	clone()
boolean	containsMetricCosts(java.lang.String key) Metrics to update when the selected methods are called, and the associated cost applied to each metric.
MetricRule	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()
java.util.Map<java.lang.String,java.lang.Long>	getMetricCosts() Deprecated.
int	getMetricCostsCount() Metrics to update when the selected methods are called, and the associated cost applied to each metric.
java.util.Map<java.lang.String,java.lang.Long>	getMetricCostsMap() Metrics to update when the selected methods are called, and the associated cost applied to each metric.
long	getMetricCostsOrDefault(java.lang.String key, long defaultValue) Metrics to update when the selected methods are called, and the associated cost applied to each metric.
long	getMetricCostsOrThrow(java.lang.String key) Metrics to update when the selected methods are called, and the associated cost applied to each metric.
java.util.Map<java.lang.String,java.lang.Long>	getMutableMetricCosts() Deprecated.
java.lang.String	getSelector() Selects the methods to which this rule applies.
ByteString	getSelectorBytes() Selects the methods to which this rule applies.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected MapField	internalGetMapField(int number)
protected MapField	internalGetMutableMapField(int number)
boolean	isInitialized()
MetricRule.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
MetricRule.Builder	mergeFrom(Message other)
MetricRule.Builder	mergeFrom(MetricRule other)
MetricRule.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)
MetricRule.Builder	putAllMetricCosts(java.util.Map<java.lang.String,java.lang.Long> values) Metrics to update when the selected methods are called, and the associated cost applied to each metric.
MetricRule.Builder	putMetricCosts(java.lang.String key, long value) Metrics to update when the selected methods are called, and the associated cost applied to each metric.
MetricRule.Builder	removeMetricCosts(java.lang.String key) Metrics to update when the selected methods are called, and the associated cost applied to each metric.
MetricRule.Builder	setField(Descriptors.FieldDescriptor field, java.lang.Object value)
MetricRule.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, java.lang.Object value)
MetricRule.Builder	setSelector(java.lang.String value) Selects the methods to which this rule applies.
MetricRule.Builder	setSelectorBytes(ByteString value) Selects the methods to which this rule applies.
MetricRule.Builder	setUnknownFields(UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetMapField

protected MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class GeneratedMessageV3.Builder<MetricRule.Builder>

internalGetMutableMapField

protected MapField internalGetMutableMapField(int number)

Overrides:

internalGetMutableMapField in class GeneratedMessageV3.Builder<MetricRule.Builder>

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<MetricRule.Builder>

clear

public MetricRule.Builder clear()

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<MetricRule.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<MetricRule.Builder>

getDefaultInstanceForType

public MetricRule getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public MetricRule build()

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public MetricRule buildPartial()

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public MetricRule.Builder clone()

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<MetricRule.Builder>

setField

public MetricRule.Builder setField(Descriptors.FieldDescriptor field,
                                   java.lang.Object value)

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<MetricRule.Builder>

clearField

public MetricRule.Builder clearField(Descriptors.FieldDescriptor field)

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<MetricRule.Builder>

clearOneof

public MetricRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<MetricRule.Builder>

setRepeatedField

public MetricRule.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                           int index,
                                           java.lang.Object value)

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<MetricRule.Builder>

addRepeatedField

public MetricRule.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                           java.lang.Object value)

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<MetricRule.Builder>

mergeFrom

public MetricRule.Builder mergeFrom(Message other)

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<MetricRule.Builder>

mergeFrom

public MetricRule.Builder mergeFrom(MetricRule other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<MetricRule.Builder>

mergeFrom

public MetricRule.Builder mergeFrom(CodedInputStream input,
                                    ExtensionRegistryLite extensionRegistry)
                             throws java.io.IOException

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<MetricRule.Builder>

Throws:

java.io.IOException

getSelector

public java.lang.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

getSelectorBytes

public 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

setSelector

public MetricRule.Builder setSelector(java.lang.String value)

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

string selector = 1;

clearSelector

public MetricRule.Builder clearSelector()

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

string selector = 1;

setSelectorBytes

public MetricRule.Builder setSelectorBytes(ByteString value)

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

string selector = 1;

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(java.lang.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 java.util.Map<java.lang.String,java.lang.Long> getMetricCosts()

Deprecated.

Use getMetricCostsMap() instead.

Specified by:

getMetricCosts in interface MetricRuleOrBuilder

getMetricCostsMap

public java.util.Map<java.lang.String,java.lang.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(java.lang.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(java.lang.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

clearMetricCosts

public MetricRule.Builder clearMetricCosts()

removeMetricCosts

public MetricRule.Builder removeMetricCosts(java.lang.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;

getMutableMetricCosts

@Deprecated
public java.util.Map<java.lang.String,java.lang.Long> getMutableMetricCosts()

Deprecated.

Use alternate mutation accessors instead.

putMetricCosts

public MetricRule.Builder putMetricCosts(java.lang.String key,
                                         long value)

 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;

putAllMetricCosts

public MetricRule.Builder putAllMetricCosts(java.util.Map<java.lang.String,java.lang.Long> values)

 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;

setUnknownFields

public final MetricRule.Builder setUnknownFields(UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<MetricRule.Builder>

mergeUnknownFields

public final MetricRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<MetricRule.Builder>