Class Distribution.Exemplar (2.27.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
TypeDescription
int

TIMESTAMP_FIELD_NUMBER

public static final int TIMESTAMP_FIELD_NUMBER
Field Value
TypeDescription
int

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Distribution.Exemplar getDefaultInstance()
Returns
TypeDescription
Distribution.Exemplar

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Distribution.Exemplar.Builder newBuilder()
Returns
TypeDescription
Distribution.Exemplar.Builder

newBuilder(Distribution.Exemplar prototype)

public static Distribution.Exemplar.Builder newBuilder(Distribution.Exemplar prototype)
Parameter
NameDescription
prototypeDistribution.Exemplar
Returns
TypeDescription
Distribution.Exemplar.Builder

parseDelimitedFrom(InputStream input)

public static Distribution.Exemplar parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Distribution.Exemplar
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Distribution.Exemplar parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Distribution.Exemplar
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Distribution.Exemplar parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Distribution.Exemplar
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Distribution.Exemplar parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Distribution.Exemplar
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Distribution.Exemplar parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Distribution.Exemplar
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Distribution.Exemplar parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Distribution.Exemplar
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Distribution.Exemplar parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Distribution.Exemplar
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Distribution.Exemplar parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Distribution.Exemplar
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Distribution.Exemplar parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Distribution.Exemplar
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Distribution.Exemplar parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Distribution.Exemplar
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Distribution.Exemplar parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Distribution.Exemplar
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Distribution.Exemplar parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Distribution.Exemplar
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.protobuf.AnyOrBuilder>

getDefaultInstanceForType()

public Distribution.Exemplar getDefaultInstanceForType()
Returns
TypeDescription
Distribution.Exemplar

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTimestamp()

public Timestamp getTimestamp()

The observation (sampling) time of the above value.

.google.protobuf.Timestamp timestamp = 2;

Returns
TypeDescription
Timestamp

The timestamp.

getTimestampOrBuilder()

public TimestampOrBuilder getTimestampOrBuilder()

The observation (sampling) time of the above value.

.google.protobuf.Timestamp timestamp = 2;

Returns
TypeDescription
TimestampOrBuilder

getValue()

public double getValue()

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

double value = 1;

Returns
TypeDescription
double

The value.

hasTimestamp()

public boolean hasTimestamp()

The observation (sampling) time of the above value.

.google.protobuf.Timestamp timestamp = 2;

Returns
TypeDescription
boolean

Whether the timestamp field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Distribution.Exemplar.Builder newBuilderForType()
Returns
TypeDescription
Distribution.Exemplar.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Distribution.Exemplar.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Distribution.Exemplar.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Distribution.Exemplar.Builder toBuilder()
Returns
TypeDescription
Distribution.Exemplar.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException