Package org.mlflow.api.proto

Class Service.RunInfo.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, Service.RunInfoOrBuilder
    Enclosing class:
    Service.RunInfo
    public static final class Service.RunInfo.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Service.RunInfo.Builder>
implements Service.RunInfoOrBuilder
     Metadata of a single run.
    Protobuf type mlflow.RunInfo

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • clear

        public Service.RunInfo.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<Service.RunInfo.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<Service.RunInfo.Builder>

      • getDefaultInstanceForType

        public Service.RunInfo getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • clone

        public Service.RunInfo.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<Service.RunInfo.Builder>

      • setField

        public Service.RunInfo.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<Service.RunInfo.Builder>

      • clearField

        public Service.RunInfo.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<Service.RunInfo.Builder>

      • clearOneof

        public Service.RunInfo.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<Service.RunInfo.Builder>

      • setRepeatedField

        public Service.RunInfo.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<Service.RunInfo.Builder>

      • addRepeatedField

        public Service.RunInfo.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<Service.RunInfo.Builder>

      • mergeFrom

        public Service.RunInfo.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<Service.RunInfo.Builder>

      • isInitialized

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

      • mergeFrom

        public Service.RunInfo.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<Service.RunInfo.Builder>
        Throws:
        java.io.IOException

      • hasRunId

        public boolean hasRunId()
         Unique identifier for the run.
        optional string run_id = 15;
        Specified by:
        hasRunId in interface Service.RunInfoOrBuilder
        Returns:
        Whether the runId field is set.

      • getRunId

        public java.lang.String getRunId()
         Unique identifier for the run.
        optional string run_id = 15;
        Specified by:
        getRunId in interface Service.RunInfoOrBuilder
        Returns:
        The runId.

      • getRunIdBytes

        public com.google.protobuf.ByteString getRunIdBytes()
         Unique identifier for the run.
        optional string run_id = 15;
        Specified by:
        getRunIdBytes in interface Service.RunInfoOrBuilder
        Returns:
        The bytes for runId.

      • setRunId

        public Service.RunInfo.Builder setRunId​(java.lang.String value)
         Unique identifier for the run.
        optional string run_id = 15;
        Parameters:
        value - The runId to set.
        Returns:
        This builder for chaining.

      • clearRunId

        public Service.RunInfo.Builder clearRunId()
         Unique identifier for the run.
        optional string run_id = 15;
        Returns:
        This builder for chaining.

      • setRunIdBytes

        public Service.RunInfo.Builder setRunIdBytes​(com.google.protobuf.ByteString value)
         Unique identifier for the run.
        optional string run_id = 15;
        Parameters:
        value - The bytes for runId to set.
        Returns:
        This builder for chaining.

      • hasRunUuid

        public boolean hasRunUuid()
         [Deprecated, use run_id instead] Unique identifier for the run. This field will
 be removed in a future MLflow version.
        optional string run_uuid = 1;
        Specified by:
        hasRunUuid in interface Service.RunInfoOrBuilder
        Returns:
        Whether the runUuid field is set.

      • getRunUuid

        public java.lang.String getRunUuid()
         [Deprecated, use run_id instead] Unique identifier for the run. This field will
 be removed in a future MLflow version.
        optional string run_uuid = 1;
        Specified by:
        getRunUuid in interface Service.RunInfoOrBuilder
        Returns:
        The runUuid.

      • getRunUuidBytes

        public com.google.protobuf.ByteString getRunUuidBytes()
         [Deprecated, use run_id instead] Unique identifier for the run. This field will
 be removed in a future MLflow version.
        optional string run_uuid = 1;
        Specified by:
        getRunUuidBytes in interface Service.RunInfoOrBuilder
        Returns:
        The bytes for runUuid.

      • setRunUuid

        public Service.RunInfo.Builder setRunUuid​(java.lang.String value)
         [Deprecated, use run_id instead] Unique identifier for the run. This field will
 be removed in a future MLflow version.
        optional string run_uuid = 1;
        Parameters:
        value - The runUuid to set.
        Returns:
        This builder for chaining.

      • clearRunUuid

        public Service.RunInfo.Builder clearRunUuid()
         [Deprecated, use run_id instead] Unique identifier for the run. This field will
 be removed in a future MLflow version.
        optional string run_uuid = 1;
        Returns:
        This builder for chaining.

      • setRunUuidBytes

        public Service.RunInfo.Builder setRunUuidBytes​(com.google.protobuf.ByteString value)
         [Deprecated, use run_id instead] Unique identifier for the run. This field will
 be removed in a future MLflow version.
        optional string run_uuid = 1;
        Parameters:
        value - The bytes for runUuid to set.
        Returns:
        This builder for chaining.

      • hasRunName

        public boolean hasRunName()
         The name of the run.
        optional string run_name = 3;
        Specified by:
        hasRunName in interface Service.RunInfoOrBuilder
        Returns:
        Whether the runName field is set.

      • getRunName

        public java.lang.String getRunName()
         The name of the run.
        optional string run_name = 3;
        Specified by:
        getRunName in interface Service.RunInfoOrBuilder
        Returns:
        The runName.

      • getRunNameBytes

        public com.google.protobuf.ByteString getRunNameBytes()
         The name of the run.
        optional string run_name = 3;
        Specified by:
        getRunNameBytes in interface Service.RunInfoOrBuilder
        Returns:
        The bytes for runName.

      • setRunName

        public Service.RunInfo.Builder setRunName​(java.lang.String value)
         The name of the run.
        optional string run_name = 3;
        Parameters:
        value - The runName to set.
        Returns:
        This builder for chaining.

      • clearRunName

        public Service.RunInfo.Builder clearRunName()
         The name of the run.
        optional string run_name = 3;
        Returns:
        This builder for chaining.

      • setRunNameBytes

        public Service.RunInfo.Builder setRunNameBytes​(com.google.protobuf.ByteString value)
         The name of the run.
        optional string run_name = 3;
        Parameters:
        value - The bytes for runName to set.
        Returns:
        This builder for chaining.

      • hasExperimentId

        public boolean hasExperimentId()
         The experiment ID.
        optional string experiment_id = 2;
        Specified by:
        hasExperimentId in interface Service.RunInfoOrBuilder
        Returns:
        Whether the experimentId field is set.

      • getExperimentId

        public java.lang.String getExperimentId()
         The experiment ID.
        optional string experiment_id = 2;
        Specified by:
        getExperimentId in interface Service.RunInfoOrBuilder
        Returns:
        The experimentId.

      • getExperimentIdBytes

        public com.google.protobuf.ByteString getExperimentIdBytes()
         The experiment ID.
        optional string experiment_id = 2;
        Specified by:
        getExperimentIdBytes in interface Service.RunInfoOrBuilder
        Returns:
        The bytes for experimentId.

      • setExperimentId

        public Service.RunInfo.Builder setExperimentId​(java.lang.String value)
         The experiment ID.
        optional string experiment_id = 2;
        Parameters:
        value - The experimentId to set.
        Returns:
        This builder for chaining.

      • clearExperimentId

        public Service.RunInfo.Builder clearExperimentId()
         The experiment ID.
        optional string experiment_id = 2;
        Returns:
        This builder for chaining.

      • setExperimentIdBytes

        public Service.RunInfo.Builder setExperimentIdBytes​(com.google.protobuf.ByteString value)
         The experiment ID.
        optional string experiment_id = 2;
        Parameters:
        value - The bytes for experimentId to set.
        Returns:
        This builder for chaining.

      • hasUserId

        public boolean hasUserId()
         User who initiated the run.
 This field is deprecated as of MLflow 1.0, and will be removed in a future
 MLflow release. Use 'mlflow.user' tag instead.
        optional string user_id = 6;
        Specified by:
        hasUserId in interface Service.RunInfoOrBuilder
        Returns:
        Whether the userId field is set.

      • getUserId

        public java.lang.String getUserId()
         User who initiated the run.
 This field is deprecated as of MLflow 1.0, and will be removed in a future
 MLflow release. Use 'mlflow.user' tag instead.
        optional string user_id = 6;
        Specified by:
        getUserId in interface Service.RunInfoOrBuilder
        Returns:
        The userId.

      • getUserIdBytes

        public com.google.protobuf.ByteString getUserIdBytes()
         User who initiated the run.
 This field is deprecated as of MLflow 1.0, and will be removed in a future
 MLflow release. Use 'mlflow.user' tag instead.
        optional string user_id = 6;
        Specified by:
        getUserIdBytes in interface Service.RunInfoOrBuilder
        Returns:
        The bytes for userId.

      • setUserId

        public Service.RunInfo.Builder setUserId​(java.lang.String value)
         User who initiated the run.
 This field is deprecated as of MLflow 1.0, and will be removed in a future
 MLflow release. Use 'mlflow.user' tag instead.
        optional string user_id = 6;
        Parameters:
        value - The userId to set.
        Returns:
        This builder for chaining.

      • clearUserId

        public Service.RunInfo.Builder clearUserId()
         User who initiated the run.
 This field is deprecated as of MLflow 1.0, and will be removed in a future
 MLflow release. Use 'mlflow.user' tag instead.
        optional string user_id = 6;
        Returns:
        This builder for chaining.

      • setUserIdBytes

        public Service.RunInfo.Builder setUserIdBytes​(com.google.protobuf.ByteString value)
         User who initiated the run.
 This field is deprecated as of MLflow 1.0, and will be removed in a future
 MLflow release. Use 'mlflow.user' tag instead.
        optional string user_id = 6;
        Parameters:
        value - The bytes for userId to set.
        Returns:
        This builder for chaining.

      • hasStatus

        public boolean hasStatus()
         Current status of the run.
        optional .mlflow.RunStatus status = 7;
        Specified by:
        hasStatus in interface Service.RunInfoOrBuilder
        Returns:
        Whether the status field is set.

      • setStatus

        public Service.RunInfo.Builder setStatus​(Service.RunStatus value)
         Current status of the run.
        optional .mlflow.RunStatus status = 7;
        Parameters:
        value - The status to set.
        Returns:
        This builder for chaining.

      • clearStatus

        public Service.RunInfo.Builder clearStatus()
         Current status of the run.
        optional .mlflow.RunStatus status = 7;
        Returns:
        This builder for chaining.

      • hasStartTime

        public boolean hasStartTime()
         Unix timestamp of when the run started in milliseconds.
        optional int64 start_time = 8;
        Specified by:
        hasStartTime in interface Service.RunInfoOrBuilder
        Returns:
        Whether the startTime field is set.

      • getStartTime

        public long getStartTime()
         Unix timestamp of when the run started in milliseconds.
        optional int64 start_time = 8;
        Specified by:
        getStartTime in interface Service.RunInfoOrBuilder
        Returns:
        The startTime.

      • setStartTime

        public Service.RunInfo.Builder setStartTime​(long value)
         Unix timestamp of when the run started in milliseconds.
        optional int64 start_time = 8;
        Parameters:
        value - The startTime to set.
        Returns:
        This builder for chaining.

      • clearStartTime

        public Service.RunInfo.Builder clearStartTime()
         Unix timestamp of when the run started in milliseconds.
        optional int64 start_time = 8;
        Returns:
        This builder for chaining.

      • hasEndTime

        public boolean hasEndTime()
         Unix timestamp of when the run ended in milliseconds.
        optional int64 end_time = 9;
        Specified by:
        hasEndTime in interface Service.RunInfoOrBuilder
        Returns:
        Whether the endTime field is set.

      • getEndTime

        public long getEndTime()
         Unix timestamp of when the run ended in milliseconds.
        optional int64 end_time = 9;
        Specified by:
        getEndTime in interface Service.RunInfoOrBuilder
        Returns:
        The endTime.

      • setEndTime

        public Service.RunInfo.Builder setEndTime​(long value)
         Unix timestamp of when the run ended in milliseconds.
        optional int64 end_time = 9;
        Parameters:
        value - The endTime to set.
        Returns:
        This builder for chaining.

      • clearEndTime

        public Service.RunInfo.Builder clearEndTime()
         Unix timestamp of when the run ended in milliseconds.
        optional int64 end_time = 9;
        Returns:
        This builder for chaining.

      • hasArtifactUri

        public boolean hasArtifactUri()
         URI of the directory where artifacts should be uploaded.
 This can be a local path (starting with "/"), or a distributed file system (DFS)
 path, like ``s3://bucket/directory`` or ``dbfs:/my/directory``.
 If not set, the local ``./mlruns`` directory is  chosen.
        optional string artifact_uri = 13;
        Specified by:
        hasArtifactUri in interface Service.RunInfoOrBuilder
        Returns:
        Whether the artifactUri field is set.

      • getArtifactUri

        public java.lang.String getArtifactUri()
         URI of the directory where artifacts should be uploaded.
 This can be a local path (starting with "/"), or a distributed file system (DFS)
 path, like ``s3://bucket/directory`` or ``dbfs:/my/directory``.
 If not set, the local ``./mlruns`` directory is  chosen.
        optional string artifact_uri = 13;
        Specified by:
        getArtifactUri in interface Service.RunInfoOrBuilder
        Returns:
        The artifactUri.

      • getArtifactUriBytes

        public com.google.protobuf.ByteString getArtifactUriBytes()
         URI of the directory where artifacts should be uploaded.
 This can be a local path (starting with "/"), or a distributed file system (DFS)
 path, like ``s3://bucket/directory`` or ``dbfs:/my/directory``.
 If not set, the local ``./mlruns`` directory is  chosen.
        optional string artifact_uri = 13;
        Specified by:
        getArtifactUriBytes in interface Service.RunInfoOrBuilder
        Returns:
        The bytes for artifactUri.

      • setArtifactUri

        public Service.RunInfo.Builder setArtifactUri​(java.lang.String value)
         URI of the directory where artifacts should be uploaded.
 This can be a local path (starting with "/"), or a distributed file system (DFS)
 path, like ``s3://bucket/directory`` or ``dbfs:/my/directory``.
 If not set, the local ``./mlruns`` directory is  chosen.
        optional string artifact_uri = 13;
        Parameters:
        value - The artifactUri to set.
        Returns:
        This builder for chaining.

      • clearArtifactUri

        public Service.RunInfo.Builder clearArtifactUri()
         URI of the directory where artifacts should be uploaded.
 This can be a local path (starting with "/"), or a distributed file system (DFS)
 path, like ``s3://bucket/directory`` or ``dbfs:/my/directory``.
 If not set, the local ``./mlruns`` directory is  chosen.
        optional string artifact_uri = 13;
        Returns:
        This builder for chaining.

      • setArtifactUriBytes

        public Service.RunInfo.Builder setArtifactUriBytes​(com.google.protobuf.ByteString value)
         URI of the directory where artifacts should be uploaded.
 This can be a local path (starting with "/"), or a distributed file system (DFS)
 path, like ``s3://bucket/directory`` or ``dbfs:/my/directory``.
 If not set, the local ``./mlruns`` directory is  chosen.
        optional string artifact_uri = 13;
        Parameters:
        value - The bytes for artifactUri to set.
        Returns:
        This builder for chaining.

      • hasLifecycleStage

        public boolean hasLifecycleStage()
         Current life cycle stage of the experiment : OneOf("active", "deleted")
        optional string lifecycle_stage = 14;
        Specified by:
        hasLifecycleStage in interface Service.RunInfoOrBuilder
        Returns:
        Whether the lifecycleStage field is set.

      • getLifecycleStage

        public java.lang.String getLifecycleStage()
         Current life cycle stage of the experiment : OneOf("active", "deleted")
        optional string lifecycle_stage = 14;
        Specified by:
        getLifecycleStage in interface Service.RunInfoOrBuilder
        Returns:
        The lifecycleStage.

      • getLifecycleStageBytes

        public com.google.protobuf.ByteString getLifecycleStageBytes()
         Current life cycle stage of the experiment : OneOf("active", "deleted")
        optional string lifecycle_stage = 14;
        Specified by:
        getLifecycleStageBytes in interface Service.RunInfoOrBuilder
        Returns:
        The bytes for lifecycleStage.

      • setLifecycleStage

        public Service.RunInfo.Builder setLifecycleStage​(java.lang.String value)
         Current life cycle stage of the experiment : OneOf("active", "deleted")
        optional string lifecycle_stage = 14;
        Parameters:
        value - The lifecycleStage to set.
        Returns:
        This builder for chaining.

      • clearLifecycleStage

        public Service.RunInfo.Builder clearLifecycleStage()
         Current life cycle stage of the experiment : OneOf("active", "deleted")
        optional string lifecycle_stage = 14;
        Returns:
        This builder for chaining.

      • setLifecycleStageBytes

        public Service.RunInfo.Builder setLifecycleStageBytes​(com.google.protobuf.ByteString value)
         Current life cycle stage of the experiment : OneOf("active", "deleted")
        optional string lifecycle_stage = 14;
        Parameters:
        value - The bytes for lifecycleStage to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final Service.RunInfo.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<Service.RunInfo.Builder>

      • mergeUnknownFields

        public final Service.RunInfo.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<Service.RunInfo.Builder>