Package org.mlflow.api.proto

Interface Service.SearchRunsOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getExperimentIds(int index)
    List of experiment IDs to search over.
    com.google.protobuf.ByteString
    getExperimentIdsBytes(int index)
    List of experiment IDs to search over.
    int
    getExperimentIdsCount()
    List of experiment IDs to search over.
    List<String>
    getExperimentIdsList()
    List of experiment IDs to search over.
    String
    getFilter()
    A filter expression over params, metrics, and tags, that allows returning a subset of runs.
    com.google.protobuf.ByteString
    getFilterBytes()
    A filter expression over params, metrics, and tags, that allows returning a subset of runs.
    int
    getMaxResults()
    Maximum number of runs desired.
    String
    getOrderBy(int index)
    List of columns to be ordered by, including attributes, params, metrics, and tags with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
    com.google.protobuf.ByteString
    getOrderByBytes(int index)
    List of columns to be ordered by, including attributes, params, metrics, and tags with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
    int
    getOrderByCount()
    List of columns to be ordered by, including attributes, params, metrics, and tags with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
    List<String>
    getOrderByList()
    List of columns to be ordered by, including attributes, params, metrics, and tags with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
    String
    getPageToken()
    optional string page_token = 7;
    com.google.protobuf.ByteString
    getPageTokenBytes()
    optional string page_token = 7;
    Service.ViewType
    getRunViewType()
    Whether to display only active, only deleted, or all runs.
    boolean
    hasFilter()
    A filter expression over params, metrics, and tags, that allows returning a subset of runs.
    boolean
    hasMaxResults()
    Maximum number of runs desired.
    boolean
    hasPageToken()
    optional string page_token = 7;
    boolean
    hasRunViewType()
    Whether to display only active, only deleted, or all runs.

    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

    • getExperimentIdsList

      List<String> getExperimentIdsList()
       List of experiment IDs to search over.
      repeated string experiment_ids = 1;
      Returns:
      A list containing the experimentIds.

    • getExperimentIdsCount

      int getExperimentIdsCount()
       List of experiment IDs to search over.
      repeated string experiment_ids = 1;
      Returns:
      The count of experimentIds.

    • getExperimentIds

      String getExperimentIds(int index)
       List of experiment IDs to search over.
      repeated string experiment_ids = 1;
      Parameters:
      index - The index of the element to return.
      Returns:
      The experimentIds at the given index.

    • getExperimentIdsBytes

      com.google.protobuf.ByteString getExperimentIdsBytes(int index)
       List of experiment IDs to search over.
      repeated string experiment_ids = 1;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the experimentIds at the given index.

    • hasFilter

      boolean hasFilter()
       A filter expression over params, metrics, and tags, that allows returning a subset of
 runs. The syntax is a subset of SQL that supports ANDing together binary operations
 between a param, metric, or tag and a constant.
 Example: ``metrics.rmse < 1 and params.model_class = 'LogisticRegression'``
 You can select columns with special characters (hyphen, space, period, etc.) by using double quotes:
 ``metrics."model class" = 'LinearRegression' and tags."user-name" = 'Tomas'``
 Supported operators are ``=``, ``!=``, ``>``, ``>=``, ``<``, and ``<=``.
      optional string filter = 4;
      Returns:
      Whether the filter field is set.

    • getFilter

      String getFilter()
       A filter expression over params, metrics, and tags, that allows returning a subset of
 runs. The syntax is a subset of SQL that supports ANDing together binary operations
 between a param, metric, or tag and a constant.
 Example: ``metrics.rmse < 1 and params.model_class = 'LogisticRegression'``
 You can select columns with special characters (hyphen, space, period, etc.) by using double quotes:
 ``metrics."model class" = 'LinearRegression' and tags."user-name" = 'Tomas'``
 Supported operators are ``=``, ``!=``, ``>``, ``>=``, ``<``, and ``<=``.
      optional string filter = 4;
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       A filter expression over params, metrics, and tags, that allows returning a subset of
 runs. The syntax is a subset of SQL that supports ANDing together binary operations
 between a param, metric, or tag and a constant.
 Example: ``metrics.rmse < 1 and params.model_class = 'LogisticRegression'``
 You can select columns with special characters (hyphen, space, period, etc.) by using double quotes:
 ``metrics."model class" = 'LinearRegression' and tags."user-name" = 'Tomas'``
 Supported operators are ``=``, ``!=``, ``>``, ``>=``, ``<``, and ``<=``.
      optional string filter = 4;
      Returns:
      The bytes for filter.

    • hasRunViewType

      boolean hasRunViewType()
       Whether to display only active, only deleted, or all runs.
 Defaults to only active runs.
      optional .mlflow.ViewType run_view_type = 3 [default = ACTIVE_ONLY];
      Returns:
      Whether the runViewType field is set.

    • getRunViewType

      Service.ViewType getRunViewType()
       Whether to display only active, only deleted, or all runs.
 Defaults to only active runs.
      optional .mlflow.ViewType run_view_type = 3 [default = ACTIVE_ONLY];
      Returns:
      The runViewType.

    • hasMaxResults

      boolean hasMaxResults()
       Maximum number of runs desired. If unspecified, defaults to 1000.
 All servers are guaranteed to support a `max_results` threshold of at least 50,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 int32 max_results = 5 [default = 1000];
      Returns:
      Whether the maxResults field is set.

    • getMaxResults

      int getMaxResults()
       Maximum number of runs desired. If unspecified, defaults to 1000.
 All servers are guaranteed to support a `max_results` threshold of at least 50,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 int32 max_results = 5 [default = 1000];
      Returns:
      The maxResults.

    • getOrderByList

      List<String> getOrderByList()
       List of columns to be ordered by, including attributes, params, metrics, and tags with an
 optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Example: ["params.input DESC", "metrics.alpha ASC", "metrics.rmse"]
 Tiebreaks are done by start_time DESC followed by run_id for runs with the same start time
 (and this is the default ordering criterion if order_by is not provided).
      repeated string order_by = 6;
      Returns:
      A list containing the orderBy.

    • getOrderByCount

      int getOrderByCount()
       List of columns to be ordered by, including attributes, params, metrics, and tags with an
 optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Example: ["params.input DESC", "metrics.alpha ASC", "metrics.rmse"]
 Tiebreaks are done by start_time DESC followed by run_id for runs with the same start time
 (and this is the default ordering criterion if order_by is not provided).
      repeated string order_by = 6;
      Returns:
      The count of orderBy.

    • getOrderBy

      String getOrderBy(int index)
       List of columns to be ordered by, including attributes, params, metrics, and tags with an
 optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Example: ["params.input DESC", "metrics.alpha ASC", "metrics.rmse"]
 Tiebreaks are done by start_time DESC followed by run_id for runs with the same start time
 (and this is the default ordering criterion if order_by is not provided).
      repeated string order_by = 6;
      Parameters:
      index - The index of the element to return.
      Returns:
      The orderBy at the given index.

    • getOrderByBytes

      com.google.protobuf.ByteString getOrderByBytes(int index)
       List of columns to be ordered by, including attributes, params, metrics, and tags with an
 optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Example: ["params.input DESC", "metrics.alpha ASC", "metrics.rmse"]
 Tiebreaks are done by start_time DESC followed by run_id for runs with the same start time
 (and this is the default ordering criterion if order_by is not provided).
      repeated string order_by = 6;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the orderBy at the given index.

    • hasPageToken

      boolean hasPageToken()
      optional string page_token = 7;
      Returns:
      Whether the pageToken field is set.

    • getPageToken

      String getPageToken()
      optional string page_token = 7;
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
      optional string page_token = 7;
      Returns:
      The bytes for pageToken.