Package org.mlflow.api.proto

Interface Service.ListExperimentsOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      long getMaxResults()
      Maximum number of experiments desired.
      java.lang.String getPageToken()
      Pagination token to go to the next page based on a previous query.
      com.google.protobuf.ByteString getPageTokenBytes()
      Pagination token to go to the next page based on a previous query.
      Service.ViewType getViewType()
      Qualifier for type of experiments to be returned.
      boolean hasMaxResults()
      Maximum number of experiments desired.
      boolean hasPageToken()
      Pagination token to go to the next page based on a previous query.
      boolean hasViewType()
      Qualifier for type of experiments to be returned.

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

      • hasViewType

        boolean hasViewType()
         Qualifier for type of experiments to be returned.
 If unspecified, return only active experiments.
        optional .mlflow.ViewType view_type = 1;
        Returns:
        Whether the viewType field is set.

      • getViewType

        Service.ViewType getViewType()
         Qualifier for type of experiments to be returned.
 If unspecified, return only active experiments.
        optional .mlflow.ViewType view_type = 1;
        Returns:
        The viewType.

      • hasMaxResults

        boolean hasMaxResults()
         Maximum number of experiments desired.
 Servers may select a desired default `max_results` value. All servers are
 guaranteed to support a `max_results` threshold of at least 1,000 but may
 support more. Callers of this endpoint are encouraged to pass max_results
 explicitly and leverage page_token to iterate through experiments.
        optional int64 max_results = 2;
        Returns:
        Whether the maxResults field is set.

      • getMaxResults

        long getMaxResults()
         Maximum number of experiments desired.
 Servers may select a desired default `max_results` value. All servers are
 guaranteed to support a `max_results` threshold of at least 1,000 but may
 support more. Callers of this endpoint are encouraged to pass max_results
 explicitly and leverage page_token to iterate through experiments.
        optional int64 max_results = 2;
        Returns:
        The maxResults.

      • hasPageToken

        boolean hasPageToken()
         Pagination token to go to the next page based on a previous query.
        optional string page_token = 3;
        Returns:
        Whether the pageToken field is set.

      • getPageToken

        java.lang.String getPageToken()
         Pagination token to go to the next page based on a previous query.
        optional string page_token = 3;
        Returns:
        The pageToken.

      • getPageTokenBytes

        com.google.protobuf.ByteString getPageTokenBytes()
         Pagination token to go to the next page based on a previous query.
        optional string page_token = 3;
        Returns:
        The bytes for pageToken.