Package org.mlflow.api.proto

Interface Service.ListArtifactsOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getPageToken()
    Token indicating the page of artifact results to fetch
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Token indicating the page of artifact results to fetch
    String
    getPath()
    Filter artifacts matching this path (a relative path from the root artifact directory).
    com.google.protobuf.ByteString
    getPathBytes()
    Filter artifacts matching this path (a relative path from the root artifact directory).
    String
    getRunId()
    ID of the run whose artifacts to list.
    com.google.protobuf.ByteString
    getRunIdBytes()
    ID of the run whose artifacts to list.
    String
    getRunUuid()
    [Deprecated, use run_id instead] ID of the run whose artifacts to list.
    com.google.protobuf.ByteString
    getRunUuidBytes()
    [Deprecated, use run_id instead] ID of the run whose artifacts to list.
    boolean
    hasPageToken()
    Token indicating the page of artifact results to fetch
    boolean
    hasPath()
    Filter artifacts matching this path (a relative path from the root artifact directory).
    boolean
    hasRunId()
    ID of the run whose artifacts to list.
    boolean
    hasRunUuid()
    [Deprecated, use run_id instead] ID of the run whose artifacts to list.

    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()
       ID of the run whose artifacts to list. Must be provided.
      optional string run_id = 3;
      Returns:
      Whether the runId field is set.

    • getRunId

      String getRunId()
       ID of the run whose artifacts to list. Must be provided.
      optional string run_id = 3;
      Returns:
      The runId.

    • getRunIdBytes

      com.google.protobuf.ByteString getRunIdBytes()
       ID of the run whose artifacts to list. Must be provided.
      optional string run_id = 3;
      Returns:
      The bytes for runId.

    • hasRunUuid

      boolean hasRunUuid()
       [Deprecated, use run_id instead] ID of the run whose artifacts to list. 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] ID of the run whose artifacts to list. 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] ID of the run whose artifacts to list. This field will
 be removed in a future MLflow version.
      optional string run_uuid = 1;
      Returns:
      The bytes for runUuid.

    • hasPath

      boolean hasPath()
       Filter artifacts matching this path (a relative path from the root artifact directory).
      optional string path = 2;
      Returns:
      Whether the path field is set.

    • getPath

      String getPath()
       Filter artifacts matching this path (a relative path from the root artifact directory).
      optional string path = 2;
      Returns:
      The path.

    • getPathBytes

      com.google.protobuf.ByteString getPathBytes()
       Filter artifacts matching this path (a relative path from the root artifact directory).
      optional string path = 2;
      Returns:
      The bytes for path.

    • hasPageToken

      boolean hasPageToken()
       Token indicating the page of artifact results to fetch
      optional string page_token = 4;
      Returns:
      Whether the pageToken field is set.

    • getPageToken

      String getPageToken()
       Token indicating the page of artifact results to fetch
      optional string page_token = 4;
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       Token indicating the page of artifact results to fetch
      optional string page_token = 4;
      Returns:
      The bytes for pageToken.