Class MetricRule (2.10.0)

public sealed class MetricRule : IMessage<MetricRule>, IEquatable<MetricRule>, IDeepCloneable<MetricRule>, IBufferMessage, IMessage

Bind API methods to metrics. Binding a method to a metric causes that metric's configured quota behaviors to apply to the method call.

Inheritance

object > MetricRule

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

MetricRule()

public MetricRule()

MetricRule(MetricRule)

public MetricRule(MetricRule other)
Parameter
NameDescription
otherMetricRule

Fields

MetricCostsFieldNumber

public const int MetricCostsFieldNumber = 2

Field number for the "metric_costs" field.

Field Value
TypeDescription
int

SelectorFieldNumber

public const int SelectorFieldNumber = 1

Field number for the "selector" field.

Field Value
TypeDescription
int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }
Property Value
TypeDescription
MessageDescriptor

MetricCosts

public MapField<string, long> MetricCosts { get; }

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.

Property Value
TypeDescription
MapFieldstringlong

Parser

public static MessageParser<MetricRule> Parser { get; }
Property Value
TypeDescription
MessageParserMetricRule

Selector

public string Selector { get; set; }

Selects the methods to which this rule applies.

Refer to [selector][google.api.DocumentationRule.selector] for syntax details.

Property Value
TypeDescription
string

Methods

CalculateSize()

public int CalculateSize()
Returns
TypeDescription
int

Clone()

public MetricRule Clone()
Returns
TypeDescription
MetricRule

Equals(MetricRule)

public bool Equals(MetricRule other)
Parameter
NameDescription
otherMetricRule
Returns
TypeDescription
bool

Equals(object)

public override bool Equals(object other)
Parameter
NameDescription
otherobject
Returns
TypeDescription
bool
Overrides

GetHashCode()

public override int GetHashCode()
Returns
TypeDescription
int
Overrides

MergeFrom(MetricRule)

public void MergeFrom(MetricRule other)
Parameter
NameDescription
otherMetricRule

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream

ToString()

public override string ToString()
Returns
TypeDescription
string
Overrides

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream