Package org.mlflow.api.proto

Interface ModelRegistry.SearchModelVersionsOrBuilder

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

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getFilter()
    String filter condition, like "name='my-model-name'".
    com.google.protobuf.ByteString getFilterBytes()
    String filter condition, like "name='my-model-name'".
    long getMaxResults()
    Maximum number of models desired.
    java.lang.String getOrderBy​(int index)
    List of columns to be ordered by including model name, version, stage 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 model name, version, stage with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
    int getOrderByCount()
    List of columns to be ordered by including model name, version, stage with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
    java.util.List<java.lang.String> getOrderByList()
    List of columns to be ordered by including model name, version, stage with an optional "DESC" or "ASC" annotation, where "ASC" is the default.
    java.lang.String getPageToken()
    Pagination token to go to next page based on previous search query.
    com.google.protobuf.ByteString getPageTokenBytes()
    Pagination token to go to next page based on previous search query.
    boolean hasFilter()
    String filter condition, like "name='my-model-name'".
    boolean hasMaxResults()
    Maximum number of models desired.
    boolean hasPageToken()
    Pagination token to go to next page based on 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='my-model-name'". Must be a single boolean condition,
 with string values wrapped in single quotes.
      optional string filter = 1;

    • getFilter

      java.lang.String getFilter()
       String filter condition, like "name='my-model-name'". Must be a single boolean condition,
 with string values wrapped in single quotes.
      optional string filter = 1;

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       String filter condition, like "name='my-model-name'". Must be a single boolean condition,
 with string values wrapped in single quotes.
      optional string filter = 1;

    • hasMaxResults

      boolean hasMaxResults()
       Maximum number of models desired. Max threshold is 200K.
      optional int64 max_results = 2 [default = 200000];

    • getMaxResults

      long getMaxResults()
       Maximum number of models desired. Max threshold is 200K.
      optional int64 max_results = 2 [default = 200000];

    • getOrderByList

      java.util.List<java.lang.String> getOrderByList()
       List of columns to be ordered by including model name, version, stage with an
 optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Tiebreaks are done by latest stage transition timestamp, followed by name ASC, followed by
 version DESC.
      repeated string order_by = 3;

    • getOrderByCount

      int getOrderByCount()
       List of columns to be ordered by including model name, version, stage with an
 optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Tiebreaks are done by latest stage transition timestamp, followed by name ASC, followed by
 version DESC.
      repeated string order_by = 3;

    • getOrderBy

      java.lang.String getOrderBy​(int index)
       List of columns to be ordered by including model name, version, stage with an
 optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Tiebreaks are done by latest stage transition timestamp, followed by name ASC, followed by
 version DESC.
      repeated string order_by = 3;

    • getOrderByBytes

      com.google.protobuf.ByteString getOrderByBytes​(int index)
       List of columns to be ordered by including model name, version, stage with an
 optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Tiebreaks are done by latest stage transition timestamp, followed by name ASC, followed by
 version DESC.
      repeated string order_by = 3;

    • hasPageToken

      boolean hasPageToken()
       Pagination token to go to next page based on previous search query.
      optional string page_token = 4;

    • getPageToken

      java.lang.String getPageToken()
       Pagination token to go to next page based on previous search query.
      optional string page_token = 4;

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       Pagination token to go to next page based on previous search query.
      optional string page_token = 4;