Package io.opentelemetry.proto.metrics.v1

Class Exemplar

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.opentelemetry.proto.metrics.v1.Exemplar
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ExemplarOrBuilder, Serializable
public final class Exemplar extends com.google.protobuf.GeneratedMessage implements ExemplarOrBuilder
 A representation of an exemplar, which is a sample input measurement.
 Exemplars also hold information about the environment when the measurement
 was recorded, for example the span and trace ID of the active span when the
 exemplar was recorded.
Protobuf type opentelemetry.proto.metrics.v1.Exemplar
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Exemplar.Builder
    A representation of an exemplar, which is a sample input measurement.
    static enum 
    Exemplar.ValueCase
     

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    AS_DOUBLE_FIELD_NUMBER
     
    static final int
    AS_INT_FIELD_NUMBER
     
    static final int
    FILTERED_ATTRIBUTES_FIELD_NUMBER
     
    static final int
    SPAN_ID_FIELD_NUMBER
     
    static final int
    TIME_UNIX_NANO_FIELD_NUMBER
     
    static final int
    TRACE_ID_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    double
    getAsDouble()
    double as_double = 3;
    long
    getAsInt()
    sfixed64 as_int = 6;
    static Exemplar
    getDefaultInstance()
     
    Exemplar
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    KeyValue
    getFilteredAttributes(int index)
    The set of key/value pairs that were filtered out by the aggregator, but recorded alongside the original measurement.
    int
    getFilteredAttributesCount()
    The set of key/value pairs that were filtered out by the aggregator, but recorded alongside the original measurement.
    List<KeyValue>
    getFilteredAttributesList()
    The set of key/value pairs that were filtered out by the aggregator, but recorded alongside the original measurement.
    KeyValueOrBuilder
    getFilteredAttributesOrBuilder(int index)
    The set of key/value pairs that were filtered out by the aggregator, but recorded alongside the original measurement.
    List<? extends KeyValueOrBuilder>
    getFilteredAttributesOrBuilderList()
    The set of key/value pairs that were filtered out by the aggregator, but recorded alongside the original measurement.
    com.google.protobuf.Parser<Exemplar>
    getParserForType()
     
    int
    getSerializedSize()
     
    com.google.protobuf.ByteString
    getSpanId()
    (Optional) Span ID of the exemplar trace.
    long
    getTimeUnixNano()
    time_unix_nano is the exact time when this exemplar was recorded Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.
    com.google.protobuf.ByteString
    getTraceId()
    (Optional) Trace ID of the exemplar trace.
    Exemplar.ValueCase
    getValueCase()
     
    boolean
    hasAsDouble()
    double as_double = 3;
    boolean
    hasAsInt()
    sfixed64 as_int = 6;
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Exemplar.Builder
    newBuilder()
     
    static Exemplar.Builder
    newBuilder(Exemplar prototype)
     
    Exemplar.Builder
    newBuilderForType()
     
    protected Exemplar.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Exemplar
    parseDelimitedFrom(InputStream input)
     
    static Exemplar
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Exemplar
    parseFrom(byte[] data)
     
    static Exemplar
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Exemplar
    parseFrom(com.google.protobuf.ByteString data)
     
    static Exemplar
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Exemplar
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Exemplar
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Exemplar
    parseFrom(InputStream input)
     
    static Exemplar
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Exemplar
    parseFrom(ByteBuffer data)
     
    static Exemplar
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Exemplar>
    parser()
     
    Exemplar.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • FILTERED_ATTRIBUTES_FIELD_NUMBER

      public static final int FILTERED_ATTRIBUTES_FIELD_NUMBER
      See Also:

    • TIME_UNIX_NANO_FIELD_NUMBER

      public static final int TIME_UNIX_NANO_FIELD_NUMBER
      See Also:

    • AS_DOUBLE_FIELD_NUMBER

      public static final int AS_DOUBLE_FIELD_NUMBER
      See Also:

    • AS_INT_FIELD_NUMBER

      public static final int AS_INT_FIELD_NUMBER
      See Also:

    • SPAN_ID_FIELD_NUMBER

      public static final int SPAN_ID_FIELD_NUMBER
      See Also:

    • TRACE_ID_FIELD_NUMBER

      public static final int TRACE_ID_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getValueCase

      public Exemplar.ValueCase getValueCase()
      Specified by:
      getValueCase in interface ExemplarOrBuilder

    • getFilteredAttributesList

      public List<KeyValue> getFilteredAttributesList()
       The set of key/value pairs that were filtered out by the aggregator, but
 recorded alongside the original measurement. Only key/value pairs that were
 filtered out by the aggregator should be included
      repeated .opentelemetry.proto.common.v1.KeyValue filtered_attributes = 7;
      Specified by:
      getFilteredAttributesList in interface ExemplarOrBuilder

    • getFilteredAttributesOrBuilderList

      public List<? extends KeyValueOrBuilder> getFilteredAttributesOrBuilderList()
       The set of key/value pairs that were filtered out by the aggregator, but
 recorded alongside the original measurement. Only key/value pairs that were
 filtered out by the aggregator should be included
      repeated .opentelemetry.proto.common.v1.KeyValue filtered_attributes = 7;
      Specified by:
      getFilteredAttributesOrBuilderList in interface ExemplarOrBuilder

    • getFilteredAttributesCount

      public int getFilteredAttributesCount()
       The set of key/value pairs that were filtered out by the aggregator, but
 recorded alongside the original measurement. Only key/value pairs that were
 filtered out by the aggregator should be included
      repeated .opentelemetry.proto.common.v1.KeyValue filtered_attributes = 7;
      Specified by:
      getFilteredAttributesCount in interface ExemplarOrBuilder

    • getFilteredAttributes

      public KeyValue getFilteredAttributes(int index)
       The set of key/value pairs that were filtered out by the aggregator, but
 recorded alongside the original measurement. Only key/value pairs that were
 filtered out by the aggregator should be included
      repeated .opentelemetry.proto.common.v1.KeyValue filtered_attributes = 7;
      Specified by:
      getFilteredAttributes in interface ExemplarOrBuilder

    • getFilteredAttributesOrBuilder

      public KeyValueOrBuilder getFilteredAttributesOrBuilder(int index)
       The set of key/value pairs that were filtered out by the aggregator, but
 recorded alongside the original measurement. Only key/value pairs that were
 filtered out by the aggregator should be included
      repeated .opentelemetry.proto.common.v1.KeyValue filtered_attributes = 7;
      Specified by:
      getFilteredAttributesOrBuilder in interface ExemplarOrBuilder

    • getTimeUnixNano

      public long getTimeUnixNano()
       time_unix_nano is the exact time when this exemplar was recorded

 Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January
 1970.
      fixed64 time_unix_nano = 2;
      Specified by:
      getTimeUnixNano in interface ExemplarOrBuilder
      Returns:
      The timeUnixNano.

    • hasAsDouble

      public boolean hasAsDouble()
      double as_double = 3;
      Specified by:
      hasAsDouble in interface ExemplarOrBuilder
      Returns:
      Whether the asDouble field is set.

    • getAsDouble

      public double getAsDouble()
      double as_double = 3;
      Specified by:
      getAsDouble in interface ExemplarOrBuilder
      Returns:
      The asDouble.

    • hasAsInt

      public boolean hasAsInt()
      sfixed64 as_int = 6;
      Specified by:
      hasAsInt in interface ExemplarOrBuilder
      Returns:
      Whether the asInt field is set.

    • getAsInt

      public long getAsInt()
      sfixed64 as_int = 6;
      Specified by:
      getAsInt in interface ExemplarOrBuilder
      Returns:
      The asInt.

    • getSpanId

      public com.google.protobuf.ByteString getSpanId()
       (Optional) Span ID of the exemplar trace.
 span_id may be missing if the measurement is not recorded inside a trace
 or if the trace is not sampled.
      bytes span_id = 4;
      Specified by:
      getSpanId in interface ExemplarOrBuilder
      Returns:
      The spanId.

    • getTraceId

      public com.google.protobuf.ByteString getTraceId()
       (Optional) Trace ID of the exemplar trace.
 trace_id may be missing if the measurement is not recorded inside a trace
 or if the trace is not sampled.
      bytes trace_id = 5;
      Specified by:
      getTraceId in interface ExemplarOrBuilder
      Returns:
      The traceId.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Exemplar parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Exemplar parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Exemplar parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Exemplar parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Exemplar parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Exemplar parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Exemplar parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Exemplar parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Exemplar parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Exemplar parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Exemplar parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Exemplar parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Exemplar.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Exemplar.Builder newBuilder()

    • newBuilder

      public static Exemplar.Builder newBuilder(Exemplar prototype)

    • toBuilder

      public Exemplar.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Exemplar.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Exemplar getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Exemplar> parser()

    • getParserForType

      public com.google.protobuf.Parser<Exemplar> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Exemplar getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder