Package org.hibernate.search.engine.search.aggregation.dsl

Interface CountValuesAggregationFieldStep<SR,PDF extends TypedSearchPredicateFactory<SR>>

Type Parameters:

SR - Scope root type.

PDF - The type of factory used to create predicates in AggregationFilterStep.filter(Function).

@Incubating
public interface CountValuesAggregationFieldStep<SR,PDF extends TypedSearchPredicateFactory<SR>>

The initial step in a "count values" aggregation definition, where the target field can be set.

Method Summary

Modifier and Type	Method	Description
CountValuesAggregationOptionsStep<SR,?,PDF>	field(String fieldPath)	Target the given field in the count values aggregation.
default CountValuesAggregationOptionsStep<SR,?,PDF>	field(CountAggregationFieldReference<SR> fieldReference)	Target the given field in the count values aggregation.

Method Details

field

CountValuesAggregationOptionsStep<SR,?,PDF> field(String fieldPath)

Target the given field in the count values aggregation.

Parameters:

fieldPath - The path to the index field to aggregate.

Returns:

The next step.

field

@Incubating
default CountValuesAggregationOptionsStep<SR,?,PDF> field(CountAggregationFieldReference<SR> fieldReference)

Target the given field in the count values aggregation.

Parameters:

fieldReference - The field reference representing a definition of the index field to aggregate.

Returns:

The next step.