Package org.mlflow.api.proto

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

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • setField

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

      • setRepeatedField

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

      • addRepeatedField

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

      • mergeFrom

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

      • getExperimentIdsList

        public com.google.protobuf.ProtocolStringList getExperimentIdsList()
         Required: The experiment IDs to search traces.
        repeated string experiment_ids = 1;
        Specified by:
        getExperimentIdsList in interface Service.QueryTraceMetricsOrBuilder
        Returns:
        A list containing the experimentIds.

      • getExperimentIds

        public java.lang.String getExperimentIds​(int index)
         Required: The experiment IDs to search traces.
        repeated string experiment_ids = 1;
        Specified by:
        getExperimentIds in interface Service.QueryTraceMetricsOrBuilder
        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)
         Required: The experiment IDs to search traces.
        repeated string experiment_ids = 1;
        Specified by:
        getExperimentIdsBytes in interface Service.QueryTraceMetricsOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the experimentIds at the given index.

      • setExperimentIds

        public Service.QueryTraceMetrics.Builder setExperimentIds​(int index,
                                                          java.lang.String value)
         Required: The experiment IDs to search traces.
        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.QueryTraceMetrics.Builder addExperimentIds​(java.lang.String value)
         Required: The experiment IDs to search traces.
        repeated string experiment_ids = 1;
        Parameters:
        value - The experimentIds to add.
        Returns:
        This builder for chaining.

      • addAllExperimentIds

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

      • clearExperimentIds

        public Service.QueryTraceMetrics.Builder clearExperimentIds()
         Required: The experiment IDs to search traces.
        repeated string experiment_ids = 1;
        Returns:
        This builder for chaining.

      • addExperimentIdsBytes

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

      • hasViewType

        public boolean hasViewType()
         Required: The level at which to aggregate metrics.
        optional .mlflow.MetricViewType view_type = 2;
        Specified by:
        hasViewType in interface Service.QueryTraceMetricsOrBuilder
        Returns:
        Whether the viewType field is set.

      • setViewType

        public Service.QueryTraceMetrics.Builder setViewType​(Service.MetricViewType value)
         Required: The level at which to aggregate metrics.
        optional .mlflow.MetricViewType view_type = 2;
        Parameters:
        value - The viewType to set.
        Returns:
        This builder for chaining.

      • clearViewType

        public Service.QueryTraceMetrics.Builder clearViewType()
         Required: The level at which to aggregate metrics.
        optional .mlflow.MetricViewType view_type = 2;
        Returns:
        This builder for chaining.

      • hasMetricName

        public boolean hasMetricName()
         Required: The name of the metric to query (e.g. "latency").
        optional string metric_name = 3;
        Specified by:
        hasMetricName in interface Service.QueryTraceMetricsOrBuilder
        Returns:
        Whether the metricName field is set.

      • getMetricName

        public java.lang.String getMetricName()
         Required: The name of the metric to query (e.g. "latency").
        optional string metric_name = 3;
        Specified by:
        getMetricName in interface Service.QueryTraceMetricsOrBuilder
        Returns:
        The metricName.

      • getMetricNameBytes

        public com.google.protobuf.ByteString getMetricNameBytes()
         Required: The name of the metric to query (e.g. "latency").
        optional string metric_name = 3;
        Specified by:
        getMetricNameBytes in interface Service.QueryTraceMetricsOrBuilder
        Returns:
        The bytes for metricName.

      • setMetricName

        public Service.QueryTraceMetrics.Builder setMetricName​(java.lang.String value)
         Required: The name of the metric to query (e.g. "latency").
        optional string metric_name = 3;
        Parameters:
        value - The metricName to set.
        Returns:
        This builder for chaining.

      • clearMetricName

        public Service.QueryTraceMetrics.Builder clearMetricName()
         Required: The name of the metric to query (e.g. "latency").
        optional string metric_name = 3;
        Returns:
        This builder for chaining.

      • setMetricNameBytes

        public Service.QueryTraceMetrics.Builder setMetricNameBytes​(com.google.protobuf.ByteString value)
         Required: The name of the metric to query (e.g. "latency").
        optional string metric_name = 3;
        Parameters:
        value - The bytes for metricName to set.
        Returns:
        This builder for chaining.

      • clearAggregations

        public Service.QueryTraceMetrics.Builder clearAggregations()
         Required: The aggregations to apply.
        repeated .mlflow.MetricAggregation aggregations = 4;

      • removeAggregations

        public Service.QueryTraceMetrics.Builder removeAggregations​(int index)
         Required: The aggregations to apply.
        repeated .mlflow.MetricAggregation aggregations = 4;

      • getAggregationsBuilder

        public Service.MetricAggregation.Builder getAggregationsBuilder​(int index)
         Required: The aggregations to apply.
        repeated .mlflow.MetricAggregation aggregations = 4;

      • addAggregationsBuilder

        public Service.MetricAggregation.Builder addAggregationsBuilder()
         Required: The aggregations to apply.
        repeated .mlflow.MetricAggregation aggregations = 4;

      • addAggregationsBuilder

        public Service.MetricAggregation.Builder addAggregationsBuilder​(int index)
         Required: The aggregations to apply.
        repeated .mlflow.MetricAggregation aggregations = 4;

      • getAggregationsBuilderList

        public java.util.List<Service.MetricAggregation.Builder> getAggregationsBuilderList()
         Required: The aggregations to apply.
        repeated .mlflow.MetricAggregation aggregations = 4;

      • getDimensionsList

        public com.google.protobuf.ProtocolStringList getDimensionsList()
         Optional: Dimensions to group metrics by. (e.g. "name", "status")
        repeated string dimensions = 5;
        Specified by:
        getDimensionsList in interface Service.QueryTraceMetricsOrBuilder
        Returns:
        A list containing the dimensions.

      • getDimensionsCount

        public int getDimensionsCount()
         Optional: Dimensions to group metrics by. (e.g. "name", "status")
        repeated string dimensions = 5;
        Specified by:
        getDimensionsCount in interface Service.QueryTraceMetricsOrBuilder
        Returns:
        The count of dimensions.

      • getDimensions

        public java.lang.String getDimensions​(int index)
         Optional: Dimensions to group metrics by. (e.g. "name", "status")
        repeated string dimensions = 5;
        Specified by:
        getDimensions in interface Service.QueryTraceMetricsOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The dimensions at the given index.

      • getDimensionsBytes

        public com.google.protobuf.ByteString getDimensionsBytes​(int index)
         Optional: Dimensions to group metrics by. (e.g. "name", "status")
        repeated string dimensions = 5;
        Specified by:
        getDimensionsBytes in interface Service.QueryTraceMetricsOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the dimensions at the given index.

      • setDimensions

        public Service.QueryTraceMetrics.Builder setDimensions​(int index,
                                                       java.lang.String value)
         Optional: Dimensions to group metrics by. (e.g. "name", "status")
        repeated string dimensions = 5;
        Parameters:
        index - The index to set the value at.
        value - The dimensions to set.
        Returns:
        This builder for chaining.

      • addDimensions

        public Service.QueryTraceMetrics.Builder addDimensions​(java.lang.String value)
         Optional: Dimensions to group metrics by. (e.g. "name", "status")
        repeated string dimensions = 5;
        Parameters:
        value - The dimensions to add.
        Returns:
        This builder for chaining.

      • addAllDimensions

        public Service.QueryTraceMetrics.Builder addAllDimensions​(java.lang.Iterable<java.lang.String> values)
         Optional: Dimensions to group metrics by. (e.g. "name", "status")
        repeated string dimensions = 5;
        Parameters:
        values - The dimensions to add.
        Returns:
        This builder for chaining.

      • clearDimensions

        public Service.QueryTraceMetrics.Builder clearDimensions()
         Optional: Dimensions to group metrics by. (e.g. "name", "status")
        repeated string dimensions = 5;
        Returns:
        This builder for chaining.

      • addDimensionsBytes

        public Service.QueryTraceMetrics.Builder addDimensionsBytes​(com.google.protobuf.ByteString value)
         Optional: Dimensions to group metrics by. (e.g. "name", "status")
        repeated string dimensions = 5;
        Parameters:
        value - The bytes of the dimensions to add.
        Returns:
        This builder for chaining.

      • getFiltersList

        public com.google.protobuf.ProtocolStringList getFiltersList()
         Optional: Filter expressions to apply. (e.g. `trace.status="OK"`)
        repeated string filters = 6;
        Specified by:
        getFiltersList in interface Service.QueryTraceMetricsOrBuilder
        Returns:
        A list containing the filters.

      • getFiltersCount

        public int getFiltersCount()
         Optional: Filter expressions to apply. (e.g. `trace.status="OK"`)
        repeated string filters = 6;
        Specified by:
        getFiltersCount in interface Service.QueryTraceMetricsOrBuilder
        Returns:
        The count of filters.

      • getFilters

        public java.lang.String getFilters​(int index)
         Optional: Filter expressions to apply. (e.g. `trace.status="OK"`)
        repeated string filters = 6;
        Specified by:
        getFilters in interface Service.QueryTraceMetricsOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The filters at the given index.

      • getFiltersBytes

        public com.google.protobuf.ByteString getFiltersBytes​(int index)
         Optional: Filter expressions to apply. (e.g. `trace.status="OK"`)
        repeated string filters = 6;
        Specified by:
        getFiltersBytes in interface Service.QueryTraceMetricsOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the filters at the given index.

      • setFilters

        public Service.QueryTraceMetrics.Builder setFilters​(int index,
                                                    java.lang.String value)
         Optional: Filter expressions to apply. (e.g. `trace.status="OK"`)
        repeated string filters = 6;
        Parameters:
        index - The index to set the value at.
        value - The filters to set.
        Returns:
        This builder for chaining.

      • addFilters

        public Service.QueryTraceMetrics.Builder addFilters​(java.lang.String value)
         Optional: Filter expressions to apply. (e.g. `trace.status="OK"`)
        repeated string filters = 6;
        Parameters:
        value - The filters to add.
        Returns:
        This builder for chaining.

      • addAllFilters

        public Service.QueryTraceMetrics.Builder addAllFilters​(java.lang.Iterable<java.lang.String> values)
         Optional: Filter expressions to apply. (e.g. `trace.status="OK"`)
        repeated string filters = 6;
        Parameters:
        values - The filters to add.
        Returns:
        This builder for chaining.

      • clearFilters

        public Service.QueryTraceMetrics.Builder clearFilters()
         Optional: Filter expressions to apply. (e.g. `trace.status="OK"`)
        repeated string filters = 6;
        Returns:
        This builder for chaining.

      • addFiltersBytes

        public Service.QueryTraceMetrics.Builder addFiltersBytes​(com.google.protobuf.ByteString value)
         Optional: Filter expressions to apply. (e.g. `trace.status="OK"`)
        repeated string filters = 6;
        Parameters:
        value - The bytes of the filters to add.
        Returns:
        This builder for chaining.

      • hasTimeIntervalSeconds

        public boolean hasTimeIntervalSeconds()
         Optional: Time interval for grouping in seconds.
 When set, results automatically include a time dimension grouped by
 the specified interval.
 Examples: 60 (minute), 3600 (hour), 86400 (day), 604800 (week), 2592000 (month).
        optional int64 time_interval_seconds = 7;
        Specified by:
        hasTimeIntervalSeconds in interface Service.QueryTraceMetricsOrBuilder
        Returns:
        Whether the timeIntervalSeconds field is set.

      • getTimeIntervalSeconds

        public long getTimeIntervalSeconds()
         Optional: Time interval for grouping in seconds.
 When set, results automatically include a time dimension grouped by
 the specified interval.
 Examples: 60 (minute), 3600 (hour), 86400 (day), 604800 (week), 2592000 (month).
        optional int64 time_interval_seconds = 7;
        Specified by:
        getTimeIntervalSeconds in interface Service.QueryTraceMetricsOrBuilder
        Returns:
        The timeIntervalSeconds.

      • setTimeIntervalSeconds

        public Service.QueryTraceMetrics.Builder setTimeIntervalSeconds​(long value)
         Optional: Time interval for grouping in seconds.
 When set, results automatically include a time dimension grouped by
 the specified interval.
 Examples: 60 (minute), 3600 (hour), 86400 (day), 604800 (week), 2592000 (month).
        optional int64 time_interval_seconds = 7;
        Parameters:
        value - The timeIntervalSeconds to set.
        Returns:
        This builder for chaining.

      • clearTimeIntervalSeconds

        public Service.QueryTraceMetrics.Builder clearTimeIntervalSeconds()
         Optional: Time interval for grouping in seconds.
 When set, results automatically include a time dimension grouped by
 the specified interval.
 Examples: 60 (minute), 3600 (hour), 86400 (day), 604800 (week), 2592000 (month).
        optional int64 time_interval_seconds = 7;
        Returns:
        This builder for chaining.

      • hasStartTimeMs

        public boolean hasStartTimeMs()
         Optional: Start of time range in milliseconds since epoch.
 Required if time_interval_seconds is set.
        optional int64 start_time_ms = 8;
        Specified by:
        hasStartTimeMs in interface Service.QueryTraceMetricsOrBuilder
        Returns:
        Whether the startTimeMs field is set.

      • getStartTimeMs

        public long getStartTimeMs()
         Optional: Start of time range in milliseconds since epoch.
 Required if time_interval_seconds is set.
        optional int64 start_time_ms = 8;
        Specified by:
        getStartTimeMs in interface Service.QueryTraceMetricsOrBuilder
        Returns:
        The startTimeMs.

      • setStartTimeMs

        public Service.QueryTraceMetrics.Builder setStartTimeMs​(long value)
         Optional: Start of time range in milliseconds since epoch.
 Required if time_interval_seconds is set.
        optional int64 start_time_ms = 8;
        Parameters:
        value - The startTimeMs to set.
        Returns:
        This builder for chaining.

      • clearStartTimeMs

        public Service.QueryTraceMetrics.Builder clearStartTimeMs()
         Optional: Start of time range in milliseconds since epoch.
 Required if time_interval_seconds is set.
        optional int64 start_time_ms = 8;
        Returns:
        This builder for chaining.

      • hasEndTimeMs

        public boolean hasEndTimeMs()
         Optional: End of time range in milliseconds since epoch.
 Required if time_interval_seconds is set.
        optional int64 end_time_ms = 9;
        Specified by:
        hasEndTimeMs in interface Service.QueryTraceMetricsOrBuilder
        Returns:
        Whether the endTimeMs field is set.

      • getEndTimeMs

        public long getEndTimeMs()
         Optional: End of time range in milliseconds since epoch.
 Required if time_interval_seconds is set.
        optional int64 end_time_ms = 9;
        Specified by:
        getEndTimeMs in interface Service.QueryTraceMetricsOrBuilder
        Returns:
        The endTimeMs.

      • setEndTimeMs

        public Service.QueryTraceMetrics.Builder setEndTimeMs​(long value)
         Optional: End of time range in milliseconds since epoch.
 Required if time_interval_seconds is set.
        optional int64 end_time_ms = 9;
        Parameters:
        value - The endTimeMs to set.
        Returns:
        This builder for chaining.

      • clearEndTimeMs

        public Service.QueryTraceMetrics.Builder clearEndTimeMs()
         Optional: End of time range in milliseconds since epoch.
 Required if time_interval_seconds is set.
        optional int64 end_time_ms = 9;
        Returns:
        This builder for chaining.

      • hasMaxResults

        public boolean hasMaxResults()
         Optional: Maximum number of data points to return.
 Default: 1000
        optional int32 max_results = 10 [default = 1000];
        Specified by:
        hasMaxResults in interface Service.QueryTraceMetricsOrBuilder
        Returns:
        Whether the maxResults field is set.

      • getMaxResults

        public int getMaxResults()
         Optional: Maximum number of data points to return.
 Default: 1000
        optional int32 max_results = 10 [default = 1000];
        Specified by:
        getMaxResults in interface Service.QueryTraceMetricsOrBuilder
        Returns:
        The maxResults.

      • setMaxResults

        public Service.QueryTraceMetrics.Builder setMaxResults​(int value)
         Optional: Maximum number of data points to return.
 Default: 1000
        optional int32 max_results = 10 [default = 1000];
        Parameters:
        value - The maxResults to set.
        Returns:
        This builder for chaining.

      • clearMaxResults

        public Service.QueryTraceMetrics.Builder clearMaxResults()
         Optional: Maximum number of data points to return.
 Default: 1000
        optional int32 max_results = 10 [default = 1000];
        Returns:
        This builder for chaining.

      • hasPageToken

        public boolean hasPageToken()
         Optional: Pagination token for fetching the next page of results.
        optional string page_token = 11;
        Specified by:
        hasPageToken in interface Service.QueryTraceMetricsOrBuilder
        Returns:
        Whether the pageToken field is set.

      • getPageToken

        public java.lang.String getPageToken()
         Optional: Pagination token for fetching the next page of results.
        optional string page_token = 11;
        Specified by:
        getPageToken in interface Service.QueryTraceMetricsOrBuilder
        Returns:
        The pageToken.

      • getPageTokenBytes

        public com.google.protobuf.ByteString getPageTokenBytes()
         Optional: Pagination token for fetching the next page of results.
        optional string page_token = 11;
        Specified by:
        getPageTokenBytes in interface Service.QueryTraceMetricsOrBuilder
        Returns:
        The bytes for pageToken.

      • setPageToken

        public Service.QueryTraceMetrics.Builder setPageToken​(java.lang.String value)
         Optional: Pagination token for fetching the next page of results.
        optional string page_token = 11;
        Parameters:
        value - The pageToken to set.
        Returns:
        This builder for chaining.

      • clearPageToken

        public Service.QueryTraceMetrics.Builder clearPageToken()
         Optional: Pagination token for fetching the next page of results.
        optional string page_token = 11;
        Returns:
        This builder for chaining.

      • setPageTokenBytes

        public Service.QueryTraceMetrics.Builder setPageTokenBytes​(com.google.protobuf.ByteString value)
         Optional: Pagination token for fetching the next page of results.
        optional string page_token = 11;
        Parameters:
        value - The bytes for pageToken to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

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

      • mergeUnknownFields

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