Package org.mlflow.api.proto

Class ModelRegistry.SearchModelVersions

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • 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

      • 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.

      • 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.

      • 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.

      • 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.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ModelRegistry.SearchModelVersions parseFrom​(java.nio.ByteBuffer data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelRegistry.SearchModelVersions parseFrom​(java.nio.ByteBuffer data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelRegistry.SearchModelVersions parseFrom​(com.google.protobuf.ByteString data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelRegistry.SearchModelVersions parseFrom​(com.google.protobuf.ByteString data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelRegistry.SearchModelVersions parseFrom​(byte[] data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelRegistry.SearchModelVersions parseFrom​(byte[] data,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ModelRegistry.SearchModelVersions parseFrom​(java.io.InputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ModelRegistry.SearchModelVersions parseDelimitedFrom​(java.io.InputStream input)
                                                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

        public static ModelRegistry.SearchModelVersions parseDelimitedFrom​(java.io.InputStream input,
                                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                            throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ModelRegistry.SearchModelVersions parseFrom​(com.google.protobuf.CodedInputStream input)
                                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

        public static ModelRegistry.SearchModelVersions parseFrom​(com.google.protobuf.CodedInputStream input,
                                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws java.io.IOException
        Throws:
        java.io.IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected ModelRegistry.SearchModelVersions.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<ModelRegistry.SearchModelVersions> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

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