Package org.mlflow.api.proto

Interface Jobs.JobStateOrBuilder

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

  • Method Details

    • hasStatus

      boolean hasStatus()
       Current status of the job.
      optional .mlflow.JobStatus status = 1;
      Returns:
      Whether the status field is set.

    • getStatus

      Jobs.JobStatus getStatus()
       Current status of the job.
      optional .mlflow.JobStatus status = 1;
      Returns:
      The status.

    • hasErrorMessage

      boolean hasErrorMessage()
       Error message for a terminal failure or timeout outcome, when available.
      optional string error_message = 2;
      Returns:
      Whether the errorMessage field is set.

    • getErrorMessage

      String getErrorMessage()
       Error message for a terminal failure or timeout outcome, when available.
      optional string error_message = 2;
      Returns:
      The errorMessage.

    • getErrorMessageBytes

      com.google.protobuf.ByteString getErrorMessageBytes()
       Error message for a terminal failure or timeout outcome, when available.
      optional string error_message = 2;
      Returns:
      The bytes for errorMessage.

    • getMetadataCount

      int getMetadataCount()
       Additional metadata as key-value pairs.
 Can be used to store job-specific state information.
      map<string, string> metadata = 3;

    • containsMetadata

      boolean containsMetadata(String key)
       Additional metadata as key-value pairs.
 Can be used to store job-specific state information.
      map<string, string> metadata = 3;

    • getMetadata

      @Deprecated Map<String,String> getMetadata()
      Deprecated.
      Use getMetadataMap() instead.

    • getMetadataMap

      Map<String,String> getMetadataMap()
       Additional metadata as key-value pairs.
 Can be used to store job-specific state information.
      map<string, string> metadata = 3;

    • getMetadataOrDefault

      String getMetadataOrDefault(String key, String defaultValue)
       Additional metadata as key-value pairs.
 Can be used to store job-specific state information.
      map<string, string> metadata = 3;

    • getMetadataOrThrow

      String getMetadataOrThrow(String key)
       Additional metadata as key-value pairs.
 Can be used to store job-specific state information.
      map<string, string> metadata = 3;

    • hasStatusMessage

      boolean hasStatusMessage()
       Latest best-effort in-flight status message, e.g. ``"Processed 42 / 100 traces"``.
      optional string status_message = 4;
      Returns:
      Whether the statusMessage field is set.

    • getStatusMessage

      String getStatusMessage()
       Latest best-effort in-flight status message, e.g. ``"Processed 42 / 100 traces"``.
      optional string status_message = 4;
      Returns:
      The statusMessage.

    • getStatusMessageBytes

      com.google.protobuf.ByteString getStatusMessageBytes()
       Latest best-effort in-flight status message, e.g. ``"Processed 42 / 100 traces"``.
      optional string status_message = 4;
      Returns:
      The bytes for statusMessage.

    • hasProgress

      boolean hasProgress()
       Latest best-effort structured progress, e.g. ``phase="scoring", completed=42``.
      optional .mlflow.JobProgress progress = 5;
      Returns:
      Whether the progress field is set.

    • getProgress

      Jobs.JobProgress getProgress()
       Latest best-effort structured progress, e.g. ``phase="scoring", completed=42``.
      optional .mlflow.JobProgress progress = 5;
      Returns:
      The progress.

    • getProgressOrBuilder

      Jobs.JobProgressOrBuilder getProgressOrBuilder()
       Latest best-effort structured progress, e.g. ``phase="scoring", completed=42``.
      optional .mlflow.JobProgress progress = 5;

    • hasProgressUpdatedAt

      boolean hasProgressUpdatedAt()
       Timestamp of the latest progress update in milliseconds since epoch.
      optional int64 progress_updated_at = 6;
      Returns:
      Whether the progressUpdatedAt field is set.

    • getProgressUpdatedAt

      long getProgressUpdatedAt()
       Timestamp of the latest progress update in milliseconds since epoch.
      optional int64 progress_updated_at = 6;
      Returns:
      The progressUpdatedAt.