Package org.mlflow.api.proto

Interface Service.MetricDataPointOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Service.MetricDataPoint, Service.MetricDataPoint.Builder
    Enclosing class:
    Service
    public static interface Service.MetricDataPointOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract 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}
      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.
      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}
      boolean hasMetricName()
      Metric name, e.g.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • hasMetricName

        boolean hasMetricName()
         Metric name, e.g. "latency"
        optional string metric_name = 1;
        Returns:
        Whether the metricName field is set.

      • getMetricName

        java.lang.String getMetricName()
         Metric name, e.g. "latency"
        optional string metric_name = 1;
        Returns:
        The metricName.

      • getMetricNameBytes

        com.google.protobuf.ByteString getMetricNameBytes()
         Metric name, e.g. "latency"
        optional string metric_name = 1;
        Returns:
        The bytes for metricName.

      • getDimensionsCount

        int getDimensionsCount()
         Dimension values for this data point
 Keys correspond to dimensions
 e.g., {"status": "OK"}
        map<string, string> dimensions = 2;

      • containsDimensions

        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;

      • getDimensions

        @Deprecated
java.util.Map<java.lang.String,​java.lang.String> getDimensions()
        Deprecated.
        Use getDimensionsMap() instead.

      • getDimensionsMap

        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;

      • getDimensionsOrDefault

        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;

      • getDimensionsOrThrow

        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;

      • getValuesCount

        int getValuesCount()
         Metric values for this data point
 Keys are aggregation types
 e.g., {"AVG": 150, "P99": 234.5}
        map<string, double> values = 3;

      • containsValues

        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;

      • getValues

        @Deprecated
java.util.Map<java.lang.String,​java.lang.Double> getValues()
        Deprecated.
        Use getValuesMap() instead.

      • getValuesMap

        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;

      • getValuesOrDefault

        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;

      • getValuesOrThrow

        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;