Package org.mlflow.api.proto

Class Service.QueryTraceMetrics

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.mlflow.api.proto.Service.QueryTraceMetrics
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Service.QueryTraceMetricsOrBuilder
Enclosing class:
Service
public static final class Service.QueryTraceMetrics extends com.google.protobuf.GeneratedMessageV3 implements Service.QueryTraceMetricsOrBuilder
 Query aggregated metrics for traces, spans, or assessments.
Protobuf type mlflow.QueryTraceMetrics
See Also:

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields in class com.google.protobuf.GeneratedMessageV3

    • 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

    • 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.

    • getExperimentIdsCount

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

    • getExperimentIds

      public 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.

    • 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.

    • getViewType

      public Service.MetricViewType getViewType()
       Required: The level at which to aggregate metrics.
      optional .mlflow.MetricViewType view_type = 2;
      Specified by:
      getViewType in interface Service.QueryTraceMetricsOrBuilder
      Returns:
      The viewType.

    • 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 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.

    • getAggregationsList

      public List<Service.MetricAggregation> getAggregationsList()
       Required: The aggregations to apply.
      repeated .mlflow.MetricAggregation aggregations = 4;
      Specified by:
      getAggregationsList in interface Service.QueryTraceMetricsOrBuilder

    • getAggregationsOrBuilderList

      public List<? extends Service.MetricAggregationOrBuilder> getAggregationsOrBuilderList()
       Required: The aggregations to apply.
      repeated .mlflow.MetricAggregation aggregations = 4;
      Specified by:
      getAggregationsOrBuilderList in interface Service.QueryTraceMetricsOrBuilder

    • getAggregationsCount

      public int getAggregationsCount()
       Required: The aggregations to apply.
      repeated .mlflow.MetricAggregation aggregations = 4;
      Specified by:
      getAggregationsCount in interface Service.QueryTraceMetricsOrBuilder

    • getAggregations

      public Service.MetricAggregation getAggregations(int index)
       Required: The aggregations to apply.
      repeated .mlflow.MetricAggregation aggregations = 4;
      Specified by:
      getAggregations in interface Service.QueryTraceMetricsOrBuilder

    • getAggregationsOrBuilder

      public Service.MetricAggregationOrBuilder getAggregationsOrBuilder(int index)
       Required: The aggregations to apply.
      repeated .mlflow.MetricAggregation aggregations = 4;
      Specified by:
      getAggregationsOrBuilder in interface Service.QueryTraceMetricsOrBuilder

    • 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 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.

    • 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 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • 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 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.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Service.QueryTraceMetrics parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Service.QueryTraceMetrics parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Service.QueryTraceMetrics parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Service.QueryTraceMetrics parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Service.QueryTraceMetrics parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Service.QueryTraceMetrics parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Service.QueryTraceMetrics parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Service.QueryTraceMetrics parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Service.QueryTraceMetrics parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Service.QueryTraceMetrics parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Service.QueryTraceMetrics parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Service.QueryTraceMetrics parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

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

    • newBuilder

      public static Service.QueryTraceMetrics.Builder newBuilder()

    • newBuilder

      public static Service.QueryTraceMetrics.Builder newBuilder(Service.QueryTraceMetrics prototype)

    • toBuilder

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

    • newBuilderForType

      protected Service.QueryTraceMetrics.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static Service.QueryTraceMetrics getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Service.QueryTraceMetrics> parser()

    • getParserForType

      public com.google.protobuf.Parser<Service.QueryTraceMetrics> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

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