Package org.mlflow.api.proto

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • setRepeatedField

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

      • addRepeatedField

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

      • mergeFrom

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

      • getModelIdBytes

        public com.google.protobuf.ByteString getModelIdBytes()
        optional string model_id = 1 [(.mlflow.validate_required) = true];
        Specified by:
        getModelIdBytes in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        The bytes for modelId.

      • setModelId

        public Service.SearchUnifiedTraces.Builder setModelId​(java.lang.String value)
        optional string model_id = 1 [(.mlflow.validate_required) = true];
        Parameters:
        value - The modelId to set.
        Returns:
        This builder for chaining.

      • clearModelId

        public Service.SearchUnifiedTraces.Builder clearModelId()
        optional string model_id = 1 [(.mlflow.validate_required) = true];
        Returns:
        This builder for chaining.

      • setModelIdBytes

        public Service.SearchUnifiedTraces.Builder setModelIdBytes​(com.google.protobuf.ByteString value)
        optional string model_id = 1 [(.mlflow.validate_required) = true];
        Parameters:
        value - The bytes for modelId to set.
        Returns:
        This builder for chaining.

      • hasSqlWarehouseId

        public boolean hasSqlWarehouseId()
        optional string sql_warehouse_id = 2 [(.mlflow.validate_required) = true];
        Specified by:
        hasSqlWarehouseId in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        Whether the sqlWarehouseId field is set.

      • getSqlWarehouseIdBytes

        public com.google.protobuf.ByteString getSqlWarehouseIdBytes()
        optional string sql_warehouse_id = 2 [(.mlflow.validate_required) = true];
        Specified by:
        getSqlWarehouseIdBytes in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        The bytes for sqlWarehouseId.

      • setSqlWarehouseId

        public Service.SearchUnifiedTraces.Builder setSqlWarehouseId​(java.lang.String value)
        optional string sql_warehouse_id = 2 [(.mlflow.validate_required) = true];
        Parameters:
        value - The sqlWarehouseId to set.
        Returns:
        This builder for chaining.

      • clearSqlWarehouseId

        public Service.SearchUnifiedTraces.Builder clearSqlWarehouseId()
        optional string sql_warehouse_id = 2 [(.mlflow.validate_required) = true];
        Returns:
        This builder for chaining.

      • setSqlWarehouseIdBytes

        public Service.SearchUnifiedTraces.Builder setSqlWarehouseIdBytes​(com.google.protobuf.ByteString value)
        optional string sql_warehouse_id = 2 [(.mlflow.validate_required) = true];
        Parameters:
        value - The bytes for sqlWarehouseId to set.
        Returns:
        This builder for chaining.

      • getExperimentIdsList

        public com.google.protobuf.ProtocolStringList getExperimentIdsList()
         TODO: Eventually we want to provide an API that only uses model_id
        repeated string experiment_ids = 3;
        Specified by:
        getExperimentIdsList in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        A list containing the experimentIds.

      • getExperimentIdsCount

        public int getExperimentIdsCount()
         TODO: Eventually we want to provide an API that only uses model_id
        repeated string experiment_ids = 3;
        Specified by:
        getExperimentIdsCount in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        The count of experimentIds.

      • getExperimentIds

        public java.lang.String getExperimentIds​(int index)
         TODO: Eventually we want to provide an API that only uses model_id
        repeated string experiment_ids = 3;
        Specified by:
        getExperimentIds in interface Service.SearchUnifiedTracesOrBuilder
        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)
         TODO: Eventually we want to provide an API that only uses model_id
        repeated string experiment_ids = 3;
        Specified by:
        getExperimentIdsBytes in interface Service.SearchUnifiedTracesOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the experimentIds at the given index.

      • setExperimentIds

        public Service.SearchUnifiedTraces.Builder setExperimentIds​(int index,
                                                            java.lang.String value)
         TODO: Eventually we want to provide an API that only uses model_id
        repeated string experiment_ids = 3;
        Parameters:
        index - The index to set the value at.
        value - The experimentIds to set.
        Returns:
        This builder for chaining.

      • addExperimentIds

        public Service.SearchUnifiedTraces.Builder addExperimentIds​(java.lang.String value)
         TODO: Eventually we want to provide an API that only uses model_id
        repeated string experiment_ids = 3;
        Parameters:
        value - The experimentIds to add.
        Returns:
        This builder for chaining.

      • addAllExperimentIds

        public Service.SearchUnifiedTraces.Builder addAllExperimentIds​(java.lang.Iterable<java.lang.String> values)
         TODO: Eventually we want to provide an API that only uses model_id
        repeated string experiment_ids = 3;
        Parameters:
        values - The experimentIds to add.
        Returns:
        This builder for chaining.

      • clearExperimentIds

        public Service.SearchUnifiedTraces.Builder clearExperimentIds()
         TODO: Eventually we want to provide an API that only uses model_id
        repeated string experiment_ids = 3;
        Returns:
        This builder for chaining.

      • addExperimentIdsBytes

        public Service.SearchUnifiedTraces.Builder addExperimentIdsBytes​(com.google.protobuf.ByteString value)
         TODO: Eventually we want to provide an API that only uses model_id
        repeated string experiment_ids = 3;
        Parameters:
        value - The bytes of the experimentIds to add.
        Returns:
        This builder for chaining.

      • hasFilter

        public boolean hasFilter()
         A filter expression over trace attributes and tags that allows returning a subset of
 traces. The syntax is a subset of SQL that supports ANDing together binary operations
 Example: ``trace.status = 'OK' and trace.timestamp_ms > 1711089570679``.
        optional string filter = 4;
        Specified by:
        hasFilter in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        Whether the filter field is set.

      • getFilter

        public java.lang.String getFilter()
         A filter expression over trace attributes and tags that allows returning a subset of
 traces. The syntax is a subset of SQL that supports ANDing together binary operations
 Example: ``trace.status = 'OK' and trace.timestamp_ms > 1711089570679``.
        optional string filter = 4;
        Specified by:
        getFilter in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        The filter.

      • getFilterBytes

        public com.google.protobuf.ByteString getFilterBytes()
         A filter expression over trace attributes and tags that allows returning a subset of
 traces. The syntax is a subset of SQL that supports ANDing together binary operations
 Example: ``trace.status = 'OK' and trace.timestamp_ms > 1711089570679``.
        optional string filter = 4;
        Specified by:
        getFilterBytes in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        The bytes for filter.

      • setFilter

        public Service.SearchUnifiedTraces.Builder setFilter​(java.lang.String value)
         A filter expression over trace attributes and tags that allows returning a subset of
 traces. The syntax is a subset of SQL that supports ANDing together binary operations
 Example: ``trace.status = 'OK' and trace.timestamp_ms > 1711089570679``.
        optional string filter = 4;
        Parameters:
        value - The filter to set.
        Returns:
        This builder for chaining.

      • clearFilter

        public Service.SearchUnifiedTraces.Builder clearFilter()
         A filter expression over trace attributes and tags that allows returning a subset of
 traces. The syntax is a subset of SQL that supports ANDing together binary operations
 Example: ``trace.status = 'OK' and trace.timestamp_ms > 1711089570679``.
        optional string filter = 4;
        Returns:
        This builder for chaining.

      • setFilterBytes

        public Service.SearchUnifiedTraces.Builder setFilterBytes​(com.google.protobuf.ByteString value)
         A filter expression over trace attributes and tags that allows returning a subset of
 traces. The syntax is a subset of SQL that supports ANDing together binary operations
 Example: ``trace.status = 'OK' and trace.timestamp_ms > 1711089570679``.
        optional string filter = 4;
        Parameters:
        value - The bytes for filter to set.
        Returns:
        This builder for chaining.

      • hasMaxResults

        public boolean hasMaxResults()
         Maximum number of traces desired. Max threshold is 500.
        optional int32 max_results = 5 [default = 100];
        Specified by:
        hasMaxResults in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        Whether the maxResults field is set.

      • getMaxResults

        public int getMaxResults()
         Maximum number of traces desired. Max threshold is 500.
        optional int32 max_results = 5 [default = 100];
        Specified by:
        getMaxResults in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        The maxResults.

      • setMaxResults

        public Service.SearchUnifiedTraces.Builder setMaxResults​(int value)
         Maximum number of traces desired. Max threshold is 500.
        optional int32 max_results = 5 [default = 100];
        Parameters:
        value - The maxResults to set.
        Returns:
        This builder for chaining.

      • clearMaxResults

        public Service.SearchUnifiedTraces.Builder clearMaxResults()
         Maximum number of traces desired. Max threshold is 500.
        optional int32 max_results = 5 [default = 100];
        Returns:
        This builder for chaining.

      • getOrderByList

        public com.google.protobuf.ProtocolStringList getOrderByList()
         List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
        repeated string order_by = 6;
        Specified by:
        getOrderByList in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        A list containing the orderBy.

      • getOrderByCount

        public int getOrderByCount()
         List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
        repeated string order_by = 6;
        Specified by:
        getOrderByCount in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        The count of orderBy.

      • getOrderBy

        public java.lang.String getOrderBy​(int index)
         List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
        repeated string order_by = 6;
        Specified by:
        getOrderBy in interface Service.SearchUnifiedTracesOrBuilder
        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 the results, e.g. ``["timestamp_ms DESC"]``.
        repeated string order_by = 6;
        Specified by:
        getOrderByBytes in interface Service.SearchUnifiedTracesOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the orderBy at the given index.

      • setOrderBy

        public Service.SearchUnifiedTraces.Builder setOrderBy​(int index,
                                                      java.lang.String value)
         List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
        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.SearchUnifiedTraces.Builder addOrderBy​(java.lang.String value)
         List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
        repeated string order_by = 6;
        Parameters:
        value - The orderBy to add.
        Returns:
        This builder for chaining.

      • addAllOrderBy

        public Service.SearchUnifiedTraces.Builder addAllOrderBy​(java.lang.Iterable<java.lang.String> values)
         List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
        repeated string order_by = 6;
        Parameters:
        values - The orderBy to add.
        Returns:
        This builder for chaining.

      • clearOrderBy

        public Service.SearchUnifiedTraces.Builder clearOrderBy()
         List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
        repeated string order_by = 6;
        Returns:
        This builder for chaining.

      • addOrderByBytes

        public Service.SearchUnifiedTraces.Builder addOrderByBytes​(com.google.protobuf.ByteString value)
         List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
        repeated string order_by = 6;
        Parameters:
        value - The bytes of the orderBy to add.
        Returns:
        This builder for chaining.

      • hasPageToken

        public boolean hasPageToken()
         Token indicating the page of traces to fetch. This is a unified token that encodes both online and offline traces
 tokens.
        optional string page_token = 7;
        Specified by:
        hasPageToken in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        Whether the pageToken field is set.

      • getPageToken

        public java.lang.String getPageToken()
         Token indicating the page of traces to fetch. This is a unified token that encodes both online and offline traces
 tokens.
        optional string page_token = 7;
        Specified by:
        getPageToken in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         Token indicating the page of traces to fetch. This is a unified token that encodes both online and offline traces
 tokens.
        optional string page_token = 7;
        Specified by:
        getPageTokenBytes in interface Service.SearchUnifiedTracesOrBuilder
        Returns:
        The bytes for pageToken.

      • setPageToken

        public Service.SearchUnifiedTraces.Builder setPageToken​(java.lang.String value)
         Token indicating the page of traces to fetch. This is a unified token that encodes both online and offline traces
 tokens.
        optional string page_token = 7;
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.

      • clearPageToken

        public Service.SearchUnifiedTraces.Builder clearPageToken()
         Token indicating the page of traces to fetch. This is a unified token that encodes both online and offline traces
 tokens.
        optional string page_token = 7;
        Returns:
        This builder for chaining.

      • setPageTokenBytes

        public Service.SearchUnifiedTraces.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         Token indicating the page of traces to fetch. This is a unified token that encodes both online and offline traces
 tokens.
        optional string page_token = 7;
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.

      • mergeUnknownFields

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