Interface TermsAggregationFieldStep<PDF extends SearchPredicateFactory>
- Type Parameters:
PDF
- The type of factory used to create predicates inAggregationFilterStep.filter(Function)
.
public interface TermsAggregationFieldStep<PDF extends SearchPredicateFactory>
The initial step in a "terms" aggregation definition, where the target field can be set.
-
Method Summary
Modifier and TypeMethodDescriptiondefault <F> TermsAggregationOptionsStep<?,
PDF, F, Map<F, Long>> Target the given field in the terms aggregation.<F> TermsAggregationOptionsStep<?,
PDF, F, Map<F, Long>> field
(String fieldPath, Class<F> type, ValueConvert convert) Target the given field in the terms aggregation.
-
Method Details
-
field
Target the given field in the terms aggregation.- Type Parameters:
F
- The type of field values.- Parameters:
fieldPath
- The path to the index field to aggregate.type
- The type of field values.- Returns:
- The next step.
-
field
<F> TermsAggregationOptionsStep<?,PDF, fieldF, Map<F, Long>> (String fieldPath, Class<F> type, ValueConvert convert) Target the given field in the terms aggregation.- Type Parameters:
F
- The type of field values.- Parameters:
fieldPath
- The path to the index field to aggregate.type
- The type of field values.convert
- Controls how the ranges passed to the next steps and fetched from the backend should be converted. SeeValueConvert
.- Returns:
- The next step.
-