Package org.mlflow.api.proto

Class Service.RunInfo

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable, Service.RunInfoOrBuilder
    Enclosing class:
    Service
    public static final class Service.RunInfo
extends com.google.protobuf.GeneratedMessageV3
implements Service.RunInfoOrBuilder
     Metadata of a single run.
    Protobuf type mlflow.RunInfo
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Service.RunInfo.Builder
      Metadata of a single run.

      • 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.String getArtifactUri()
      URI of the directory where artifacts should be uploaded.
      com.google.protobuf.ByteString getArtifactUriBytes()
      URI of the directory where artifacts should be uploaded.
      static Service.RunInfo getDefaultInstance()  
      Service.RunInfo getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      long getEndTime()
      Unix timestamp of when the run ended in milliseconds.
      java.lang.String getExperimentId()
      The experiment ID.
      com.google.protobuf.ByteString getExperimentIdBytes()
      The experiment ID.
      java.lang.String getLifecycleStage()
      Current life cycle stage of the experiment : OneOf("active", "deleted")
      com.google.protobuf.ByteString getLifecycleStageBytes()
      Current life cycle stage of the experiment : OneOf("active", "deleted")
      com.google.protobuf.Parser<Service.RunInfo> getParserForType()  
      java.lang.String getRunId()
      Unique identifier for the run.
      com.google.protobuf.ByteString getRunIdBytes()
      Unique identifier for the run.
      java.lang.String getRunName()
      The name of the run.
      com.google.protobuf.ByteString getRunNameBytes()
      The name of the run.
      java.lang.String getRunUuid()
      [Deprecated, use run_id instead] Unique identifier for the run.
      com.google.protobuf.ByteString getRunUuidBytes()
      [Deprecated, use run_id instead] Unique identifier for the run.
      int getSerializedSize()  
      long getStartTime()
      Unix timestamp of when the run started in milliseconds.
      Service.RunStatus getStatus()
      Current status of the run.
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      java.lang.String getUserId()
      User who initiated the run.
      com.google.protobuf.ByteString getUserIdBytes()
      User who initiated the run.
      boolean hasArtifactUri()
      URI of the directory where artifacts should be uploaded.
      boolean hasEndTime()
      Unix timestamp of when the run ended in milliseconds.
      boolean hasExperimentId()
      The experiment ID.
      int hashCode()  
      boolean hasLifecycleStage()
      Current life cycle stage of the experiment : OneOf("active", "deleted")
      boolean hasRunId()
      Unique identifier for the run.
      boolean hasRunName()
      The name of the run.
      boolean hasRunUuid()
      [Deprecated, use run_id instead] Unique identifier for the run.
      boolean hasStartTime()
      Unix timestamp of when the run started in milliseconds.
      boolean hasStatus()
      Current status of the run.
      boolean hasUserId()
      User who initiated the run.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Service.RunInfo.Builder newBuilder()  
      static Service.RunInfo.Builder newBuilder​(Service.RunInfo prototype)  
      Service.RunInfo.Builder newBuilderForType()  
      protected Service.RunInfo.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Service.RunInfo parseDelimitedFrom​(java.io.InputStream input)  
      static Service.RunInfo parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Service.RunInfo parseFrom​(byte[] data)  
      static Service.RunInfo parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Service.RunInfo parseFrom​(com.google.protobuf.ByteString data)  
      static Service.RunInfo parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Service.RunInfo parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Service.RunInfo parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Service.RunInfo parseFrom​(java.io.InputStream input)  
      static Service.RunInfo parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Service.RunInfo parseFrom​(java.nio.ByteBuffer data)  
      static Service.RunInfo parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Service.RunInfo> parser()  
      Service.RunInfo.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, internalGetMapField, 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

    • 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()

      • internalGetFieldAccessorTable

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

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

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

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

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

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

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

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

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

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

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

      • 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 Service.RunInfo parseFrom​(java.nio.ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Service.RunInfo parseFrom​(java.nio.ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Service.RunInfo parseFrom​(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Service.RunInfo parseFrom​(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Service.RunInfo parseFrom​(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

        public static Service.RunInfo parseFrom​(java.io.InputStream input)
                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

        public static Service.RunInfo parseDelimitedFrom​(java.io.InputStream input)
                                          throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

        public static Service.RunInfo parseFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected Service.RunInfo.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • parser

        public static com.google.protobuf.Parser<Service.RunInfo> parser()

      • getParserForType

        public com.google.protobuf.Parser<Service.RunInfo> 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 Service.RunInfo getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder