Package org.mlflow.api.proto

Class Service.SearchExperiments.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<Service.SearchExperiments.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<Service.SearchExperiments.Builder>

      • getDefaultInstanceForType

        public Service.SearchExperiments getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • setField

        public Service.SearchExperiments.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  java.lang.Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.SearchExperiments.Builder>

      • setRepeatedField

        public Service.SearchExperiments.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                          int index,
                                                          java.lang.Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.SearchExperiments.Builder>

      • addRepeatedField

        public Service.SearchExperiments.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                          java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.SearchExperiments.Builder>

      • isInitialized

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

      • mergeFrom

        public Service.SearchExperiments.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<Service.SearchExperiments.Builder>
        Throws:
        java.io.IOException

      • hasMaxResults

        public 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;
        Specified by:
        hasMaxResults in interface Service.SearchExperimentsOrBuilder
        Returns:
        Whether the maxResults field is set.

      • getMaxResults

        public 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;
        Specified by:
        getMaxResults in interface Service.SearchExperimentsOrBuilder
        Returns:
        The maxResults.

      • setMaxResults

        public Service.SearchExperiments.Builder setMaxResults​(long value)
         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;
        Parameters:
        value - The maxResults to set.
        Returns:
        This builder for chaining.

      • clearMaxResults

        public Service.SearchExperiments.Builder clearMaxResults()
         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:
        This builder for chaining.

      • hasPageToken

        public boolean hasPageToken()
         Token indicating the page of experiments to fetch
        optional string page_token = 2;
        Specified by:
        hasPageToken in interface Service.SearchExperimentsOrBuilder
        Returns:
        Whether the pageToken field is set.

      • getPageToken

        public java.lang.String getPageToken()
         Token indicating the page of experiments to fetch
        optional string page_token = 2;
        Specified by:
        getPageToken in interface Service.SearchExperimentsOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

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

      • setPageToken

        public Service.SearchExperiments.Builder setPageToken​(java.lang.String value)
         Token indicating the page of experiments to fetch
        optional string page_token = 2;
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.

      • clearPageToken

        public Service.SearchExperiments.Builder clearPageToken()
         Token indicating the page of experiments to fetch
        optional string page_token = 2;
        Returns:
        This builder for chaining.

      • setPageTokenBytes

        public Service.SearchExperiments.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         Token indicating the page of experiments to fetch
        optional string page_token = 2;
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.

      • hasFilter

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

      • getFilter

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

      • getFilterBytes

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

      • setFilter

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

      • clearFilter

        public Service.SearchExperiments.Builder clearFilter()
         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:
        This builder for chaining.

      • setFilterBytes

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

      • getOrderByList

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

      • getOrderByCount

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

      • getOrderBy

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

      • setOrderBy

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

      • addOrderBy

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

      • addAllOrderBy

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

      • clearOrderBy

        public Service.SearchExperiments.Builder clearOrderBy()
         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:
        This builder for chaining.

      • addOrderByBytes

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

      • hasViewType

        public boolean hasViewType()
         Qualifier for type of experiments to be returned.
 If unspecified, return only active experiments.
        optional .mlflow.ViewType view_type = 5;
        Specified by:
        hasViewType in interface Service.SearchExperimentsOrBuilder
        Returns:
        Whether the viewType field is set.

      • setViewType

        public Service.SearchExperiments.Builder setViewType​(Service.ViewType value)
         Qualifier for type of experiments to be returned.
 If unspecified, return only active experiments.
        optional .mlflow.ViewType view_type = 5;
        Parameters:
        value - The viewType to set.
        Returns:
        This builder for chaining.

      • clearViewType

        public Service.SearchExperiments.Builder clearViewType()
         Qualifier for type of experiments to be returned.
 If unspecified, return only active experiments.
        optional .mlflow.ViewType view_type = 5;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final Service.SearchExperiments.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Service.SearchExperiments.Builder>

      • mergeUnknownFields

        public final Service.SearchExperiments.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Service.SearchExperiments.Builder>