Package org.mlflow.api.proto

Interface Service.RunInfoOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Service.RunInfo, Service.RunInfo.Builder
Enclosing class:
Service
public static interface Service.RunInfoOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    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")
    String
    getRunId()
    Unique identifier for the run.
    com.google.protobuf.ByteString
    getRunIdBytes()
    Unique identifier for the run.
    String
    getRunName()
    The name of the run.
    com.google.protobuf.ByteString
    getRunNameBytes()
    The name of 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.
    long
    getStartTime()
    Unix timestamp of when the run started in milliseconds.
    Service.RunStatus
    getStatus()
    Current status of the run.
    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.
    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.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • hasRunId

      boolean hasRunId()
       Unique identifier for the run.
      optional string run_id = 15;
      Returns:
      Whether the runId field is set.

    • getRunId

      String getRunId()
       Unique identifier for the run.
      optional string run_id = 15;
      Returns:
      The runId.

    • getRunIdBytes

      com.google.protobuf.ByteString getRunIdBytes()
       Unique identifier for the run.
      optional string run_id = 15;
      Returns:
      The bytes for runId.

    • hasRunUuid

      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;
      Returns:
      Whether the runUuid field is set.

    • getRunUuid

      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;
      Returns:
      The runUuid.

    • getRunUuidBytes

      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;
      Returns:
      The bytes for runUuid.

    • hasRunName

      boolean hasRunName()
       The name of the run.
      optional string run_name = 3;
      Returns:
      Whether the runName field is set.

    • getRunName

      String getRunName()
       The name of the run.
      optional string run_name = 3;
      Returns:
      The runName.

    • getRunNameBytes

      com.google.protobuf.ByteString getRunNameBytes()
       The name of the run.
      optional string run_name = 3;
      Returns:
      The bytes for runName.

    • hasExperimentId

      boolean hasExperimentId()
       The experiment ID.
      optional string experiment_id = 2;
      Returns:
      Whether the experimentId field is set.

    • getExperimentId

      String getExperimentId()
       The experiment ID.
      optional string experiment_id = 2;
      Returns:
      The experimentId.

    • getExperimentIdBytes

      com.google.protobuf.ByteString getExperimentIdBytes()
       The experiment ID.
      optional string experiment_id = 2;
      Returns:
      The bytes for experimentId.

    • hasUserId

      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;
      Returns:
      Whether the userId field is set.

    • getUserId

      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;
      Returns:
      The userId.

    • getUserIdBytes

      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;
      Returns:
      The bytes for userId.

    • hasStatus

      boolean hasStatus()
       Current status of the run.
      optional .mlflow.RunStatus status = 7;
      Returns:
      Whether the status field is set.

    • getStatus

      Service.RunStatus getStatus()
       Current status of the run.
      optional .mlflow.RunStatus status = 7;
      Returns:
      The status.

    • hasStartTime

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

    • getStartTime

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

    • hasEndTime

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

    • getEndTime

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

    • hasArtifactUri

      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;
      Returns:
      Whether the artifactUri field is set.

    • getArtifactUri

      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;
      Returns:
      The artifactUri.

    • getArtifactUriBytes

      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;
      Returns:
      The bytes for artifactUri.

    • hasLifecycleStage

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

    • getLifecycleStage

      String getLifecycleStage()
       Current life cycle stage of the experiment : OneOf("active", "deleted")
      optional string lifecycle_stage = 14;
      Returns:
      The lifecycleStage.

    • getLifecycleStageBytes

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