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

    Modifier and Type
    Method
    Description
    boolean
    containsDimensions(String key)
    Dimension values for this data point Keys correspond to dimensions e.g., {"status": "OK"}
    boolean
    containsValues(String key)
    Metric values for this data point Keys are aggregation types e.g., {"AVG": 150, "P99": 234.5}
    Map<String,String>
    getDimensions()
    Deprecated.
    int
    getDimensionsCount()
    Dimension values for this data point Keys correspond to dimensions e.g., {"status": "OK"}
    Map<String,String>
    getDimensionsMap()
    Dimension values for this data point Keys correspond to dimensions e.g., {"status": "OK"}
    String
    getDimensionsOrDefault(String key, String defaultValue)
    Dimension values for this data point Keys correspond to dimensions e.g., {"status": "OK"}
    String
    getDimensionsOrThrow(String key)
    Dimension values for this data point Keys correspond to dimensions e.g., {"status": "OK"}
    String
    getMetricName()
    Metric name, e.g.
    com.google.protobuf.ByteString
    getMetricNameBytes()
    Metric name, e.g.
    Map<String,Double>
    getValues()
    Deprecated.
    int
    getValuesCount()
    Metric values for this data point Keys are aggregation types e.g., {"AVG": 150, "P99": 234.5}
    Map<String,Double>
    getValuesMap()
    Metric values for this data point Keys are aggregation types e.g., {"AVG": 150, "P99": 234.5}
    double
    getValuesOrDefault(String key, double defaultValue)
    Metric values for this data point Keys are aggregation types e.g., {"AVG": 150, "P99": 234.5}
    double
    getValuesOrThrow(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 Details

    • hasMetricName

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

    • getMetricName

      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(String key)
       Dimension values for this data point
 Keys correspond to dimensions
 e.g., {"status": "OK"}
      map<string, string> dimensions = 2;

    • getDimensions

      @Deprecated Map<String,String> getDimensions()
      Deprecated.
      Use getDimensionsMap() instead.

    • getDimensionsMap

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

    • getDimensionsOrDefault

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

    • getDimensionsOrThrow

      String getDimensionsOrThrow(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(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 Map<String,Double> getValues()
      Deprecated.
      Use getValuesMap() instead.

    • getValuesMap

      Map<String,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(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(String key)
       Metric values for this data point
 Keys are aggregation types
 e.g., {"AVG": 150, "P99": 234.5}
      map<string, double> values = 3;