Package io.opentelemetry.proto.metrics.v1

Class Exemplar

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ExemplarOrBuilder, java.io.Serializable
    public final class Exemplar
extends com.google.protobuf.GeneratedMessageV3
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:
    Serialized Form

    • Nested Class Summary

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

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      double getAsDouble()
      double as_double = 3;
      long getAsInt()
      sfixed64 as_int = 6;
      static Exemplar getDefaultInstance()  
      Exemplar getDefaultInstanceForType()  
      static 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.
      java.util.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.
      java.util.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.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Exemplar.Builder newBuilder()  
      static Exemplar.Builder newBuilder​(Exemplar prototype)  
      Exemplar.Builder newBuilderForType()  
      protected Exemplar.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Exemplar parseDelimitedFrom​(java.io.InputStream input)  
      static Exemplar parseDelimitedFrom​(java.io.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​(java.io.InputStream input)  
      static Exemplar parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Exemplar parseFrom​(java.nio.ByteBuffer data)  
      static Exemplar parseFrom​(java.nio.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.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, 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

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • getFilteredAttributesList

        public java.util.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 java.util.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.GeneratedMessageV3

      • writeTo

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

      • getSerializedSize

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

      • equals

        public boolean equals​(java.lang.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​(java.nio.ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Exemplar parseFrom​(java.nio.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​(java.io.InputStream input)
                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

        public static Exemplar parseDelimitedFrom​(java.io.InputStream input)
                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • 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.GeneratedMessageV3

      • getDefaultInstanceForType

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