Package org.mlflow.api.proto

Interface Jobs.JobProgressOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Jobs.JobProgress, Jobs.JobProgress.Builder
Enclosing class:
Jobs
public static interface Jobs.JobProgressOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getCompleted()
    Amount of work completed so far, e.g.
    String
    getPhase()
    Current phase or stage of the job, e.g.
    com.google.protobuf.ByteString
    getPhaseBytes()
    Current phase or stage of the job, e.g.
    long
    getTotal()
    Total amount of work, if known, e.g.
    String
    getUnit()
    Unit for the ``completed`` and ``total`` values, e.g.
    com.google.protobuf.ByteString
    getUnitBytes()
    Unit for the ``completed`` and ``total`` values, e.g.
    boolean
    hasCompleted()
    Amount of work completed so far, e.g.
    boolean
    hasPhase()
    Current phase or stage of the job, e.g.
    boolean
    hasTotal()
    Total amount of work, if known, e.g.
    boolean
    hasUnit()
    Unit for the ``completed`` and ``total`` values, 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

    • hasPhase

      boolean hasPhase()
       Current phase or stage of the job, e.g. ``"scoring traces"``.
      optional string phase = 1;
      Returns:
      Whether the phase field is set.

    • getPhase

      String getPhase()
       Current phase or stage of the job, e.g. ``"scoring traces"``.
      optional string phase = 1;
      Returns:
      The phase.

    • getPhaseBytes

      com.google.protobuf.ByteString getPhaseBytes()
       Current phase or stage of the job, e.g. ``"scoring traces"``.
      optional string phase = 1;
      Returns:
      The bytes for phase.

    • hasCompleted

      boolean hasCompleted()
       Amount of work completed so far, e.g. ``42``.
      optional int64 completed = 2;
      Returns:
      Whether the completed field is set.

    • getCompleted

      long getCompleted()
       Amount of work completed so far, e.g. ``42``.
      optional int64 completed = 2;
      Returns:
      The completed.

    • hasTotal

      boolean hasTotal()
       Total amount of work, if known, e.g. ``100``.
      optional int64 total = 3;
      Returns:
      Whether the total field is set.

    • getTotal

      long getTotal()
       Total amount of work, if known, e.g. ``100``.
      optional int64 total = 3;
      Returns:
      The total.

    • hasUnit

      boolean hasUnit()
       Unit for the ``completed`` and ``total`` values, e.g. ``"trace"`` or ``"file"``.
      optional string unit = 4;
      Returns:
      Whether the unit field is set.

    • getUnit

      String getUnit()
       Unit for the ``completed`` and ``total`` values, e.g. ``"trace"`` or ``"file"``.
      optional string unit = 4;
      Returns:
      The unit.

    • getUnitBytes

      com.google.protobuf.ByteString getUnitBytes()
       Unit for the ``completed`` and ``total`` values, e.g. ``"trace"`` or ``"file"``.
      optional string unit = 4;
      Returns:
      The bytes for unit.