Class Distribution.Types.Exemplar (2.15.0)

Version latest

• 2.15.0 (latest)
• 2.10.0
• 2.2.0

public sealed class Distribution.Types.Exemplar : IMessage<Distribution.Types.Exemplar>, IEquatable<Distribution.Types.Exemplar>, IDeepCloneable<Distribution.Types.Exemplar>, IBufferMessage, IMessage

Exemplars are example points that may be used to annotate aggregated distribution values. They are metadata that gives information about a particular value added to a Distribution bucket, such as a trace ID that was active when a value was added. They may contain further information, such as a example values and timestamps, origin, etc.

Inheritance

object > Distribution.Types.Exemplar

Implements

IMessageDistributionTypesExemplar, IEquatableDistributionTypesExemplar, IDeepCloneableDistributionTypesExemplar, IBufferMessage, IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace

Google.Api

Assembly

Google.Api.CommonProtos.dll

Constructors

Exemplar()

public Exemplar()

Exemplar(Exemplar)

public Exemplar(Distribution.Types.Exemplar other)

Parameter
Name	Description
other	DistributionTypesExemplar

Fields

AttachmentsFieldNumber

public const int AttachmentsFieldNumber = 3

Field number for the "attachments" field.

Field Value
Type	Description
int

TimestampFieldNumber

public const int TimestampFieldNumber = 2

Field number for the "timestamp" field.

Field Value
Type	Description
int

ValueFieldNumber

public const int ValueFieldNumber = 1

Field number for the "value" field.

Field Value
Type	Description
int

Properties

Attachments

public RepeatedField<Any> Attachments { get; }

Contextual information about the example value. Examples are:

Trace: type.googleapis.com/google.monitoring.v3.SpanContext

Literal string: type.googleapis.com/google.protobuf.StringValue

Labels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabels

There may be only a single attachment of any given message type in a single exemplar, and this is enforced by the system.

Property Value
Type	Description
RepeatedFieldAny

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value
Type	Description
MessageDescriptor

Parser

public static MessageParser<Distribution.Types.Exemplar> Parser { get; }

Property Value
Type	Description
MessageParserDistributionTypesExemplar

Timestamp

public Timestamp Timestamp { get; set; }

The observation (sampling) time of the above value.

Property Value
Type	Description
Timestamp

Value

public double Value { get; set; }

Value of the exemplar point. This value determines to which bucket the exemplar belongs.

Property Value
Type	Description
double

Methods

CalculateSize()

public int CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

Returns
Type	Description
int	The number of bytes required to write this message to a coded output stream.

Clone()

public Distribution.Types.Exemplar Clone()

Creates a deep clone of this object.

Returns
Type	Description
DistributionTypesExemplar	A deep clone of this object.

Equals(Exemplar)

public bool Equals(Distribution.Types.Exemplar other)

Parameter
Name	Description
other	DistributionTypesExemplar

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(Exemplar)

public void MergeFrom(Distribution.Types.Exemplar other)

Merges the given message into this one.

Parameter
Name	Description
other	DistributionTypesExemplar

Remarks

See the user guide for precise merge semantics.

MergeFrom(CodedInputStream)

public void MergeFrom(CodedInputStream input)

Merges the data from the specified coded input stream with the current message.

Parameter
Name	Description
input	CodedInputStream

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns
Type	Description
string

Overrides

object.ToString()

WriteTo(CodedOutputStream)

public void WriteTo(CodedOutputStream output)

Writes the data to the given coded output stream.

Parameter
Name	Description
output	CodedOutputStream Coded output stream to write the data to. Must not be null.