Package org.mlflow.api.proto

Interface Service.MetricWithRunIdOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getKey()
    Key identifying this metric.
    com.google.protobuf.ByteString
    getKeyBytes()
    Key identifying this metric.
    String
    getRunId()
    The ID of the run containing the metric
    com.google.protobuf.ByteString
    getRunIdBytes()
    The ID of the run containing the metric
    long
    getStep()
    Step at which to log the metric.
    long
    getTimestamp()
    The timestamp at which this metric was recorded.
    double
    getValue()
    Value associated with this metric.
    boolean
    hasKey()
    Key identifying this metric.
    boolean
    hasRunId()
    The ID of the run containing the metric
    boolean
    hasStep()
    Step at which to log the metric.
    boolean
    hasTimestamp()
    The timestamp at which this metric was recorded.
    boolean
    hasValue()
    Value associated with this metric.

    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

    • hasKey

      boolean hasKey()
       Key identifying this metric.
      optional string key = 1;
      Returns:
      Whether the key field is set.

    • getKey

      String getKey()
       Key identifying this metric.
      optional string key = 1;
      Returns:
      The key.

    • getKeyBytes

      com.google.protobuf.ByteString getKeyBytes()
       Key identifying this metric.
      optional string key = 1;
      Returns:
      The bytes for key.

    • hasValue

      boolean hasValue()
       Value associated with this metric.
      optional double value = 2;
      Returns:
      Whether the value field is set.

    • getValue

      double getValue()
       Value associated with this metric.
      optional double value = 2;
      Returns:
      The value.

    • hasTimestamp

      boolean hasTimestamp()
       The timestamp at which this metric was recorded.
      optional int64 timestamp = 3;
      Returns:
      Whether the timestamp field is set.

    • getTimestamp

      long getTimestamp()
       The timestamp at which this metric was recorded.
      optional int64 timestamp = 3;
      Returns:
      The timestamp.

    • hasStep

      boolean hasStep()
       Step at which to log the metric.
      optional int64 step = 4 [default = 0];
      Returns:
      Whether the step field is set.

    • getStep

      long getStep()
       Step at which to log the metric.
      optional int64 step = 4 [default = 0];
      Returns:
      The step.

    • hasRunId

      boolean hasRunId()
       The ID of the run containing the metric
      optional string run_id = 5;
      Returns:
      Whether the runId field is set.

    • getRunId

      String getRunId()
       The ID of the run containing the metric
      optional string run_id = 5;
      Returns:
      The runId.

    • getRunIdBytes

      com.google.protobuf.ByteString getRunIdBytes()
       The ID of the run containing the metric
      optional string run_id = 5;
      Returns:
      The bytes for runId.