Package org.mlflow.api.proto

Interface Service.QueryTraceMetricsOrBuilder

    • Method Detail

      • getExperimentIdsList

        java.util.List<java.lang.String> getExperimentIdsList()
         Required: The experiment IDs to search traces.
        repeated string experiment_ids = 1;
        Returns:
        A list containing the experimentIds.

      • getExperimentIdsCount

        int getExperimentIdsCount()
         Required: The experiment IDs to search traces.
        repeated string experiment_ids = 1;
        Returns:
        The count of experimentIds.

      • getExperimentIds

        java.lang.String getExperimentIds​(int index)
         Required: The experiment IDs to search traces.
        repeated string experiment_ids = 1;
        Parameters:
        index - The index of the element to return.
        Returns:
        The experimentIds at the given index.

      • getExperimentIdsBytes

        com.google.protobuf.ByteString getExperimentIdsBytes​(int index)
         Required: The experiment IDs to search traces.
        repeated string experiment_ids = 1;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the experimentIds at the given index.

      • hasViewType

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

      • getViewType

        Service.MetricViewType getViewType()
         Required: The level at which to aggregate metrics.
        optional .mlflow.MetricViewType view_type = 2;
        Returns:
        The viewType.

      • hasMetricName

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

      • getMetricName

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

      • getMetricNameBytes

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

      • getAggregationsList

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

      • getAggregations

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

      • getAggregationsCount

        int getAggregationsCount()
         Required: The aggregations to apply.
        repeated .mlflow.MetricAggregation aggregations = 4;

      • getAggregationsOrBuilderList

        java.util.List<? extends Service.MetricAggregationOrBuilder> getAggregationsOrBuilderList()
         Required: The aggregations to apply.
        repeated .mlflow.MetricAggregation aggregations = 4;

      • getAggregationsOrBuilder

        Service.MetricAggregationOrBuilder getAggregationsOrBuilder​(int index)
         Required: The aggregations to apply.
        repeated .mlflow.MetricAggregation aggregations = 4;

      • getDimensionsList

        java.util.List<java.lang.String> getDimensionsList()
         Optional: Dimensions to group metrics by. (e.g. "name", "status")
        repeated string dimensions = 5;
        Returns:
        A list containing the dimensions.

      • getDimensionsCount

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

      • getDimensions

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

      • getDimensionsBytes

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

      • getFiltersList

        java.util.List<java.lang.String> getFiltersList()
         Optional: Filter expressions to apply. (e.g. `trace.status="OK"`)
        repeated string filters = 6;
        Returns:
        A list containing the filters.

      • getFiltersCount

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

      • getFilters

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

      • getFiltersBytes

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

      • hasTimeIntervalSeconds

        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;
        Returns:
        Whether the timeIntervalSeconds field is set.

      • getTimeIntervalSeconds

        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;
        Returns:
        The timeIntervalSeconds.

      • hasStartTimeMs

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

      • getStartTimeMs

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

      • hasEndTimeMs

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

      • getEndTimeMs

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

      • hasMaxResults

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

      • getMaxResults

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

      • hasPageToken

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

      • getPageToken

        java.lang.String getPageToken()
         Optional: Pagination token for fetching the next page of results.
        optional string page_token = 11;
        Returns:
        The pageToken.

      • getPageTokenBytes

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