Class SignificantTermsAggregation
- java.lang.Object
-
- org.opensearch.client.opensearch._types.aggregations.AggregationBase
-
- org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase
-
- org.opensearch.client.opensearch._types.aggregations.SignificantTermsAggregation
-
- All Implemented Interfaces:
JsonpSerializable
,PlainJsonSerializable
,AggregationVariant
@JsonpDeserializable public class SignificantTermsAggregation extends BucketAggregationBase implements AggregationVariant
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SignificantTermsAggregation.Builder
Builder forSignificantTermsAggregation
.-
Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase
BucketAggregationBase.AbstractBuilder<BuilderT extends BucketAggregationBase.AbstractBuilder<BuilderT>>
-
-
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<SignificantTermsAggregation>
_DESERIALIZER
Json deserializer forSignificantTermsAggregation
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Aggregation.Kind
_aggregationKind()
Aggregation variant kind.Query
backgroundFilter()
API name:background_filter
ChiSquareHeuristic
chiSquare()
API name:chi_square
TermsExclude
exclude()
API name:exclude
TermsAggregationExecutionHint
executionHint()
API name:execution_hint
java.lang.String
field()
API name:field
GoogleNormalizedDistanceHeuristic
gnd()
API name:gnd
java.util.List<java.lang.String>
include()
API name:include
java.lang.Long
minDocCount()
API name:min_doc_count
MutualInformationHeuristic
mutualInformation()
API name:mutual_information
static SignificantTermsAggregation
of(java.util.function.Function<SignificantTermsAggregation.Builder,ObjectBuilder<SignificantTermsAggregation>> fn)
PercentageScoreHeuristic
percentage()
API name:percentage
ScriptedHeuristic
scriptHeuristic()
API name:script_heuristic
protected void
serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void
setupSignificantTermsAggregationDeserializer(ObjectDeserializer<SignificantTermsAggregation.Builder> op)
java.lang.Long
shardMinDocCount()
API name:shard_min_doc_count
java.lang.Integer
shardSize()
API name:shard_size
java.lang.Integer
size()
API name:size
-
Methods inherited from class org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase
setupBucketAggregationBaseDeserializer
-
Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase
meta, name, serialize, setupAggregationBaseDeserializer
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.opensearch.client.opensearch._types.aggregations.AggregationVariant
_toAggregation
-
Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonString
-
-
-
-
Field Detail
-
_DESERIALIZER
public static final JsonpDeserializer<SignificantTermsAggregation> _DESERIALIZER
Json deserializer forSignificantTermsAggregation
-
-
Method Detail
-
of
public static SignificantTermsAggregation of(java.util.function.Function<SignificantTermsAggregation.Builder,ObjectBuilder<SignificantTermsAggregation>> fn)
-
_aggregationKind
public Aggregation.Kind _aggregationKind()
Aggregation variant kind.- Specified by:
_aggregationKind
in interfaceAggregationVariant
-
backgroundFilter
@Nullable public final Query backgroundFilter()
API name:background_filter
-
chiSquare
@Nullable public final ChiSquareHeuristic chiSquare()
API name:chi_square
-
exclude
@Nullable public final TermsExclude exclude()
API name:exclude
-
executionHint
@Nullable public final TermsAggregationExecutionHint executionHint()
API name:execution_hint
-
field
@Nullable public final java.lang.String field()
API name:field
-
gnd
@Nullable public final GoogleNormalizedDistanceHeuristic gnd()
API name:gnd
-
include
public final java.util.List<java.lang.String> include()
API name:include
-
minDocCount
@Nullable public final java.lang.Long minDocCount()
API name:min_doc_count
-
mutualInformation
@Nullable public final MutualInformationHeuristic mutualInformation()
API name:mutual_information
-
percentage
@Nullable public final PercentageScoreHeuristic percentage()
API name:percentage
-
scriptHeuristic
@Nullable public final ScriptedHeuristic scriptHeuristic()
API name:script_heuristic
-
shardMinDocCount
@Nullable public final java.lang.Long shardMinDocCount()
API name:shard_min_doc_count
-
shardSize
@Nullable public final java.lang.Integer shardSize()
API name:shard_size
-
size
@Nullable public final java.lang.Integer size()
API name:size
-
serializeInternal
protected void serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
- Overrides:
serializeInternal
in classAggregationBase
-
setupSignificantTermsAggregationDeserializer
protected static void setupSignificantTermsAggregationDeserializer(ObjectDeserializer<SignificantTermsAggregation.Builder> op)
-
-