Class MetricRule (2.2.0)

public sealed class MetricRule : Protobuf.IMessage<MetricRule>, Protobuf.IBufferMessage

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
Name Description
other MetricRule

Fields

MetricCostsFieldNumber

public const int MetricCostsFieldNumber = 2

Field number for the "metric_costs" field.

Field Value
Type Description
Int32

SelectorFieldNumber

public const int SelectorFieldNumber = 1

Field number for the "selector" field.

Field Value
Type Description
Int32

Properties

Descriptor

public static Protobuf.Reflection.MessageDescriptor Descriptor { get; }
Property Value
Type Description
Protobuf.Reflection.MessageDescriptor

MetricCosts

public Protobuf.Collections.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
Type Description
Protobuf.Collections.MapField<String, Int64>

Parser

public static Protobuf.MessageParser<MetricRule> Parser { get; }
Property Value
Type Description
Protobuf.MessageParser<MetricRule>

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
Type Description
String

Methods

CalculateSize()

public int CalculateSize()
Returns
Type Description
Int32

Clone()

public MetricRule Clone()
Returns
Type Description
MetricRule

Equals(MetricRule)

public bool Equals(MetricRule other)
Parameter
Name Description
other MetricRule
Returns
Type Description
Boolean

Equals(Object)

public override bool Equals(object other)
Parameter
Name Description
other Object
Returns
Type Description
Boolean

GetHashCode()

public override int GetHashCode()
Returns
Type Description
Int32

MergeFrom(MetricRule)

public void MergeFrom(MetricRule other)
Parameter
Name Description
other MetricRule

MergeFrom(Protobuf.CodedInputStream)

public void MergeFrom(Protobuf.CodedInputStream input)
Parameter
Name Description
input Protobuf.CodedInputStream

ToString()

public override string ToString()
Returns
Type Description
String

WriteTo(Protobuf.CodedOutputStream)

public void WriteTo(Protobuf.CodedOutputStream output)
Parameter
Name Description
output Protobuf.CodedOutputStream