Interface ExtendedSearchAggregationFactory<S extends ExtendedSearchAggregationFactory<?,​PDF>,​PDF extends SearchPredicateFactory>

    • Method Detail

      • withRoot

        S withRoot​(String objectFieldPath)
        Description copied from interface: SearchAggregationFactory
        Create a new aggregation factory whose root for all paths passed to the DSL will be the given object field.

        See here for more information.

        Specified by:
        withRoot in interface SearchAggregationFactory
        Parameters:
        objectFieldPath - The path from the current root to an object field that will become the new root.
        Returns:
        A new aggregation factory using the given object field as root.
      • range

        RangeAggregationFieldStep<PDF> range()
        Description copied from interface: SearchAggregationFactory
        Perform aggregation in range buckets.

        Given a field and one or more ranges of values, this aggregation creates one bucket per range, and puts in each bucket every document for which the given field has a value that falls into the corresponding range.

        For each bucket, the document count is computed, or more complex metrics or sub-aggregations for backends that support it.

        Specified by:
        range in interface SearchAggregationFactory
        Returns:
        The next step.
      • terms

        TermsAggregationFieldStep<PDF> terms()
        Description copied from interface: SearchAggregationFactory
        Perform aggregation in term buckets.

        Given a field, this aggregation creates one bucket per term of that field in the index, and puts in each bucket every document for which the given field matches the corresponding term.

        For each bucket, the document count is computed, or more complex metrics or sub-aggregations for backends that support it.

        Specified by:
        terms in interface SearchAggregationFactory
        Returns:
        The next step.