Package org.mlflow.api.proto

Class ModelRegistry.SearchModelVersions.Builder

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ModelRegistry.SearchModelVersions.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ModelRegistry.SearchModelVersions.Builder>

      • getDefaultInstanceForType

        public ModelRegistry.SearchModelVersions getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public ModelRegistry.SearchModelVersions build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public ModelRegistry.SearchModelVersions buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ModelRegistry.SearchModelVersions.Builder>

      • mergeFrom

        public ModelRegistry.SearchModelVersions.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws java.io.IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ModelRegistry.SearchModelVersions.Builder>
        Throws:
        java.io.IOException

      • hasFilter

        public 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;
        Specified by:
        hasFilter in interface ModelRegistry.SearchModelVersionsOrBuilder
        Returns:
        Whether the filter field is set.

      • getFilter

        public 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;
        Specified by:
        getFilter in interface ModelRegistry.SearchModelVersionsOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public 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;
        Specified by:
        getFilterBytes in interface ModelRegistry.SearchModelVersionsOrBuilder
        Returns:
        The bytes for filter.

      • setFilter

        public ModelRegistry.SearchModelVersions.Builder setFilter​(java.lang.String value)
         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;
        Parameters:
        value - The filter to set.
        Returns:
        This builder for chaining.

      • clearFilter

        public ModelRegistry.SearchModelVersions.Builder clearFilter()
         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;
        Returns:
        This builder for chaining.

      • setFilterBytes

        public ModelRegistry.SearchModelVersions.Builder setFilterBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for filter to set.
        Returns:
        This builder for chaining.

      • hasMaxResults

        public boolean hasMaxResults()
         Maximum number of models desired. Max threshold is 200K. Backends may choose a lower default
 value and maximum threshold.
        optional int64 max_results = 2 [default = 200000];
        Specified by:
        hasMaxResults in interface ModelRegistry.SearchModelVersionsOrBuilder
        Returns:
        Whether the maxResults field is set.

      • getMaxResults

        public long getMaxResults()
         Maximum number of models desired. Max threshold is 200K. Backends may choose a lower default
 value and maximum threshold.
        optional int64 max_results = 2 [default = 200000];
        Specified by:
        getMaxResults in interface ModelRegistry.SearchModelVersionsOrBuilder
        Returns:
        The maxResults.

      • setMaxResults

        public ModelRegistry.SearchModelVersions.Builder setMaxResults​(long value)
         Maximum number of models desired. Max threshold is 200K. Backends may choose a lower default
 value and maximum threshold.
        optional int64 max_results = 2 [default = 200000];
        Parameters:
        value - The maxResults to set.
        Returns:
        This builder for chaining.

      • clearMaxResults

        public ModelRegistry.SearchModelVersions.Builder clearMaxResults()
         Maximum number of models desired. Max threshold is 200K. Backends may choose a lower default
 value and maximum threshold.
        optional int64 max_results = 2 [default = 200000];
        Returns:
        This builder for chaining.

      • getOrderByList

        public com.google.protobuf.ProtocolStringList 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;
        Specified by:
        getOrderByList in interface ModelRegistry.SearchModelVersionsOrBuilder
        Returns:
        A list containing the orderBy.

      • getOrderByCount

        public 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;
        Specified by:
        getOrderByCount in interface ModelRegistry.SearchModelVersionsOrBuilder
        Returns:
        The count of orderBy.

      • getOrderBy

        public 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;
        Specified by:
        getOrderBy in interface ModelRegistry.SearchModelVersionsOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The orderBy at the given index.

      • getOrderByBytes

        public 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;
        Specified by:
        getOrderByBytes in interface ModelRegistry.SearchModelVersionsOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the orderBy at the given index.

      • setOrderBy

        public ModelRegistry.SearchModelVersions.Builder setOrderBy​(int index,
                                                            java.lang.String value)
         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;
        Parameters:
        index - The index to set the value at.
        value - The orderBy to set.
        Returns:
        This builder for chaining.

      • addOrderBy

        public ModelRegistry.SearchModelVersions.Builder addOrderBy​(java.lang.String value)
         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;
        Parameters:
        value - The orderBy to add.
        Returns:
        This builder for chaining.

      • addAllOrderBy

        public ModelRegistry.SearchModelVersions.Builder addAllOrderBy​(java.lang.Iterable<java.lang.String> values)
         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;
        Parameters:
        values - The orderBy to add.
        Returns:
        This builder for chaining.

      • clearOrderBy

        public ModelRegistry.SearchModelVersions.Builder clearOrderBy()
         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;
        Returns:
        This builder for chaining.

      • addOrderByBytes

        public ModelRegistry.SearchModelVersions.Builder addOrderByBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes of the orderBy to add.
        Returns:
        This builder for chaining.

      • hasPageToken

        public boolean hasPageToken()
         Pagination token to go to next page based on previous search query.
        optional string page_token = 4;
        Specified by:
        hasPageToken in interface ModelRegistry.SearchModelVersionsOrBuilder
        Returns:
        Whether the pageToken field is set.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         Pagination token to go to next page based on previous search query.
        optional string page_token = 4;
        Specified by:
        getPageTokenBytes in interface ModelRegistry.SearchModelVersionsOrBuilder
        Returns:
        The bytes for pageToken.

      • setPageToken

        public ModelRegistry.SearchModelVersions.Builder setPageToken​(java.lang.String value)
         Pagination token to go to next page based on previous search query.
        optional string page_token = 4;
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.

      • clearPageToken

        public ModelRegistry.SearchModelVersions.Builder clearPageToken()
         Pagination token to go to next page based on previous search query.
        optional string page_token = 4;
        Returns:
        This builder for chaining.

      • setPageTokenBytes

        public ModelRegistry.SearchModelVersions.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         Pagination token to go to next page based on previous search query.
        optional string page_token = 4;
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.