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 Summary

    Modifier and Type
    Method
    Description
    boolean
    containsMetadata(String key)
    Additional metadata as key-value pairs.
    String
    getErrorMessage()
    Error message if the job failed.
    com.google.protobuf.ByteString
    getErrorMessageBytes()
    Error message if the job failed.
    Map<String,String>
    getMetadata()
    Deprecated.
    int
    getMetadataCount()
    Additional metadata as key-value pairs.
    Map<String,String>
    getMetadataMap()
    Additional metadata as key-value pairs.
    String
    getMetadataOrDefault(String key, String defaultValue)
    Additional metadata as key-value pairs.
    String
    getMetadataOrThrow(String key)
    Additional metadata as key-value pairs.
    Jobs.JobStatus
    getStatus()
    Current status of the job.
    boolean
    hasErrorMessage()
    Error message if the job failed.
    boolean
    hasStatus()
    Current status of the job.

    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

    • 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 if the job failed.
 Only set when status is JOB_STATUS_FAILED.
      optional string error_message = 2;
      Returns:
      Whether the errorMessage field is set.

    • getErrorMessage

      String getErrorMessage()
       Error message if the job failed.
 Only set when status is JOB_STATUS_FAILED.
      optional string error_message = 2;
      Returns:
      The errorMessage.

    • getErrorMessageBytes

      com.google.protobuf.ByteString getErrorMessageBytes()
       Error message if the job failed.
 Only set when status is JOB_STATUS_FAILED.
      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;