Class SignificantTermsAggregation.Builder
java.lang.Object
org.opensearch.client.util.ObjectBuilderBase
org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder<SignificantTermsAggregation.Builder>
org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase.AbstractBuilder<SignificantTermsAggregation.Builder>
org.opensearch.client.opensearch._types.aggregations.SignificantTermsAggregation.Builder
- All Implemented Interfaces:
CopyableBuilder<SignificantTermsAggregation.Builder,,SignificantTermsAggregation> MutableBuilder<SignificantTermsAggregation.Builder,,SignificantTermsAggregation> ObjectBuilder<SignificantTermsAggregation>
- Enclosing class:
SignificantTermsAggregation
public static class SignificantTermsAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<SignificantTermsAggregation.Builder>
implements CopyableBuilder<SignificantTermsAggregation.Builder,SignificantTermsAggregation>
Builder for
SignificantTermsAggregation.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionAPI name:background_filterbackgroundFilter(Query value) API name:background_filterbuild()Builds aSignificantTermsAggregation.API name:chi_squarechiSquare(ChiSquareHeuristic value) API name:chi_squarecopy()Create a new builderCopyableBuilderthat is a copy of this one.API name:excludeexclude(TermsExclude value) API name:excludeAPI name:execution_hintAPI name:fieldgnd(Function<GoogleNormalizedDistanceHeuristic.Builder, ObjectBuilder<GoogleNormalizedDistanceHeuristic>> fn) API name:gndAPI name:gndAPI name:includeinclude(TermsInclude value) API name:includeAPI name:jlhjlh(EmptyObject value) API name:jlhminDocCount(Long value) Only return terms that are found in more thanmin_doc_counthits.mutualInformation(Function<MutualInformationHeuristic.Builder, ObjectBuilder<MutualInformationHeuristic>> fn) API name:mutual_informationAPI name:mutual_informationAPI name:percentageAPI name:percentageAPI name:script_heuristicscriptHeuristic(ScriptedHeuristic value) API name:script_heuristicprotected SignificantTermsAggregation.Builderself()shardMinDocCount(Long value) Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to themin_doc_count.Can be used to control the volumes of candidate terms produced by each shard.The number of buckets returned out of the overall terms list.Methods inherited from class org.opensearch.client.opensearch._types.aggregations.AggregationBase.AbstractBuilder
meta, meta, nameMethods inherited from class org.opensearch.client.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAllMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.util.MutableBuilder
applyMutation
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
copy
Description copied from interface:CopyableBuilderCreate a new builderCopyableBuilderthat is a copy of this one.- Specified by:
copyin interfaceCopyableBuilder<SignificantTermsAggregation.Builder,SignificantTermsAggregation> - Returns:
- a new builder instance.
-
self
- Specified by:
selfin classAggregationBase.AbstractBuilder<SignificantTermsAggregation.Builder>
-
backgroundFilter
API name:background_filter -
backgroundFilter
@Nonnull public final SignificantTermsAggregation.Builder backgroundFilter(Function<Query.Builder, ObjectBuilder<Query>> fn) API name:background_filter -
chiSquare
@Nonnull public final SignificantTermsAggregation.Builder chiSquare(@Nullable ChiSquareHeuristic value) API name:chi_square -
chiSquare
@Nonnull public final SignificantTermsAggregation.Builder chiSquare(Function<ChiSquareHeuristic.Builder, ObjectBuilder<ChiSquareHeuristic>> fn) API name:chi_square -
exclude
API name:exclude -
exclude
@Nonnull public final SignificantTermsAggregation.Builder exclude(Function<TermsExclude.Builder, ObjectBuilder<TermsExclude>> fn) API name:exclude -
executionHint
@Nonnull public final SignificantTermsAggregation.Builder executionHint(@Nullable TermsAggregationExecutionHint value) API name:execution_hint -
field
API name:field -
gnd
@Nonnull public final SignificantTermsAggregation.Builder gnd(@Nullable GoogleNormalizedDistanceHeuristic value) API name:gnd -
gnd
@Nonnull public final SignificantTermsAggregation.Builder gnd(Function<GoogleNormalizedDistanceHeuristic.Builder, ObjectBuilder<GoogleNormalizedDistanceHeuristic>> fn) API name:gnd -
include
API name:include -
include
@Nonnull public final SignificantTermsAggregation.Builder include(Function<TermsInclude.Builder, ObjectBuilder<TermsInclude>> fn) API name:include -
jlh
API name:jlh -
jlh
@Nonnull public final SignificantTermsAggregation.Builder jlh(Function<EmptyObject.Builder, ObjectBuilder<EmptyObject>> fn) API name:jlh -
minDocCount
Only return terms that are found in more thanmin_doc_counthits.API name:
min_doc_count -
mutualInformation
@Nonnull public final SignificantTermsAggregation.Builder mutualInformation(@Nullable MutualInformationHeuristic value) API name:mutual_information -
mutualInformation
@Nonnull public final SignificantTermsAggregation.Builder mutualInformation(Function<MutualInformationHeuristic.Builder, ObjectBuilder<MutualInformationHeuristic>> fn) API name:mutual_information -
percentage
@Nonnull public final SignificantTermsAggregation.Builder percentage(@Nullable PercentageScoreHeuristic value) API name:percentage -
percentage
@Nonnull public final SignificantTermsAggregation.Builder percentage(Function<PercentageScoreHeuristic.Builder, ObjectBuilder<PercentageScoreHeuristic>> fn) API name:percentage -
scriptHeuristic
@Nonnull public final SignificantTermsAggregation.Builder scriptHeuristic(@Nullable ScriptedHeuristic value) API name:script_heuristic -
scriptHeuristic
@Nonnull public final SignificantTermsAggregation.Builder scriptHeuristic(Function<ScriptedHeuristic.Builder, ObjectBuilder<ScriptedHeuristic>> fn) API name:script_heuristic -
shardMinDocCount
Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to themin_doc_count. Terms will only be considered if their local shard frequency within the set is higher than theshard_min_doc_count.API name:
shard_min_doc_count -
shardSize
Can be used to control the volumes of candidate terms produced by each shard. By default,shard_sizewill be automatically estimated based on the number of shards and thesizeparameter.API name:
shard_size -
size
The number of buckets returned out of the overall terms list.API name:
size -
build
Builds aSignificantTermsAggregation.- Specified by:
buildin interfaceObjectBuilder<SignificantTermsAggregation>- Throws:
NullPointerException- if some of the required fields are null.
-