Package org.mlflow.api.proto

Class Jobs.JobState.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable, Jobs.JobStateOrBuilder
    Enclosing class:
    Jobs.JobState
    public static final class Jobs.JobState.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Jobs.JobState.Builder>
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

    • Method Detail

      • 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.Builder<Jobs.JobState.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Jobs.JobState.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Jobs.JobState.Builder>

      • clear

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

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Jobs.JobState.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

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

      • setField

        public Jobs.JobState.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Jobs.JobState.Builder>

      • clearField

        public Jobs.JobState.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Jobs.JobState.Builder>

      • clearOneof

        public Jobs.JobState.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Jobs.JobState.Builder>

      • setRepeatedField

        public Jobs.JobState.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              int index,
                                              java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Jobs.JobState.Builder>

      • addRepeatedField

        public Jobs.JobState.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Jobs.JobState.Builder>

      • mergeFrom

        public Jobs.JobState.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Jobs.JobState.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Jobs.JobState.Builder>

      • mergeFrom

        public Jobs.JobState.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Jobs.JobState.Builder>
        Throws:
        java.io.IOException

      • 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.

      • setStatus

        public Jobs.JobState.Builder setStatus​(Jobs.JobStatus value)
         Current status of the job.
        optional .mlflow.JobStatus status = 1;
        Parameters:
        value - The status to set.
        Returns:
        This builder for chaining.

      • clearStatus

        public Jobs.JobState.Builder clearStatus()
         Current status of the job.
        optional .mlflow.JobStatus status = 1;
        Returns:
        This builder for chaining.

      • 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.

      • setErrorMessage

        public Jobs.JobState.Builder setErrorMessage​(java.lang.String value)
         Error message if the job failed.
 Only set when status is JOB_STATUS_FAILED.
        optional string error_message = 2;
        Parameters:
        value - The errorMessage to set.
        Returns:
        This builder for chaining.

      • clearErrorMessage

        public Jobs.JobState.Builder clearErrorMessage()
         Error message if the job failed.
 Only set when status is JOB_STATUS_FAILED.
        optional string error_message = 2;
        Returns:
        This builder for chaining.

      • setErrorMessageBytes

        public Jobs.JobState.Builder setErrorMessageBytes​(com.google.protobuf.ByteString value)
         Error message if the job failed.
 Only set when status is JOB_STATUS_FAILED.
        optional string error_message = 2;
        Parameters:
        value - The bytes for errorMessage to set.
        Returns:
        This builder for chaining.

      • 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

      • removeMetadata

        public Jobs.JobState.Builder removeMetadata​(java.lang.String key)
         Additional metadata as key-value pairs.
 Can be used to store job-specific state information.
        map<string, string> metadata = 3;

      • getMutableMetadata

        @Deprecated
public java.util.Map<java.lang.String,​java.lang.String> getMutableMetadata()
        Deprecated.
        Use alternate mutation accessors instead.

      • putMetadata

        public Jobs.JobState.Builder putMetadata​(java.lang.String key,
                                         java.lang.String value)
         Additional metadata as key-value pairs.
 Can be used to store job-specific state information.
        map<string, string> metadata = 3;

      • putAllMetadata

        public Jobs.JobState.Builder putAllMetadata​(java.util.Map<java.lang.String,​java.lang.String> values)
         Additional metadata as key-value pairs.
 Can be used to store job-specific state information.
        map<string, string> metadata = 3;

      • setUnknownFields

        public final Jobs.JobState.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Jobs.JobState.Builder>

      • mergeUnknownFields

        public final Jobs.JobState.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Jobs.JobState.Builder>