Package org.mlflow.api.proto

Class Jobs.JobState

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.mlflow.api.proto.Jobs.JobState
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Jobs.JobStateOrBuilder
Enclosing class:
Jobs
public static final class Jobs.JobState extends com.google.protobuf.GeneratedMessageV3 implements Jobs.JobStateOrBuilder
 Generic job state message combining status with metadata.
 Provides a unified way to represent job state across different job types.
Protobuf type mlflow.JobState
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Jobs.JobState.Builder
    Generic job state message combining status with metadata.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ERROR_MESSAGE_FIELD_NUMBER
     
    static final int
    METADATA_FIELD_NUMBER
     
    static final com.google.protobuf.Parser<Jobs.JobState>
    PARSER
    Deprecated.
    static final int
    PROGRESS_FIELD_NUMBER
     
    static final int
    PROGRESS_UPDATED_AT_FIELD_NUMBER
     
    static final int
    STATUS_FIELD_NUMBER
     
    static final int
    STATUS_MESSAGE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsMetadata(String key)
    Additional metadata as key-value pairs.
    boolean
    equals(Object obj)
     
    static Jobs.JobState
    getDefaultInstance()
     
    Jobs.JobState
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getErrorMessage()
    Error message for a terminal failure or timeout outcome, when available.
    com.google.protobuf.ByteString
    getErrorMessageBytes()
    Error message for a terminal failure or timeout outcome, when available.
    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.
    com.google.protobuf.Parser<Jobs.JobState>
    getParserForType()
     
    Jobs.JobProgress
    getProgress()
    Latest best-effort structured progress, e.g.
    Jobs.JobProgressOrBuilder
    getProgressOrBuilder()
    Latest best-effort structured progress, e.g.
    long
    getProgressUpdatedAt()
    Timestamp of the latest progress update in milliseconds since epoch.
    int
    getSerializedSize()
     
    Jobs.JobStatus
    getStatus()
    Current status of the job.
    String
    getStatusMessage()
    Latest best-effort in-flight status message, e.g.
    com.google.protobuf.ByteString
    getStatusMessageBytes()
    Latest best-effort in-flight status message, e.g.
    final com.google.protobuf.UnknownFieldSet
    getUnknownFields()
     
    boolean
    hasErrorMessage()
    Error message for a terminal failure or timeout outcome, when available.
    int
    hashCode()
     
    boolean
    hasProgress()
    Latest best-effort structured progress, e.g.
    boolean
    hasProgressUpdatedAt()
    Timestamp of the latest progress update in milliseconds since epoch.
    boolean
    hasStatus()
    Current status of the job.
    boolean
    hasStatusMessage()
    Latest best-effort in-flight status message, e.g.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapField
    internalGetMapField(int number)
     
    final boolean
    isInitialized()
     
    static Jobs.JobState.Builder
    newBuilder()
     
    static Jobs.JobState.Builder
    newBuilder(Jobs.JobState prototype)
     
    Jobs.JobState.Builder
    newBuilderForType()
     
    protected Jobs.JobState.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Jobs.JobState
    parseDelimitedFrom(InputStream input)
     
    static Jobs.JobState
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Jobs.JobState
    parseFrom(byte[] data)
     
    static Jobs.JobState
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Jobs.JobState
    parseFrom(com.google.protobuf.ByteString data)
     
    static Jobs.JobState
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Jobs.JobState
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Jobs.JobState
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Jobs.JobState
    parseFrom(InputStream input)
     
    static Jobs.JobState
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Jobs.JobState
    parseFrom(ByteBuffer data)
     
    static Jobs.JobState
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Jobs.JobState>
    parser()
     
    Jobs.JobState.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

  • Field Details

    • STATUS_FIELD_NUMBER

      public static final int STATUS_FIELD_NUMBER
      See Also:

    • ERROR_MESSAGE_FIELD_NUMBER

      public static final int ERROR_MESSAGE_FIELD_NUMBER
      See Also:

    • METADATA_FIELD_NUMBER

      public static final int METADATA_FIELD_NUMBER
      See Also:

    • STATUS_MESSAGE_FIELD_NUMBER

      public static final int STATUS_MESSAGE_FIELD_NUMBER
      See Also:

    • PROGRESS_FIELD_NUMBER

      public static final int PROGRESS_FIELD_NUMBER
      See Also:

    • PROGRESS_UPDATED_AT_FIELD_NUMBER

      public static final int PROGRESS_UPDATED_AT_FIELD_NUMBER
      See Also:

    • PARSER

      @Deprecated public static final com.google.protobuf.Parser<Jobs.JobState> PARSER
      Deprecated.

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapField

      protected com.google.protobuf.MapField internalGetMapField(int number)
      Overrides:
      internalGetMapField in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasStatus

      public boolean hasStatus()
       Current status of the job.
      optional .mlflow.JobStatus status = 1;
      Specified by:
      hasStatus in interface Jobs.JobStateOrBuilder
      Returns:
      Whether the status field is set.

    • getStatus

      public Jobs.JobStatus getStatus()
       Current status of the job.
      optional .mlflow.JobStatus status = 1;
      Specified by:
      getStatus in interface Jobs.JobStateOrBuilder
      Returns:
      The status.

    • hasErrorMessage

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

    • getErrorMessage

      public String getErrorMessage()
       Error message for a terminal failure or timeout outcome, when available.
      optional string error_message = 2;
      Specified by:
      getErrorMessage in interface Jobs.JobStateOrBuilder
      Returns:
      The errorMessage.

    • getErrorMessageBytes

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

    • getMetadataCount

      public int getMetadataCount()
      Description copied from interface: Jobs.JobStateOrBuilder
       Additional metadata as key-value pairs.
 Can be used to store job-specific state information.
      map<string, string> metadata = 3;
      Specified by:
      getMetadataCount in interface Jobs.JobStateOrBuilder

    • containsMetadata

      public boolean containsMetadata(String key)
       Additional metadata as key-value pairs.
 Can be used to store job-specific state information.
      map<string, string> metadata = 3;
      Specified by:
      containsMetadata in interface Jobs.JobStateOrBuilder

    • getMetadata

      @Deprecated public Map<String,String> getMetadata()
      Deprecated.
      Use getMetadataMap() instead.
      Specified by:
      getMetadata in interface Jobs.JobStateOrBuilder

    • getMetadataMap

      public Map<String,String> getMetadataMap()
       Additional metadata as key-value pairs.
 Can be used to store job-specific state information.
      map<string, string> metadata = 3;
      Specified by:
      getMetadataMap in interface Jobs.JobStateOrBuilder

    • getMetadataOrDefault

      public 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;
      Specified by:
      getMetadataOrDefault in interface Jobs.JobStateOrBuilder

    • getMetadataOrThrow

      public String getMetadataOrThrow(String key)
       Additional metadata as key-value pairs.
 Can be used to store job-specific state information.
      map<string, string> metadata = 3;
      Specified by:
      getMetadataOrThrow in interface Jobs.JobStateOrBuilder

    • hasStatusMessage

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

    • getStatusMessage

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

    • getStatusMessageBytes

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

    • hasProgress

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

    • getProgress

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

    • getProgressOrBuilder

      public Jobs.JobProgressOrBuilder getProgressOrBuilder()
       Latest best-effort structured progress, e.g. ``phase="scoring", completed=42``.
      optional .mlflow.JobProgress progress = 5;
      Specified by:
      getProgressOrBuilder in interface Jobs.JobStateOrBuilder

    • hasProgressUpdatedAt

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

    • getProgressUpdatedAt

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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Jobs.JobState parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Jobs.JobState parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Jobs.JobState parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Jobs.JobState parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Jobs.JobState parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Jobs.JobState parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Jobs.JobState parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Jobs.JobState parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Jobs.JobState parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Jobs.JobState parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Jobs.JobState parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Jobs.JobState parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Jobs.JobState.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Jobs.JobState.Builder newBuilder()

    • newBuilder

      public static Jobs.JobState.Builder newBuilder(Jobs.JobState prototype)

    • toBuilder

      public Jobs.JobState.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Jobs.JobState.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Jobs.JobState getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Jobs.JobState> parser()

    • getParserForType

      public com.google.protobuf.Parser<Jobs.JobState> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public Jobs.JobState getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder