Package org.mlflow.api.proto

Interface ModelRegistry.SearchRegisteredModelsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
ModelRegistry.SearchRegisteredModels, ModelRegistry.SearchRegisteredModels.Builder
Enclosing class:
ModelRegistry
public static interface ModelRegistry.SearchRegisteredModelsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFilter()
    String filter condition, like "name LIKE 'my-model-name'".
    com.google.protobuf.ByteString
    getFilterBytes()
    String filter condition, like "name LIKE 'my-model-name'".
    long
    getMaxResults()
    Maximum number of models desired.
    String
    getOrderBy(int index)
    List of columns for ordering search results, which can include model name and last updated timestamp 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 model name and last updated timestamp with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
    int
    getOrderByCount()
    List of columns for ordering search results, which can include model name and last updated timestamp with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
    List<String>
    getOrderByList()
    List of columns for ordering search results, which can include model name and last updated timestamp with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
    String
    getPageToken()
    Pagination token to go to the next page based on a previous search query.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Pagination token to go to the next page based on a previous search query.
    boolean
    hasFilter()
    String filter condition, like "name LIKE 'my-model-name'".
    boolean
    hasMaxResults()
    Maximum number of models desired.
    boolean
    hasPageToken()
    Pagination token to go to the next page based on a previous search query.

    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

    • hasFilter

      boolean hasFilter()
       String filter condition, like "name LIKE 'my-model-name'".
 Interpreted in the backend automatically as "name LIKE '%my-model-name%'".
 Single boolean condition, with string values wrapped in single quotes.
      optional string filter = 1;
      Returns:
      Whether the filter field is set.

    • getFilter

      String getFilter()
       String filter condition, like "name LIKE 'my-model-name'".
 Interpreted in the backend automatically as "name LIKE '%my-model-name%'".
 Single boolean condition, with string values wrapped in single quotes.
      optional string filter = 1;
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       String filter condition, like "name LIKE 'my-model-name'".
 Interpreted in the backend automatically as "name LIKE '%my-model-name%'".
 Single boolean condition, with string values wrapped in single quotes.
      optional string filter = 1;
      Returns:
      The bytes for filter.

    • hasMaxResults

      boolean hasMaxResults()
       Maximum number of models desired. Default is 100. Max threshold is 1000.
      optional int64 max_results = 2 [default = 100];
      Returns:
      Whether the maxResults field is set.

    • getMaxResults

      long getMaxResults()
       Maximum number of models desired. Default is 100. Max threshold is 1000.
      optional int64 max_results = 2 [default = 100];
      Returns:
      The maxResults.

    • getOrderByList

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

    • getOrderByCount

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

    • getOrderBy

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

    • hasPageToken

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

    • getPageToken

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

    • getPageTokenBytes

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