Package org.mlflow.api.proto

Interface Service.SearchUnifiedTracesOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getExperimentIds​(int index)
      TODO: Eventually we want to provide an API that only uses model_id
      com.google.protobuf.ByteString getExperimentIdsBytes​(int index)
      TODO: Eventually we want to provide an API that only uses model_id
      int getExperimentIdsCount()
      TODO: Eventually we want to provide an API that only uses model_id
      java.util.List<java.lang.String> getExperimentIdsList()
      TODO: Eventually we want to provide an API that only uses model_id
      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 getModelId()
      optional string model_id = 1 [(.mlflow.validate_required) = true];
      com.google.protobuf.ByteString getModelIdBytes()
      optional string model_id = 1 [(.mlflow.validate_required) = true];
      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.
      java.lang.String getSqlWarehouseId()
      optional string sql_warehouse_id = 2 [(.mlflow.validate_required) = true];
      com.google.protobuf.ByteString getSqlWarehouseIdBytes()
      optional string sql_warehouse_id = 2 [(.mlflow.validate_required) = true];
      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 hasModelId()
      optional string model_id = 1 [(.mlflow.validate_required) = true];
      boolean hasPageToken()
      Token indicating the page of traces to fetch.
      boolean hasSqlWarehouseId()
      optional string sql_warehouse_id = 2 [(.mlflow.validate_required) = true];

      • 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

      • hasModelId

        boolean hasModelId()
        optional string model_id = 1 [(.mlflow.validate_required) = true];
        Returns:
        Whether the modelId field is set.

      • getModelId

        java.lang.String getModelId()
        optional string model_id = 1 [(.mlflow.validate_required) = true];
        Returns:
        The modelId.

      • getModelIdBytes

        com.google.protobuf.ByteString getModelIdBytes()
        optional string model_id = 1 [(.mlflow.validate_required) = true];
        Returns:
        The bytes for modelId.

      • hasSqlWarehouseId

        boolean hasSqlWarehouseId()
        optional string sql_warehouse_id = 2 [(.mlflow.validate_required) = true];
        Returns:
        Whether the sqlWarehouseId field is set.

      • getSqlWarehouseId

        java.lang.String getSqlWarehouseId()
        optional string sql_warehouse_id = 2 [(.mlflow.validate_required) = true];
        Returns:
        The sqlWarehouseId.

      • getSqlWarehouseIdBytes

        com.google.protobuf.ByteString getSqlWarehouseIdBytes()
        optional string sql_warehouse_id = 2 [(.mlflow.validate_required) = true];
        Returns:
        The bytes for sqlWarehouseId.

      • getExperimentIdsList

        java.util.List<java.lang.String> getExperimentIdsList()
         TODO: Eventually we want to provide an API that only uses model_id
        repeated string experiment_ids = 3;
        Returns:
        A list containing the experimentIds.

      • getExperimentIdsCount

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

      • getExperimentIds

        java.lang.String getExperimentIds​(int index)
         TODO: Eventually we want to provide an API that only uses model_id
        repeated string experiment_ids = 3;
        Parameters:
        index - The index of the element to return.
        Returns:
        The experimentIds at the given index.

      • getExperimentIdsBytes

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

      • hasMaxResults

        boolean hasMaxResults()
         Maximum number of traces desired. Max threshold is 500.
        optional int32 max_results = 5 [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 = 5 [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 = 6;
        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 = 6;
        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 = 6;
        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 = 6;
        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. This is a unified token that encodes both online and offline traces
 tokens.
        optional string page_token = 7;
        Returns:
        Whether the pageToken field is set.

      • getPageToken

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

      • getPageTokenBytes

        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;
        Returns:
        The bytes for pageToken.