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<BuilderT>

org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase.AbstractBuilder<SignificantTermsAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.SignificantTermsAggregation.Builder

All Implemented Interfaces:

ObjectBuilder<SignificantTermsAggregation>

Enclosing class:

SignificantTermsAggregation

public static class SignificantTermsAggregation.Builder
extends BucketAggregationBase.AbstractBuilder<SignificantTermsAggregation.Builder>
implements ObjectBuilder<SignificantTermsAggregation>

Builder for SignificantTermsAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SignificantTermsAggregation.Builder	backgroundFilter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: background_filter
SignificantTermsAggregation.Builder	backgroundFilter(Query value)	API name: background_filter
SignificantTermsAggregation	build()	Builds a SignificantTermsAggregation.
SignificantTermsAggregation.Builder	chiSquare(java.util.function.Function<ChiSquareHeuristic.Builder,ObjectBuilder<ChiSquareHeuristic>> fn)	API name: chi_square
SignificantTermsAggregation.Builder	chiSquare(ChiSquareHeuristic value)	API name: chi_square
SignificantTermsAggregation.Builder	exclude(java.util.function.Function<TermsExclude.Builder,ObjectBuilder<TermsExclude>> fn)	API name: exclude
SignificantTermsAggregation.Builder	exclude(TermsExclude value)	API name: exclude
SignificantTermsAggregation.Builder	executionHint(TermsAggregationExecutionHint value)	API name: execution_hint
SignificantTermsAggregation.Builder	field(java.lang.String value)	API name: field
SignificantTermsAggregation.Builder	gnd(java.util.function.Function<GoogleNormalizedDistanceHeuristic.Builder,ObjectBuilder<GoogleNormalizedDistanceHeuristic>> fn)	API name: gnd
SignificantTermsAggregation.Builder	gnd(GoogleNormalizedDistanceHeuristic value)	API name: gnd
SignificantTermsAggregation.Builder	include(java.lang.String value, java.lang.String... values)	API name: include
SignificantTermsAggregation.Builder	include(java.util.List<java.lang.String> list)	API name: include
SignificantTermsAggregation.Builder	minDocCount(java.lang.Long value)	API name: min_doc_count
SignificantTermsAggregation.Builder	mutualInformation(java.util.function.Function<MutualInformationHeuristic.Builder,ObjectBuilder<MutualInformationHeuristic>> fn)	API name: mutual_information
SignificantTermsAggregation.Builder	mutualInformation(MutualInformationHeuristic value)	API name: mutual_information
SignificantTermsAggregation.Builder	percentage(java.util.function.Function<PercentageScoreHeuristic.Builder,ObjectBuilder<PercentageScoreHeuristic>> fn)	API name: percentage
SignificantTermsAggregation.Builder	percentage(PercentageScoreHeuristic value)	API name: percentage
SignificantTermsAggregation.Builder	scriptHeuristic(java.util.function.Function<ScriptedHeuristic.Builder,ObjectBuilder<ScriptedHeuristic>> fn)	API name: script_heuristic
SignificantTermsAggregation.Builder	scriptHeuristic(ScriptedHeuristic value)	API name: script_heuristic
protected SignificantTermsAggregation.Builder	self()
SignificantTermsAggregation.Builder	shardMinDocCount(java.lang.Long value)	API name: shard_min_doc_count
SignificantTermsAggregation.Builder	shardSize(java.lang.Integer value)	API name: shard_size
SignificantTermsAggregation.Builder	size(java.lang.Integer value)	API name: size

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, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

backgroundFilter

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

API name: background_filter

backgroundFilter

public final SignificantTermsAggregation.Builder backgroundFilter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)

API name: background_filter

chiSquare

public final SignificantTermsAggregation.Builder chiSquare(@Nullable
                                                           ChiSquareHeuristic value)

API name: chi_square

chiSquare

public final SignificantTermsAggregation.Builder chiSquare(java.util.function.Function<ChiSquareHeuristic.Builder,ObjectBuilder<ChiSquareHeuristic>> fn)

API name: chi_square

exclude

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

API name: exclude

exclude

public final SignificantTermsAggregation.Builder exclude(java.util.function.Function<TermsExclude.Builder,ObjectBuilder<TermsExclude>> fn)

API name: exclude

executionHint

public final SignificantTermsAggregation.Builder executionHint(@Nullable
                                                               TermsAggregationExecutionHint value)

API name: execution_hint

field

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

API name: field

gnd

public final SignificantTermsAggregation.Builder gnd(@Nullable
                                                     GoogleNormalizedDistanceHeuristic value)

API name: gnd

gnd

public final SignificantTermsAggregation.Builder gnd(java.util.function.Function<GoogleNormalizedDistanceHeuristic.Builder,ObjectBuilder<GoogleNormalizedDistanceHeuristic>> fn)

API name: gnd

include

public final SignificantTermsAggregation.Builder include(java.util.List<java.lang.String> list)

API name: include

Adds all elements of list to include.

include

public final SignificantTermsAggregation.Builder include(java.lang.String value,
                                                         java.lang.String... values)

API name: include

Adds one or more values to include.

minDocCount

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

API name: min_doc_count

mutualInformation

public final SignificantTermsAggregation.Builder mutualInformation(@Nullable
                                                                   MutualInformationHeuristic value)

API name: mutual_information

mutualInformation

public final SignificantTermsAggregation.Builder mutualInformation(java.util.function.Function<MutualInformationHeuristic.Builder,ObjectBuilder<MutualInformationHeuristic>> fn)

API name: mutual_information

percentage

public final SignificantTermsAggregation.Builder percentage(@Nullable
                                                            PercentageScoreHeuristic value)

API name: percentage

percentage

public final SignificantTermsAggregation.Builder percentage(java.util.function.Function<PercentageScoreHeuristic.Builder,ObjectBuilder<PercentageScoreHeuristic>> fn)

API name: percentage

scriptHeuristic

public final SignificantTermsAggregation.Builder scriptHeuristic(@Nullable
                                                                 ScriptedHeuristic value)

API name: script_heuristic

scriptHeuristic

public final SignificantTermsAggregation.Builder scriptHeuristic(java.util.function.Function<ScriptedHeuristic.Builder,ObjectBuilder<ScriptedHeuristic>> fn)

API name: script_heuristic

shardMinDocCount

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

API name: shard_min_doc_count

shardSize

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

API name: shard_size

size

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

API name: size

self

protected SignificantTermsAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<SignificantTermsAggregation.Builder>

build

public SignificantTermsAggregation build()

Builds a SignificantTermsAggregation.

Specified by:

build in interface ObjectBuilder<SignificantTermsAggregation>

Throws:

java.lang.NullPointerException - if some of the required fields are null.