Package org.mlflow.api.proto

Class Service.MetricDataPoint

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, Service.MetricDataPointOrBuilder
    Enclosing class:
    Service
    public static final class Service.MetricDataPoint
extends com.google.protobuf.GeneratedMessageV3
implements Service.MetricDataPointOrBuilder
     A single data point with dimension values and metric values.
    Protobuf type mlflow.MetricDataPoint
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Service.MetricDataPoint.Builder
      A single data point with dimension values and metric 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 DIMENSIONS_FIELD_NUMBER  
      static int METRIC_NAME_FIELD_NUMBER  
      static com.google.protobuf.Parser<Service.MetricDataPoint> PARSER
      Deprecated.
      static int VALUES_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 Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsDimensions​(java.lang.String key)
      Dimension values for this data point Keys correspond to dimensions e.g., {"status": "OK"}
      boolean containsValues​(java.lang.String key)
      Metric values for this data point Keys are aggregation types e.g., {"AVG": 150, "P99": 234.5}
      boolean equals​(java.lang.Object obj)  
      static Service.MetricDataPoint getDefaultInstance()  
      Service.MetricDataPoint getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.util.Map<java.lang.String,​java.lang.String> getDimensions()
      Deprecated.
      int getDimensionsCount()
      Dimension values for this data point Keys correspond to dimensions e.g., {"status": "OK"}
      java.util.Map<java.lang.String,​java.lang.String> getDimensionsMap()
      Dimension values for this data point Keys correspond to dimensions e.g., {"status": "OK"}
      java.lang.String getDimensionsOrDefault​(java.lang.String key, java.lang.String defaultValue)
      Dimension values for this data point Keys correspond to dimensions e.g., {"status": "OK"}
      java.lang.String getDimensionsOrThrow​(java.lang.String key)
      Dimension values for this data point Keys correspond to dimensions e.g., {"status": "OK"}
      java.lang.String getMetricName()
      Metric name, e.g.
      com.google.protobuf.ByteString getMetricNameBytes()
      Metric name, e.g.
      com.google.protobuf.Parser<Service.MetricDataPoint> getParserForType()  
      int getSerializedSize()  
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      java.util.Map<java.lang.String,​java.lang.Double> getValues()
      Deprecated.
      int getValuesCount()
      Metric values for this data point Keys are aggregation types e.g., {"AVG": 150, "P99": 234.5}
      java.util.Map<java.lang.String,​java.lang.Double> getValuesMap()
      Metric values for this data point Keys are aggregation types e.g., {"AVG": 150, "P99": 234.5}
      double getValuesOrDefault​(java.lang.String key, double defaultValue)
      Metric values for this data point Keys are aggregation types e.g., {"AVG": 150, "P99": 234.5}
      double getValuesOrThrow​(java.lang.String key)
      Metric values for this data point Keys are aggregation types e.g., {"AVG": 150, "P99": 234.5}
      int hashCode()  
      boolean hasMetricName()
      Metric name, e.g.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      protected com.google.protobuf.MapField internalGetMapField​(int number)  
      boolean isInitialized()  
      static Service.MetricDataPoint.Builder newBuilder()  
      static Service.MetricDataPoint.Builder newBuilder​(Service.MetricDataPoint prototype)  
      Service.MetricDataPoint.Builder newBuilderForType()  
      protected Service.MetricDataPoint.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Service.MetricDataPoint parseDelimitedFrom​(java.io.InputStream input)  
      static Service.MetricDataPoint parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Service.MetricDataPoint parseFrom​(byte[] data)  
      static Service.MetricDataPoint parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Service.MetricDataPoint parseFrom​(com.google.protobuf.ByteString data)  
      static Service.MetricDataPoint parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Service.MetricDataPoint parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Service.MetricDataPoint parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Service.MetricDataPoint parseFrom​(java.io.InputStream input)  
      static Service.MetricDataPoint parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Service.MetricDataPoint parseFrom​(java.nio.ByteBuffer data)  
      static Service.MetricDataPoint parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Service.MetricDataPoint> parser()  
      Service.MetricDataPoint.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, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, 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, hasField, hasOneof

    • Method Detail

      • newInstance

        protected java.lang.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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

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

      • hasMetricName

        public boolean hasMetricName()
         Metric name, e.g. "latency"
        optional string metric_name = 1;
        Specified by:
        hasMetricName in interface Service.MetricDataPointOrBuilder
        Returns:
        Whether the metricName field is set.

      • getMetricNameBytes

        public com.google.protobuf.ByteString getMetricNameBytes()
         Metric name, e.g. "latency"
        optional string metric_name = 1;
        Specified by:
        getMetricNameBytes in interface Service.MetricDataPointOrBuilder
        Returns:
        The bytes for metricName.

      • containsDimensions

        public boolean containsDimensions​(java.lang.String key)
         Dimension values for this data point
 Keys correspond to dimensions
 e.g., {"status": "OK"}
        map<string, string> dimensions = 2;
        Specified by:
        containsDimensions in interface Service.MetricDataPointOrBuilder

      • getDimensionsMap

        public java.util.Map<java.lang.String,​java.lang.String> getDimensionsMap()
         Dimension values for this data point
 Keys correspond to dimensions
 e.g., {"status": "OK"}
        map<string, string> dimensions = 2;
        Specified by:
        getDimensionsMap in interface Service.MetricDataPointOrBuilder

      • getDimensionsOrDefault

        public java.lang.String getDimensionsOrDefault​(java.lang.String key,
                                               java.lang.String defaultValue)
         Dimension values for this data point
 Keys correspond to dimensions
 e.g., {"status": "OK"}
        map<string, string> dimensions = 2;
        Specified by:
        getDimensionsOrDefault in interface Service.MetricDataPointOrBuilder

      • getDimensionsOrThrow

        public java.lang.String getDimensionsOrThrow​(java.lang.String key)
         Dimension values for this data point
 Keys correspond to dimensions
 e.g., {"status": "OK"}
        map<string, string> dimensions = 2;
        Specified by:
        getDimensionsOrThrow in interface Service.MetricDataPointOrBuilder

      • containsValues

        public boolean containsValues​(java.lang.String key)
         Metric values for this data point
 Keys are aggregation types
 e.g., {"AVG": 150, "P99": 234.5}
        map<string, double> values = 3;
        Specified by:
        containsValues in interface Service.MetricDataPointOrBuilder

      • getValuesMap

        public java.util.Map<java.lang.String,​java.lang.Double> getValuesMap()
         Metric values for this data point
 Keys are aggregation types
 e.g., {"AVG": 150, "P99": 234.5}
        map<string, double> values = 3;
        Specified by:
        getValuesMap in interface Service.MetricDataPointOrBuilder

      • getValuesOrDefault

        public double getValuesOrDefault​(java.lang.String key,
                                 double defaultValue)
         Metric values for this data point
 Keys are aggregation types
 e.g., {"AVG": 150, "P99": 234.5}
        map<string, double> values = 3;
        Specified by:
        getValuesOrDefault in interface Service.MetricDataPointOrBuilder

      • getValuesOrThrow

        public double getValuesOrThrow​(java.lang.String key)
         Metric values for this data point
 Keys are aggregation types
 e.g., {"AVG": 150, "P99": 234.5}
        map<string, double> values = 3;
        Specified by:
        getValuesOrThrow in interface Service.MetricDataPointOrBuilder

      • 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 Service.MetricDataPoint parseFrom​(java.nio.ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Service.MetricDataPoint parseFrom​(java.nio.ByteBuffer data,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Service.MetricDataPoint parseFrom​(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

        public static Service.MetricDataPoint parseFrom​(java.io.InputStream input)
                                         throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected Service.MetricDataPoint.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

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