Package org.mlflow.api.proto

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

      • clear

        public Service.SearchRuns.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Service.SearchRuns.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.SearchRuns.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public Service.SearchRuns.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Service.SearchRuns.Builder>

      • setField

        public Service.SearchRuns.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.SearchRuns.Builder>

      • clearField

        public Service.SearchRuns.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Service.SearchRuns.Builder>

      • clearOneof

        public Service.SearchRuns.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Service.SearchRuns.Builder>

      • setRepeatedField

        public Service.SearchRuns.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.SearchRuns.Builder>

      • addRepeatedField

        public Service.SearchRuns.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.SearchRuns.Builder>

      • mergeFrom

        public Service.SearchRuns.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Service.SearchRuns.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.SearchRuns.Builder>

      • mergeFrom

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

      • getExperimentIdsList

        public com.google.protobuf.ProtocolStringList getExperimentIdsList()
         List of experiment IDs to search over.
        repeated string experiment_ids = 1;
        Specified by:
        getExperimentIdsList in interface Service.SearchRunsOrBuilder
        Returns:
        A list containing the experimentIds.

      • getExperimentIdsCount

        public int getExperimentIdsCount()
         List of experiment IDs to search over.
        repeated string experiment_ids = 1;
        Specified by:
        getExperimentIdsCount in interface Service.SearchRunsOrBuilder
        Returns:
        The count of experimentIds.

      • getExperimentIds

        public java.lang.String getExperimentIds​(int index)
         List of experiment IDs to search over.
        repeated string experiment_ids = 1;
        Specified by:
        getExperimentIds in interface Service.SearchRunsOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The experimentIds at the given index.

      • getExperimentIdsBytes

        public com.google.protobuf.ByteString getExperimentIdsBytes​(int index)
         List of experiment IDs to search over.
        repeated string experiment_ids = 1;
        Specified by:
        getExperimentIdsBytes in interface Service.SearchRunsOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the experimentIds at the given index.

      • setExperimentIds

        public Service.SearchRuns.Builder setExperimentIds​(int index,
                                                   java.lang.String value)
         List of experiment IDs to search over.
        repeated string experiment_ids = 1;
        Parameters:
        index - The index to set the value at.
        value - The experimentIds to set.
        Returns:
        This builder for chaining.

      • addExperimentIds

        public Service.SearchRuns.Builder addExperimentIds​(java.lang.String value)
         List of experiment IDs to search over.
        repeated string experiment_ids = 1;
        Parameters:
        value - The experimentIds to add.
        Returns:
        This builder for chaining.

      • addAllExperimentIds

        public Service.SearchRuns.Builder addAllExperimentIds​(java.lang.Iterable<java.lang.String> values)
         List of experiment IDs to search over.
        repeated string experiment_ids = 1;
        Parameters:
        values - The experimentIds to add.
        Returns:
        This builder for chaining.

      • clearExperimentIds

        public Service.SearchRuns.Builder clearExperimentIds()
         List of experiment IDs to search over.
        repeated string experiment_ids = 1;
        Returns:
        This builder for chaining.

      • addExperimentIdsBytes

        public Service.SearchRuns.Builder addExperimentIdsBytes​(com.google.protobuf.ByteString value)
         List of experiment IDs to search over.
        repeated string experiment_ids = 1;
        Parameters:
        value - The bytes of the experimentIds to add.
        Returns:
        This builder for chaining.

      • hasFilter

        public boolean hasFilter()
         A filter expression over params, metrics, and tags, that allows returning a subset of
 runs. The syntax is a subset of SQL that supports ANDing together binary operations
 between a param, metric, or tag and a constant.
 Example: ``metrics.rmse < 1 and params.model_class = 'LogisticRegression'``
 You can select columns with special characters (hyphen, space, period, etc.) by using double quotes:
 ``metrics."model class" = 'LinearRegression' and tags."user-name" = 'Tomas'``
 Supported operators are ``=``, ``!=``, ``>``, ``>=``, ``<``, and ``<=``.
        optional string filter = 4;
        Specified by:
        hasFilter in interface Service.SearchRunsOrBuilder
        Returns:
        Whether the filter field is set.

      • getFilter

        public java.lang.String getFilter()
         A filter expression over params, metrics, and tags, that allows returning a subset of
 runs. The syntax is a subset of SQL that supports ANDing together binary operations
 between a param, metric, or tag and a constant.
 Example: ``metrics.rmse < 1 and params.model_class = 'LogisticRegression'``
 You can select columns with special characters (hyphen, space, period, etc.) by using double quotes:
 ``metrics."model class" = 'LinearRegression' and tags."user-name" = 'Tomas'``
 Supported operators are ``=``, ``!=``, ``>``, ``>=``, ``<``, and ``<=``.
        optional string filter = 4;
        Specified by:
        getFilter in interface Service.SearchRunsOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         A filter expression over params, metrics, and tags, that allows returning a subset of
 runs. The syntax is a subset of SQL that supports ANDing together binary operations
 between a param, metric, or tag and a constant.
 Example: ``metrics.rmse < 1 and params.model_class = 'LogisticRegression'``
 You can select columns with special characters (hyphen, space, period, etc.) by using double quotes:
 ``metrics."model class" = 'LinearRegression' and tags."user-name" = 'Tomas'``
 Supported operators are ``=``, ``!=``, ``>``, ``>=``, ``<``, and ``<=``.
        optional string filter = 4;
        Specified by:
        getFilterBytes in interface Service.SearchRunsOrBuilder
        Returns:
        The bytes for filter.

      • setFilter

        public Service.SearchRuns.Builder setFilter​(java.lang.String value)
         A filter expression over params, metrics, and tags, that allows returning a subset of
 runs. The syntax is a subset of SQL that supports ANDing together binary operations
 between a param, metric, or tag and a constant.
 Example: ``metrics.rmse < 1 and params.model_class = 'LogisticRegression'``
 You can select columns with special characters (hyphen, space, period, etc.) by using double quotes:
 ``metrics."model class" = 'LinearRegression' and tags."user-name" = 'Tomas'``
 Supported operators are ``=``, ``!=``, ``>``, ``>=``, ``<``, and ``<=``.
        optional string filter = 4;
        Parameters:
        value - The filter to set.
        Returns:
        This builder for chaining.

      • clearFilter

        public Service.SearchRuns.Builder clearFilter()
         A filter expression over params, metrics, and tags, that allows returning a subset of
 runs. The syntax is a subset of SQL that supports ANDing together binary operations
 between a param, metric, or tag and a constant.
 Example: ``metrics.rmse < 1 and params.model_class = 'LogisticRegression'``
 You can select columns with special characters (hyphen, space, period, etc.) by using double quotes:
 ``metrics."model class" = 'LinearRegression' and tags."user-name" = 'Tomas'``
 Supported operators are ``=``, ``!=``, ``>``, ``>=``, ``<``, and ``<=``.
        optional string filter = 4;
        Returns:
        This builder for chaining.

      • setFilterBytes

        public Service.SearchRuns.Builder setFilterBytes​(com.google.protobuf.ByteString value)
         A filter expression over params, metrics, and tags, that allows returning a subset of
 runs. The syntax is a subset of SQL that supports ANDing together binary operations
 between a param, metric, or tag and a constant.
 Example: ``metrics.rmse < 1 and params.model_class = 'LogisticRegression'``
 You can select columns with special characters (hyphen, space, period, etc.) by using double quotes:
 ``metrics."model class" = 'LinearRegression' and tags."user-name" = 'Tomas'``
 Supported operators are ``=``, ``!=``, ``>``, ``>=``, ``<``, and ``<=``.
        optional string filter = 4;
        Parameters:
        value - The bytes for filter to set.
        Returns:
        This builder for chaining.

      • hasRunViewType

        public boolean hasRunViewType()
         Whether to display only active, only deleted, or all runs.
 Defaults to only active runs.
        optional .mlflow.ViewType run_view_type = 3 [default = ACTIVE_ONLY];
        Specified by:
        hasRunViewType in interface Service.SearchRunsOrBuilder
        Returns:
        Whether the runViewType field is set.

      • getRunViewType

        public Service.ViewType getRunViewType()
         Whether to display only active, only deleted, or all runs.
 Defaults to only active runs.
        optional .mlflow.ViewType run_view_type = 3 [default = ACTIVE_ONLY];
        Specified by:
        getRunViewType in interface Service.SearchRunsOrBuilder
        Returns:
        The runViewType.

      • setRunViewType

        public Service.SearchRuns.Builder setRunViewType​(Service.ViewType value)
         Whether to display only active, only deleted, or all runs.
 Defaults to only active runs.
        optional .mlflow.ViewType run_view_type = 3 [default = ACTIVE_ONLY];
        Parameters:
        value - The runViewType to set.
        Returns:
        This builder for chaining.

      • clearRunViewType

        public Service.SearchRuns.Builder clearRunViewType()
         Whether to display only active, only deleted, or all runs.
 Defaults to only active runs.
        optional .mlflow.ViewType run_view_type = 3 [default = ACTIVE_ONLY];
        Returns:
        This builder for chaining.

      • hasMaxResults

        public boolean hasMaxResults()
         Maximum number of runs desired. If unspecified, defaults to 1000.
 All servers are guaranteed to support a `max_results` threshold of at least 50,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 int32 max_results = 5 [default = 1000];
        Specified by:
        hasMaxResults in interface Service.SearchRunsOrBuilder
        Returns:
        Whether the maxResults field is set.

      • getMaxResults

        public int getMaxResults()
         Maximum number of runs desired. If unspecified, defaults to 1000.
 All servers are guaranteed to support a `max_results` threshold of at least 50,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 int32 max_results = 5 [default = 1000];
        Specified by:
        getMaxResults in interface Service.SearchRunsOrBuilder
        Returns:
        The maxResults.

      • setMaxResults

        public Service.SearchRuns.Builder setMaxResults​(int value)
         Maximum number of runs desired. If unspecified, defaults to 1000.
 All servers are guaranteed to support a `max_results` threshold of at least 50,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 int32 max_results = 5 [default = 1000];
        Parameters:
        value - The maxResults to set.
        Returns:
        This builder for chaining.

      • clearMaxResults

        public Service.SearchRuns.Builder clearMaxResults()
         Maximum number of runs desired. If unspecified, defaults to 1000.
 All servers are guaranteed to support a `max_results` threshold of at least 50,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 int32 max_results = 5 [default = 1000];
        Returns:
        This builder for chaining.

      • getOrderByList

        public com.google.protobuf.ProtocolStringList getOrderByList()
         List of columns to be ordered by, including attributes, params, metrics, and tags with an
 optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Example: ["params.input DESC", "metrics.alpha ASC", "metrics.rmse"]
 Tiebreaks are done by start_time DESC followed by run_id for runs with the same start time
 (and this is the default ordering criterion if order_by is not provided).
        repeated string order_by = 6;
        Specified by:
        getOrderByList in interface Service.SearchRunsOrBuilder
        Returns:
        A list containing the orderBy.

      • getOrderByCount

        public int getOrderByCount()
         List of columns to be ordered by, including attributes, params, metrics, and tags with an
 optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Example: ["params.input DESC", "metrics.alpha ASC", "metrics.rmse"]
 Tiebreaks are done by start_time DESC followed by run_id for runs with the same start time
 (and this is the default ordering criterion if order_by is not provided).
        repeated string order_by = 6;
        Specified by:
        getOrderByCount in interface Service.SearchRunsOrBuilder
        Returns:
        The count of orderBy.

      • getOrderBy

        public java.lang.String getOrderBy​(int index)
         List of columns to be ordered by, including attributes, params, metrics, and tags with an
 optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Example: ["params.input DESC", "metrics.alpha ASC", "metrics.rmse"]
 Tiebreaks are done by start_time DESC followed by run_id for runs with the same start time
 (and this is the default ordering criterion if order_by is not provided).
        repeated string order_by = 6;
        Specified by:
        getOrderBy in interface Service.SearchRunsOrBuilder
        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 attributes, params, metrics, and tags with an
 optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Example: ["params.input DESC", "metrics.alpha ASC", "metrics.rmse"]
 Tiebreaks are done by start_time DESC followed by run_id for runs with the same start time
 (and this is the default ordering criterion if order_by is not provided).
        repeated string order_by = 6;
        Specified by:
        getOrderByBytes in interface Service.SearchRunsOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the orderBy at the given index.

      • setOrderBy

        public Service.SearchRuns.Builder setOrderBy​(int index,
                                             java.lang.String value)
         List of columns to be ordered by, including attributes, params, metrics, and tags with an
 optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Example: ["params.input DESC", "metrics.alpha ASC", "metrics.rmse"]
 Tiebreaks are done by start_time DESC followed by run_id for runs with the same start time
 (and this is the default ordering criterion if order_by is not provided).
        repeated string order_by = 6;
        Parameters:
        index - The index to set the value at.
        value - The orderBy to set.
        Returns:
        This builder for chaining.

      • addOrderBy

        public Service.SearchRuns.Builder addOrderBy​(java.lang.String value)
         List of columns to be ordered by, including attributes, params, metrics, and tags with an
 optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Example: ["params.input DESC", "metrics.alpha ASC", "metrics.rmse"]
 Tiebreaks are done by start_time DESC followed by run_id for runs with the same start time
 (and this is the default ordering criterion if order_by is not provided).
        repeated string order_by = 6;
        Parameters:
        value - The orderBy to add.
        Returns:
        This builder for chaining.

      • addAllOrderBy

        public Service.SearchRuns.Builder addAllOrderBy​(java.lang.Iterable<java.lang.String> values)
         List of columns to be ordered by, including attributes, params, metrics, and tags with an
 optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Example: ["params.input DESC", "metrics.alpha ASC", "metrics.rmse"]
 Tiebreaks are done by start_time DESC followed by run_id for runs with the same start time
 (and this is the default ordering criterion if order_by is not provided).
        repeated string order_by = 6;
        Parameters:
        values - The orderBy to add.
        Returns:
        This builder for chaining.

      • clearOrderBy

        public Service.SearchRuns.Builder clearOrderBy()
         List of columns to be ordered by, including attributes, params, metrics, and tags with an
 optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Example: ["params.input DESC", "metrics.alpha ASC", "metrics.rmse"]
 Tiebreaks are done by start_time DESC followed by run_id for runs with the same start time
 (and this is the default ordering criterion if order_by is not provided).
        repeated string order_by = 6;
        Returns:
        This builder for chaining.

      • addOrderByBytes

        public Service.SearchRuns.Builder addOrderByBytes​(com.google.protobuf.ByteString value)
         List of columns to be ordered by, including attributes, params, metrics, and tags with an
 optional "DESC" or "ASC" annotation, where "ASC" is the default.
 Example: ["params.input DESC", "metrics.alpha ASC", "metrics.rmse"]
 Tiebreaks are done by start_time DESC followed by run_id for runs with the same start time
 (and this is the default ordering criterion if order_by is not provided).
        repeated string order_by = 6;
        Parameters:
        value - The bytes of the orderBy to add.
        Returns:
        This builder for chaining.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
        optional string page_token = 7;
        Specified by:
        getPageTokenBytes in interface Service.SearchRunsOrBuilder
        Returns:
        The bytes for pageToken.

      • setPageToken

        public Service.SearchRuns.Builder setPageToken​(java.lang.String value)
        optional string page_token = 7;
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.

      • clearPageToken

        public Service.SearchRuns.Builder clearPageToken()
        optional string page_token = 7;
        Returns:
        This builder for chaining.

      • setPageTokenBytes

        public Service.SearchRuns.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
        optional string page_token = 7;
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final Service.SearchRuns.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.SearchRuns.Builder>

      • mergeUnknownFields

        public final Service.SearchRuns.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.SearchRuns.Builder>