Package org.mlflow.api.proto

Interface Service.SearchTracesOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Service.SearchTraces, Service.SearchTraces.Builder
    Enclosing class:
    Service
    public static interface Service.SearchTracesOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getExperimentIds​(int index)
      List of experiment IDs to search over.
      com.google.protobuf.ByteString getExperimentIdsBytes​(int index)
      List of experiment IDs to search over.
      int getExperimentIdsCount()
      List of experiment IDs to search over.
      java.util.List<java.lang.String> getExperimentIdsList()
      List of experiment IDs to search over.
      java.lang.String getFilter()
      A filter expression over trace attributes and tags that allows returning a subset of traces.
      com.google.protobuf.ByteString getFilterBytes()
      A filter expression over trace attributes and tags that allows returning a subset of traces.
      int getMaxResults()
      Maximum number of traces desired.
      java.lang.String getOrderBy​(int index)
      List of columns for ordering the results, e.g.
      com.google.protobuf.ByteString getOrderByBytes​(int index)
      List of columns for ordering the results, e.g.
      int getOrderByCount()
      List of columns for ordering the results, e.g.
      java.util.List<java.lang.String> getOrderByList()
      List of columns for ordering the results, e.g.
      java.lang.String getPageToken()
      Token indicating the page of traces to fetch.
      com.google.protobuf.ByteString getPageTokenBytes()
      Token indicating the page of traces to fetch.
      boolean hasFilter()
      A filter expression over trace attributes and tags that allows returning a subset of traces.
      boolean hasMaxResults()
      Maximum number of traces desired.
      boolean hasPageToken()
      Token indicating the page of traces to fetch.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getExperimentIdsList

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

      • getExperimentIdsCount

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

      • getExperimentIds

        java.lang.String getExperimentIds​(int index)
         List of experiment IDs to search over.
        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)
         List of experiment IDs to search over.
        repeated string experiment_ids = 1;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the experimentIds at the given index.

      • hasFilter

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

      • getFilter

        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 = 2;
        Returns:
        The filter.

      • getFilterBytes

        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 = 2;
        Returns:
        The bytes for filter.

      • hasMaxResults

        boolean hasMaxResults()
         Maximum number of traces desired. Max threshold is 500.
        optional int32 max_results = 3 [default = 100];
        Returns:
        Whether the maxResults field is set.

      • getMaxResults

        int getMaxResults()
         Maximum number of traces desired. Max threshold is 500.
        optional int32 max_results = 3 [default = 100];
        Returns:
        The maxResults.

      • getOrderByList

        java.util.List<java.lang.String> getOrderByList()
         List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
        repeated string order_by = 4;
        Returns:
        A list containing the orderBy.

      • getOrderByCount

        int getOrderByCount()
         List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
        repeated string order_by = 4;
        Returns:
        The count of orderBy.

      • getOrderBy

        java.lang.String getOrderBy​(int index)
         List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
        repeated string order_by = 4;
        Parameters:
        index - The index of the element to return.
        Returns:
        The orderBy at the given index.

      • getOrderByBytes

        com.google.protobuf.ByteString getOrderByBytes​(int index)
         List of columns for ordering the results, e.g. ``["timestamp_ms DESC"]``.
        repeated string order_by = 4;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the orderBy at the given index.

      • hasPageToken

        boolean hasPageToken()
         Token indicating the page of traces to fetch.
        optional string page_token = 5;
        Returns:
        Whether the pageToken field is set.

      • getPageToken

        java.lang.String getPageToken()
         Token indicating the page of traces to fetch.
        optional string page_token = 5;
        Returns:
        The pageToken.

      • getPageTokenBytes

        com.google.protobuf.ByteString getPageTokenBytes()
         Token indicating the page of traces to fetch.
        optional string page_token = 5;
        Returns:
        The bytes for pageToken.