Class TermsAggregation
java.lang.Object
co.elastic.clients.elasticsearch._types.aggregations.AggregationBase
co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase
co.elastic.clients.elasticsearch._types.aggregations.TermsAggregation
- All Implemented Interfaces:
AggregationVariant
,PivotGroupByVariant
,JsonpSerializable
@JsonpDeserializable public class TermsAggregation extends BucketAggregationBase implements AggregationVariant, PivotGroupByVariant
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TermsAggregation.Builder
Builder forTermsAggregation
.Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase
BucketAggregationBase.AbstractBuilder<BuilderT extends BucketAggregationBase.AbstractBuilder<BuilderT>>
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<TermsAggregation>
_DESERIALIZER
Json deserializer forTermsAggregation
-
Method Summary
Modifier and Type Method Description Aggregation.Kind
_aggregationKind()
Aggregation variant kind.PivotGroupBy.Kind
_pivotGroupByKind()
PivotGroupBy variant kind.TermsAggregationCollectMode
collectMode()
API name:collect_mode
TermsExclude
exclude()
API name:exclude
TermsAggregationExecutionHint
executionHint()
API name:execution_hint
java.lang.String
field()
API name:field
java.lang.String
format()
API name:format
TermsInclude
include()
API name:include
java.lang.Integer
minDocCount()
API name:min_doc_count
FieldValue
missing()
API name:missing
java.lang.Boolean
missingBucket()
API name:missing_bucket
MissingOrder
missingOrder()
API name:missing_order
static TermsAggregation
of(java.util.function.Function<TermsAggregation.Builder,ObjectBuilder<TermsAggregation>> fn)
java.util.List<java.util.Map<java.lang.String,SortOrder>>
order()
API name:order
Script
script()
API name:script
protected void
serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void
setupTermsAggregationDeserializer(ObjectDeserializer<TermsAggregation.Builder> op)
java.lang.Integer
shardSize()
API name:shard_size
java.lang.Boolean
showTermDocCountError()
API name:show_term_doc_count_error
java.lang.Integer
size()
API name:size
java.lang.String
valueType()
API name:value_type
Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase
setupBucketAggregationBaseDeserializer
Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase
meta, name, serialize, setupAggregationBaseDeserializer, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface co.elastic.clients.elasticsearch._types.aggregations.AggregationVariant
_toAggregation
Methods inherited from interface co.elastic.clients.elasticsearch.transform.PivotGroupByVariant
_toPivotGroupBy
-
Field Details
-
_DESERIALIZER
Json deserializer forTermsAggregation
-
-
Method Details
-
of
public static TermsAggregation of(java.util.function.Function<TermsAggregation.Builder,ObjectBuilder<TermsAggregation>> fn) -
_aggregationKind
Aggregation variant kind.- Specified by:
_aggregationKind
in interfaceAggregationVariant
-
_pivotGroupByKind
PivotGroupBy variant kind.- Specified by:
_pivotGroupByKind
in interfacePivotGroupByVariant
-
collectMode
API name:collect_mode
-
exclude
API name:exclude
-
executionHint
API name:execution_hint
-
field
@Nullable public final java.lang.String field()API name:field
-
include
API name:include
-
minDocCount
@Nullable public final java.lang.Integer minDocCount()API name:min_doc_count
-
missing
API name:missing
-
missingOrder
API name:missing_order
-
missingBucket
@Nullable public final java.lang.Boolean missingBucket()API name:missing_bucket
-
valueType
@Nullable public final java.lang.String valueType()API name:value_type
-
order
API name:order
-
script
API name:script
-
shardSize
@Nullable public final java.lang.Integer shardSize()API name:shard_size
-
showTermDocCountError
@Nullable public final java.lang.Boolean showTermDocCountError()API name:show_term_doc_count_error
-
size
@Nullable public final java.lang.Integer size()API name:size
-
format
@Nullable public final java.lang.String format()API name:format
-
serializeInternal
- Overrides:
serializeInternal
in classAggregationBase
-
setupTermsAggregationDeserializer
protected static void setupTermsAggregationDeserializer(ObjectDeserializer<TermsAggregation.Builder> op)
-