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

Implements

IMessage MetricRule, IEquatable MetricRule, IDeepCloneable MetricRule, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

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
`int`

SelectorFieldNumber

public const int SelectorFieldNumber = 1

Field number for the "selector" field.

Field Value
Type	Description
`int`

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value
Type	Description
`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
Type	Description
`MapFieldstringlong`

Parser

public static MessageParser<MetricRule> Parser { get; }

Property Value
Type	Description
`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
Type	Description
`string`

Methods

CalculateSize()

public int CalculateSize()

Returns
Type	Description
`int`

Clone()

public MetricRule Clone()

Returns
Type	Description
`MetricRule`

Equals(MetricRule)

public bool Equals(MetricRule other)

Parameter
Name	Description
`other`	`MetricRule`

Returns
Type	Description
`bool`

Equals(object)

public override bool Equals(object other)

Parameter
Name	Description
`other`	`object`

Returns
Type	Description
`bool`

Overrides

object.Equals(object)

GetHashCode()

public override int GetHashCode()

Returns
Type	Description
`int`

Overrides

object.GetHashCode()

MergeFrom(MetricRule)

public void MergeFrom(MetricRule other)

Parameter
Name	Description
`other`	`MetricRule`

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

ToString()

public override string ToString()

Returns
Type	Description
`string`

Overrides

object.ToString()

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`