Package org.opensearch.client.opensearch._types.aggregations

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

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final SignificantTermsAggregation.Builder	backgroundFilter(Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: background_filter
final SignificantTermsAggregation.Builder	backgroundFilter(Query value)	API name: background_filter
SignificantTermsAggregation	build()	Builds a SignificantTermsAggregation.
final SignificantTermsAggregation.Builder	chiSquare(Function<ChiSquareHeuristic.Builder,ObjectBuilder<ChiSquareHeuristic>> fn)	API name: chi_square
final SignificantTermsAggregation.Builder	chiSquare(ChiSquareHeuristic value)	API name: chi_square
SignificantTermsAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SignificantTermsAggregation.Builder	exclude(Function<TermsExclude.Builder,ObjectBuilder<TermsExclude>> fn)	API name: exclude
final SignificantTermsAggregation.Builder	exclude(TermsExclude value)	API name: exclude
final SignificantTermsAggregation.Builder	executionHint(TermsAggregationExecutionHint value)	API name: execution_hint
final SignificantTermsAggregation.Builder	field(String value)	API name: field
final SignificantTermsAggregation.Builder	gnd(Function<GoogleNormalizedDistanceHeuristic.Builder,ObjectBuilder<GoogleNormalizedDistanceHeuristic>> fn)	API name: gnd
final SignificantTermsAggregation.Builder	gnd(GoogleNormalizedDistanceHeuristic value)	API name: gnd
final SignificantTermsAggregation.Builder	include(Function<TermsInclude.Builder,ObjectBuilder<TermsInclude>> fn)	API name: include
final SignificantTermsAggregation.Builder	include(TermsInclude value)	API name: include
final SignificantTermsAggregation.Builder	jlh(Function<EmptyObject.Builder,ObjectBuilder<EmptyObject>> fn)	API name: jlh
final SignificantTermsAggregation.Builder	jlh(EmptyObject value)	API name: jlh
final SignificantTermsAggregation.Builder	minDocCount(Long value)	Only return terms that are found in more than min_doc_count hits.
final SignificantTermsAggregation.Builder	mutualInformation(Function<MutualInformationHeuristic.Builder,ObjectBuilder<MutualInformationHeuristic>> fn)	API name: mutual_information
final SignificantTermsAggregation.Builder	mutualInformation(MutualInformationHeuristic value)	API name: mutual_information
final SignificantTermsAggregation.Builder	percentage(Function<PercentageScoreHeuristic.Builder,ObjectBuilder<PercentageScoreHeuristic>> fn)	API name: percentage
final SignificantTermsAggregation.Builder	percentage(PercentageScoreHeuristic value)	API name: percentage
final SignificantTermsAggregation.Builder	scriptHeuristic(Function<ScriptedHeuristic.Builder,ObjectBuilder<ScriptedHeuristic>> fn)	API name: script_heuristic
final SignificantTermsAggregation.Builder	scriptHeuristic(ScriptedHeuristic value)	API name: script_heuristic
protected SignificantTermsAggregation.Builder	self()
final SignificantTermsAggregation.Builder	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 the min_doc_count.
final SignificantTermsAggregation.Builder	shardSize(Integer value)	Can be used to control the volumes of candidate terms produced by each shard.
final SignificantTermsAggregation.Builder	size(Integer value)	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, name

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

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.util.MutableBuilder

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public SignificantTermsAggregation.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<SignificantTermsAggregation.Builder,SignificantTermsAggregation>

Returns:

a new builder instance.

self

@Nonnull
protected SignificantTermsAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<SignificantTermsAggregation.Builder>

backgroundFilter

@Nonnull
public final SignificantTermsAggregation.Builder backgroundFilter(@Nullable
 Query value)

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

@Nonnull
public final SignificantTermsAggregation.Builder exclude(@Nullable
 TermsExclude value)

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

@Nonnull
public final SignificantTermsAggregation.Builder field(@Nullable
 String value)

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

@Nonnull
public final SignificantTermsAggregation.Builder include(@Nullable
 TermsInclude value)

API name: include

include

@Nonnull
public final SignificantTermsAggregation.Builder include(Function<TermsInclude.Builder,ObjectBuilder<TermsInclude>> fn)

API name: include

jlh

@Nonnull
public final SignificantTermsAggregation.Builder jlh(@Nullable
 EmptyObject value)

API name: jlh

jlh

@Nonnull
public final SignificantTermsAggregation.Builder jlh(Function<EmptyObject.Builder,ObjectBuilder<EmptyObject>> fn)

API name: jlh

minDocCount

@Nonnull
public final SignificantTermsAggregation.Builder minDocCount(@Nullable
 Long value)

Only return terms that are found in more than min_doc_count hits.

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

@Nonnull
public final SignificantTermsAggregation.Builder shardMinDocCount(@Nullable
 Long value)

Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the min_doc_count. Terms will only be considered if their local shard frequency within the set is higher than the shard_min_doc_count.

API name: shard_min_doc_count

shardSize

@Nonnull
public final SignificantTermsAggregation.Builder shardSize(@Nullable
 Integer value)

Can be used to control the volumes of candidate terms produced by each shard. By default, shard_size will be automatically estimated based on the number of shards and the size parameter.

API name: shard_size

size

@Nonnull
public final SignificantTermsAggregation.Builder size(@Nullable
 Integer value)

The number of buckets returned out of the overall terms list.

API name: size

build

@Nonnull
public SignificantTermsAggregation build()

Builds a SignificantTermsAggregation.

Specified by:

build in interface ObjectBuilder<SignificantTermsAggregation>

Throws:

NullPointerException - if some of the required fields are null.