Interface StandardDataQueryConfiguration.Aggregation

All Known Implementing Classes:
StandardDataQueryConfigurationImpl.AggregationImpl
Enclosing interface:
StandardDataQueryConfiguration
public static interface StandardDataQueryConfiguration.Aggregation

  • Method Details

    • getName

      String getName()

    • getType

      String getType()

    • getVariableName

      String getVariableName()
      For variable-based aggregations (e.g. sumVariableValue): the variable name as stored in the variables nested array. Generates a nested ES query to reach the variable value.

    • getFieldName

      String getFieldName()
      For direct-field aggregations (e.g. sumFieldValue, groupByField, groupByNestedField): the ES document field name (e.g. totalTokenCount, agentDefinitionKey). Produces a simple {"sum": {"field": "..."}} or {"terms": {"field": "..."}} query without any nesting wrapper — unlike variableName which always needs the variables nested path.

    • getNestedPath

      String getNestedPath()
      For groupByNestedField: the ES nested path (e.g. exchanges) that wraps the terms aggregation. Required in addition to fieldName when the target field lives inside a nested object.

    • getSubAggregationFieldName

      String getSubAggregationFieldName()
      For composite aggregations with a numeric sub-aggregation (sum, avg or percentile inside a terms bucket): the ES document field the sub-aggregation operates on. Authored in JSON as subAggregationFieldName.

    • getFilterField

      String getFilterField()
      For nested-field aggregations with an inner term filter (e.g. groupByNestedFieldFiltered, avgNestedFieldFiltered, groupByDateStartedWithAvgNestedFieldFiltered): the field name (within the nested object) to apply the term filter on.

    • getFilterValue

      String getFilterValue()
      For nested-field aggregations with an inner term filter (see getFilterField()): the value the filter field must match.

    • getSize

      Integer getSize()

    • getPercent

      Double getPercent()
      For percentile-based aggregations (e.g. percentileFieldValue, groupByDateStartedWithPercentileField, groupByNestedFieldFilteredWithPercentileField): the single percentile to compute (e.g. 50.0, 95.0, 99.0).

    • getOrder

      String getOrder()
      For terms-bucket aggregations (e.g. groupByNestedFieldFiltered): the order direction used by the underlying terms aggregation. Either "asc" or "desc"; defaults to "desc". Note that ES still uses the bucket _count to order, only the direction is configurable here.