Class Distribution.Exemplar

  • All Implemented Interfaces:
    Distribution.ExemplarOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    Distribution

    public static final class Distribution.Exemplar
    extends com.google.protobuf.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
    See Also:
    Serialized Form
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Distribution.Exemplar.Builder
      Exemplars are example points that may be used to annotate aggregated distribution values.
      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ATTACHMENTS_FIELD_NUMBER  
      static int TIMESTAMP_FIELD_NUMBER  
      static int VALUE_FIELD_NUMBER  
      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields
      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize
      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode
    • Method Detail

      • newInstance

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

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields 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
      • getValue

        public double getValue()
         Value of the exemplar point. This value determines to which bucket the
         exemplar belongs.
         
        double value = 1;
        Specified by:
        getValue in interface Distribution.ExemplarOrBuilder
        Returns:
        The value.
      • hasTimestamp

        public boolean hasTimestamp()
         The observation (sampling) time of the above value.
         
        .google.protobuf.Timestamp timestamp = 2;
        Specified by:
        hasTimestamp in interface Distribution.ExemplarOrBuilder
        Returns:
        Whether the timestamp field is set.
      • getTimestamp

        public com.google.protobuf.Timestamp getTimestamp()
         The observation (sampling) time of the above value.
         
        .google.protobuf.Timestamp timestamp = 2;
        Specified by:
        getTimestamp in interface Distribution.ExemplarOrBuilder
        Returns:
        The timestamp.
      • getTimestampOrBuilder

        public com.google.protobuf.TimestampOrBuilder getTimestampOrBuilder()
         The observation (sampling) time of the above value.
         
        .google.protobuf.Timestamp timestamp = 2;
        Specified by:
        getTimestampOrBuilder in interface Distribution.ExemplarOrBuilder
      • getAttachmentsList

        public List<com.google.protobuf.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;
        Specified by:
        getAttachmentsList in interface Distribution.ExemplarOrBuilder
      • getAttachmentsOrBuilderList

        public List<? extends com.google.protobuf.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;
        Specified by:
        getAttachmentsOrBuilderList in interface Distribution.ExemplarOrBuilder
      • 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;
        Specified by:
        getAttachmentsCount in interface Distribution.ExemplarOrBuilder
      • getAttachments

        public com.google.protobuf.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;
        Specified by:
        getAttachments in interface Distribution.ExemplarOrBuilder
      • getAttachmentsOrBuilder

        public com.google.protobuf.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;
        Specified by:
        getAttachmentsOrBuilder in interface Distribution.ExemplarOrBuilder
      • 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 IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        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​(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 Distribution.Exemplar parseFrom​(ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

        public static Distribution.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 Distribution.Exemplar parseFrom​(byte[] data)
                                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

        protected Distribution.Exemplar.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<Distribution.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 Distribution.Exemplar getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder