org.mlflow.api.proto

Class Service.RunInfo

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.mlflow.api.proto.Service.RunInfo

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, 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 and 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

Field Summary

Fields

Modifier and Type	Field and Description
static int	ARTIFACT_URI_FIELD_NUMBER
static int	END_TIME_FIELD_NUMBER
static int	EXPERIMENT_ID_FIELD_NUMBER
static int	LIFECYCLE_STAGE_FIELD_NUMBER
static com.google.protobuf.Parser<Service.RunInfo>	PARSER Deprecated.
static int	RUN_ID_FIELD_NUMBER
static int	RUN_UUID_FIELD_NUMBER
static int	START_TIME_FIELD_NUMBER
static int	STATUS_FIELD_NUMBER
static int	USER_ID_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 and Description
boolean	equals(Object obj)
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.
String	getExperimentId() The experiment ID.
com.google.protobuf.ByteString	getExperimentIdBytes() The experiment ID.
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()
String	getRunId() Unique identifier for the run.
com.google.protobuf.ByteString	getRunIdBytes() Unique identifier for the run.
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()
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	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)
static Service.RunInfo	parseDelimitedFrom(InputStream input)
static Service.RunInfo	parseDelimitedFrom(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(ByteBuffer data)
static Service.RunInfo	parseFrom(ByteBuffer 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(InputStream input)
static Service.RunInfo	parseFrom(InputStream input, 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, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

RUN_ID_FIELD_NUMBER

public static final int RUN_ID_FIELD_NUMBER

See Also:

Constant Field Values

RUN_UUID_FIELD_NUMBER

public static final int RUN_UUID_FIELD_NUMBER

See Also:

Constant Field Values

EXPERIMENT_ID_FIELD_NUMBER

public static final int EXPERIMENT_ID_FIELD_NUMBER

See Also:

Constant Field Values

USER_ID_FIELD_NUMBER

public static final int USER_ID_FIELD_NUMBER

See Also:

Constant Field Values

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER

See Also:

Constant Field Values

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER

See Also:

Constant Field Values

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER

See Also:

Constant Field Values

ARTIFACT_URI_FIELD_NUMBER

public static final int ARTIFACT_URI_FIELD_NUMBER

See Also:

Constant Field Values

LIFECYCLE_STAGE_FIELD_NUMBER

public static final int LIFECYCLE_STAGE_FIELD_NUMBER

See Also:

Constant Field Values

PARSER

@Deprecated
public static final com.google.protobuf.Parser<Service.RunInfo> PARSER

Deprecated.

Method Detail

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

getRunId

public String getRunId()

 Unique identifier for the run.
 

optional string run_id = 15;

Specified by:

getRunId in interface Service.RunInfoOrBuilder

getRunIdBytes

public com.google.protobuf.ByteString getRunIdBytes()

 Unique identifier for the run.
 

optional string run_id = 15;

Specified by:

getRunIdBytes in interface Service.RunInfoOrBuilder

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

getRunUuid

public 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

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

hasExperimentId

public boolean hasExperimentId()

 The experiment ID.
 

optional string experiment_id = 2;

Specified by:

hasExperimentId in interface Service.RunInfoOrBuilder

getExperimentId

public String getExperimentId()

 The experiment ID.
 

optional string experiment_id = 2;

Specified by:

getExperimentId in interface Service.RunInfoOrBuilder

getExperimentIdBytes

public com.google.protobuf.ByteString getExperimentIdBytes()

 The experiment ID.
 

optional string experiment_id = 2;

Specified by:

getExperimentIdBytes in interface Service.RunInfoOrBuilder

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

getUserId

public 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

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

hasStatus

public boolean hasStatus()

 Current status of the run.
 

optional .mlflow.RunStatus status = 7;

Specified by:

hasStatus in interface Service.RunInfoOrBuilder

getStatus

public Service.RunStatus getStatus()

 Current status of the run.
 

optional .mlflow.RunStatus status = 7;

Specified by:

getStatus in interface Service.RunInfoOrBuilder

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

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

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

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

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

getArtifactUri

public 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

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

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

getLifecycleStage

public String getLifecycleStage()

 Current life cycle stage of the experiment : OneOf("active", "deleted")
 

optional string lifecycle_stage = 14;

Specified by:

getLifecycleStage in interface Service.RunInfoOrBuilder

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

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 Service.RunInfo parseFrom(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Service.RunInfo parseFrom(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(InputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static Service.RunInfo parseFrom(InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static Service.RunInfo parseDelimitedFrom(InputStream input)
                                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static Service.RunInfo parseDelimitedFrom(InputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException

Throws:

IOException

parseFrom

public static Service.RunInfo parseFrom(com.google.protobuf.CodedInputStream input)
                                 throws IOException

Throws:

IOException

parseFrom

public static Service.RunInfo parseFrom(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

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

newBuilder

public static Service.RunInfo.Builder newBuilder()

newBuilder

public static Service.RunInfo.Builder newBuilder(Service.RunInfo prototype)

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

getDefaultInstance

public static Service.RunInfo getDefaultInstance()

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