Package org.mlflow.api.proto

Class Jobs.JobState

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.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:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static 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<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, 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 int ERROR_MESSAGE_FIELD_NUMBER  
      static int METADATA_FIELD_NUMBER  
      static com.google.protobuf.Parser<Jobs.JobState> PARSER
      Deprecated.
      static int STATUS_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

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsMetadata​(java.lang.String key)
      Additional metadata as key-value pairs.
      boolean equals​(java.lang.Object obj)  
      static Jobs.JobState getDefaultInstance()  
      Jobs.JobState getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      java.lang.String getErrorMessage()
      Error message if the job failed.
      com.google.protobuf.ByteString getErrorMessageBytes()
      Error message if the job failed.
      java.util.Map<java.lang.String,​java.lang.String> getMetadata()
      Deprecated.
      int getMetadataCount()
      Additional metadata as key-value pairs.
      java.util.Map<java.lang.String,​java.lang.String> getMetadataMap()
      Additional metadata as key-value pairs.
      java.lang.String getMetadataOrDefault​(java.lang.String key, java.lang.String defaultValue)
      Additional metadata as key-value pairs.
      java.lang.String getMetadataOrThrow​(java.lang.String key)
      Additional metadata as key-value pairs.
      com.google.protobuf.Parser<Jobs.JobState> getParserForType()  
      int getSerializedSize()  
      Jobs.JobStatus getStatus()
      Current status of the job.
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      boolean hasErrorMessage()
      Error message if the job failed.
      int hashCode()  
      boolean hasStatus()
      Current status of the job.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      protected com.google.protobuf.MapField internalGetMapField​(int number)  
      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 java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Jobs.JobState parseDelimitedFrom​(java.io.InputStream input)  
      static Jobs.JobState parseDelimitedFrom​(java.io.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​(java.io.InputStream input)  
      static Jobs.JobState parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Jobs.JobState parseFrom​(java.nio.ByteBuffer data)  
      static Jobs.JobState parseFrom​(java.nio.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, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, 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 Detail

      • ERROR_MESSAGE_FIELD_NUMBER

        public static final int ERROR_MESSAGE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PARSER

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

    • Method Detail

      • newInstance

        protected java.lang.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.

      • hasErrorMessage

        public boolean hasErrorMessage()
         Error message if the job failed.
 Only set when status is JOB_STATUS_FAILED.
        optional string error_message = 2;
        Specified by:
        hasErrorMessage in interface Jobs.JobStateOrBuilder
        Returns:
        Whether the errorMessage field is set.

      • getErrorMessage

        public java.lang.String getErrorMessage()
         Error message if the job failed.
 Only set when status is JOB_STATUS_FAILED.
        optional string error_message = 2;
        Specified by:
        getErrorMessage in interface Jobs.JobStateOrBuilder
        Returns:
        The errorMessage.

      • getErrorMessageBytes

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

      • getMetadataMap

        public java.util.Map<java.lang.String,​java.lang.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 java.lang.String getMetadataOrDefault​(java.lang.String key,
                                             java.lang.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 java.lang.String getMetadataOrThrow​(java.lang.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

      • 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 java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.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​(java.lang.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​(java.nio.ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Jobs.JobState parseFrom​(java.nio.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​(java.io.InputStream input)
                               throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

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

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

        public static Jobs.JobState parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws java.io.IOException
        Throws:
        java.io.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

      • 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