Class Distribution.Exemplar (2.40.0)

public static final class Distribution.Exemplar extends GeneratedMessageV3 implements Distribution.ExemplarOrBuilder

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.

Protobuf type google.api.Distribution.Exemplar

Static Fields

ATTACHMENTS_FIELD_NUMBER

public static final int ATTACHMENTS_FIELD_NUMBER
Field Value
Type Description
int

TIMESTAMP_FIELD_NUMBER

public static final int TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Distribution.Exemplar getDefaultInstance()
Returns
Type Description
Distribution.Exemplar

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Distribution.Exemplar.Builder newBuilder()
Returns
Type Description
Distribution.Exemplar.Builder

newBuilder(Distribution.Exemplar prototype)

public static Distribution.Exemplar.Builder newBuilder(Distribution.Exemplar prototype)
Parameter
Name Description
prototype Distribution.Exemplar
Returns
Type Description
Distribution.Exemplar.Builder

parseDelimitedFrom(InputStream input)

public static Distribution.Exemplar parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Distribution.Exemplar
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Distribution.Exemplar parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Distribution.Exemplar
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Distribution.Exemplar parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Distribution.Exemplar
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Distribution.Exemplar parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Distribution.Exemplar
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Distribution.Exemplar parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Distribution.Exemplar
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Distribution.Exemplar parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Distribution.Exemplar
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Distribution.Exemplar parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Distribution.Exemplar
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Distribution.Exemplar parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Distribution.Exemplar
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Distribution.Exemplar parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Distribution.Exemplar
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Distribution.Exemplar parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Distribution.Exemplar
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Distribution.Exemplar parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Distribution.Exemplar
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Distribution.Exemplar parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Distribution.Exemplar
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Distribution.Exemplar> parser()
Returns
Type Description
Parser<Exemplar>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAttachments(int index)

public Any getAttachments(int index)

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.

repeated .google.protobuf.Any attachments = 3;

Parameter
Name Description
index int
Returns
Type Description
Any

getAttachmentsCount()

public int getAttachmentsCount()

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.

repeated .google.protobuf.Any attachments = 3;

Returns
Type Description
int

getAttachmentsList()

public List<Any> getAttachmentsList()

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.

repeated .google.protobuf.Any attachments = 3;

Returns
Type Description
List<Any>

getAttachmentsOrBuilder(int index)

public AnyOrBuilder getAttachmentsOrBuilder(int index)

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.

repeated .google.protobuf.Any attachments = 3;

Parameter
Name Description
index int
Returns
Type Description
AnyOrBuilder

getAttachmentsOrBuilderList()

public List<? extends AnyOrBuilder> getAttachmentsOrBuilderList()

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.

repeated .google.protobuf.Any attachments = 3;

Returns
Type Description
List<? extends com.google.protobuf.AnyOrBuilder>

getDefaultInstanceForType()

public Distribution.Exemplar getDefaultInstanceForType()
Returns
Type Description
Distribution.Exemplar

getParserForType()

public Parser<Distribution.Exemplar> getParserForType()
Returns
Type Description
Parser<Exemplar>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTimestamp()

public Timestamp getTimestamp()

The observation (sampling) time of the above value.

.google.protobuf.Timestamp timestamp = 2;

Returns
Type Description
Timestamp

The timestamp.

getTimestampOrBuilder()

public TimestampOrBuilder getTimestampOrBuilder()

The observation (sampling) time of the above value.

.google.protobuf.Timestamp timestamp = 2;

Returns
Type Description
TimestampOrBuilder

getValue()

public double getValue()

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

double value = 1;

Returns
Type Description
double

The value.

hasTimestamp()

public boolean hasTimestamp()

The observation (sampling) time of the above value.

.google.protobuf.Timestamp timestamp = 2;

Returns
Type Description
boolean

Whether the timestamp field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Distribution.Exemplar.Builder newBuilderForType()
Returns
Type Description
Distribution.Exemplar.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Distribution.Exemplar.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Distribution.Exemplar.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Distribution.Exemplar.Builder toBuilder()
Returns
Type Description
Distribution.Exemplar.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException