Package org.mlflow.api.proto

Interface Service.SearchExperimentsOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getFilter()
      A filter expression over experiment attributes and tags that allows returning a subset of experiments.
      com.google.protobuf.ByteString getFilterBytes()
      A filter expression over experiment attributes and tags that allows returning a subset of experiments.
      long getMaxResults()
      Maximum number of experiments desired.
      java.lang.String getOrderBy​(int index)
      List of columns for ordering search results, which can include experiment name and id with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
      com.google.protobuf.ByteString getOrderByBytes​(int index)
      List of columns for ordering search results, which can include experiment name and id with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
      int getOrderByCount()
      List of columns for ordering search results, which can include experiment name and id with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
      java.util.List<java.lang.String> getOrderByList()
      List of columns for ordering search results, which can include experiment name and id with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
      java.lang.String getPageToken()
      Token indicating the page of experiments to fetch
      com.google.protobuf.ByteString getPageTokenBytes()
      Token indicating the page of experiments to fetch
      Service.ViewType getViewType()
      Qualifier for type of experiments to be returned.
      boolean hasFilter()
      A filter expression over experiment attributes and tags that allows returning a subset of experiments.
      boolean hasMaxResults()
      Maximum number of experiments desired.
      boolean hasPageToken()
      Token indicating the page of experiments to fetch
      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

      • 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 = 1;
        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 = 1;
        Returns:
        The maxResults.

      • hasPageToken

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

      • getPageToken

        java.lang.String getPageToken()
         Token indicating the page of experiments to fetch
        optional string page_token = 2;
        Returns:
        The pageToken.

      • getPageTokenBytes

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

      • hasFilter

        boolean hasFilter()
         A filter expression over experiment attributes and tags that allows returning a subset of
 experiments. The syntax is a subset of SQL that supports ANDing together binary operations
 between an attribute or tag, and a constant.
 Example: ``name LIKE 'test-%' AND tags.key = 'value'``
 You can select columns with special characters (hyphen, space, period, etc.) by using
 double quotes or backticks.
 Example: ``tags."extra-key" = 'value'`` or ``tags.`extra-key` = 'value'``
 Supported operators are ``=``, ``!=``, ``LIKE``, and ``ILIKE``.
        optional string filter = 3;
        Returns:
        Whether the filter field is set.

      • getFilter

        java.lang.String getFilter()
         A filter expression over experiment attributes and tags that allows returning a subset of
 experiments. The syntax is a subset of SQL that supports ANDing together binary operations
 between an attribute or tag, and a constant.
 Example: ``name LIKE 'test-%' AND tags.key = 'value'``
 You can select columns with special characters (hyphen, space, period, etc.) by using
 double quotes or backticks.
 Example: ``tags."extra-key" = 'value'`` or ``tags.`extra-key` = 'value'``
 Supported operators are ``=``, ``!=``, ``LIKE``, and ``ILIKE``.
        optional string filter = 3;
        Returns:
        The filter.

      • getFilterBytes

        com.google.protobuf.ByteString getFilterBytes()
         A filter expression over experiment attributes and tags that allows returning a subset of
 experiments. The syntax is a subset of SQL that supports ANDing together binary operations
 between an attribute or tag, and a constant.
 Example: ``name LIKE 'test-%' AND tags.key = 'value'``
 You can select columns with special characters (hyphen, space, period, etc.) by using
 double quotes or backticks.
 Example: ``tags."extra-key" = 'value'`` or ``tags.`extra-key` = 'value'``
 Supported operators are ``=``, ``!=``, ``LIKE``, and ``ILIKE``.
        optional string filter = 3;
        Returns:
        The bytes for filter.

      • getOrderByList

        java.util.List<java.lang.String> getOrderByList()
         List of columns for ordering search results, which can include experiment name and id
 with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Tiebreaks are done by experiment id DESC.
        repeated string order_by = 4;
        Returns:
        A list containing the orderBy.

      • getOrderByCount

        int getOrderByCount()
         List of columns for ordering search results, which can include experiment name and id
 with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Tiebreaks are done by experiment id DESC.
        repeated string order_by = 4;
        Returns:
        The count of orderBy.

      • getOrderBy

        java.lang.String getOrderBy​(int index)
         List of columns for ordering search results, which can include experiment name and id
 with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Tiebreaks are done by experiment id DESC.
        repeated string order_by = 4;
        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 for ordering search results, which can include experiment name and id
 with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Tiebreaks are done by experiment id DESC.
        repeated string order_by = 4;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the orderBy at the given index.

      • hasViewType

        boolean hasViewType()
         Qualifier for type of experiments to be returned.
 If unspecified, return only active experiments.
        optional .mlflow.ViewType view_type = 5;
        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 = 5;
        Returns:
        The viewType.