Package co.elastic.clients.elasticsearch._types.aggregations

Class SignificantTermsAggregation.Builder

java.lang.Object

co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder<BuilderT>

co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase.AbstractBuilder<SignificantTermsAggregation.Builder>

co.elastic.clients.elasticsearch._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	addExclude(java.lang.String value)	Add a value to exclude(List), creating the list if needed.
SignificantTermsAggregation.Builder	addInclude(java.lang.String value)	Add a value to include(List), creating the list if needed.
SignificantTermsAggregation.Builder	backgroundFilter(Query value)	API name: background_filter
SignificantTermsAggregation.Builder	backgroundFilter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: background_filter
SignificantTermsAggregation	build()	Builds a SignificantTermsAggregation.
SignificantTermsAggregation.Builder	chiSquare(ChiSquareHeuristic value)	API name: chi_square
SignificantTermsAggregation.Builder	chiSquare(java.util.function.Function<ChiSquareHeuristic.Builder,ObjectBuilder<ChiSquareHeuristic>> fn)	API name: chi_square
SignificantTermsAggregation.Builder	exclude(java.lang.String... value)	API name: exclude
SignificantTermsAggregation.Builder	exclude(java.util.List<java.lang.String> 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(GoogleNormalizedDistanceHeuristic value)	API name: gnd
SignificantTermsAggregation.Builder	gnd(java.util.function.Function<GoogleNormalizedDistanceHeuristic.Builder,ObjectBuilder<GoogleNormalizedDistanceHeuristic>> fn)	API name: gnd
SignificantTermsAggregation.Builder	include(java.lang.String... value)	API name: include
SignificantTermsAggregation.Builder	include(java.util.List<java.lang.String> value)	API name: include
SignificantTermsAggregation.Builder	minDocCount(java.lang.Long value)	API name: min_doc_count
SignificantTermsAggregation.Builder	mutualInformation(MutualInformationHeuristic value)	API name: mutual_information
SignificantTermsAggregation.Builder	mutualInformation(java.util.function.Function<MutualInformationHeuristic.Builder,ObjectBuilder<MutualInformationHeuristic>> fn)	API name: mutual_information
SignificantTermsAggregation.Builder	percentage(PercentageScoreHeuristic value)	API name: percentage
SignificantTermsAggregation.Builder	percentage(java.util.function.Function<PercentageScoreHeuristic.Builder,ObjectBuilder<PercentageScoreHeuristic>> fn)	API name: percentage
SignificantTermsAggregation.Builder	scriptHeuristic(ScriptedHeuristic value)	API name: script_heuristic
SignificantTermsAggregation.Builder	scriptHeuristic(java.util.function.Function<ScriptedHeuristic.Builder,ObjectBuilder<ScriptedHeuristic>> fn)	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 co.elastic.clients.elasticsearch._types.aggregations.BucketAggregationBase.AbstractBuilder

aggregations, aggregations, putAggregations, putAggregations

Methods inherited from class co.elastic.clients.elasticsearch._types.aggregations.AggregationBase.AbstractBuilder

meta, name, putMeta

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

backgroundFilter

public SignificantTermsAggregation.Builder backgroundFilter(@Nullable
Query value)

API name: background_filter

backgroundFilter

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

API name: background_filter

chiSquare

public SignificantTermsAggregation.Builder chiSquare(@Nullable
ChiSquareHeuristic value)

API name: chi_square

chiSquare

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

API name: chi_square

exclude

public SignificantTermsAggregation.Builder exclude(@Nullable
java.util.List<java.lang.String> value)

API name: exclude

exclude

public SignificantTermsAggregation.Builder exclude(java.lang.String... value)

API name: exclude

addExclude

public SignificantTermsAggregation.Builder addExclude(java.lang.String value)

Add a value to exclude(List), creating the list if needed.

executionHint

public SignificantTermsAggregation.Builder executionHint(@Nullable
TermsAggregationExecutionHint value)

API name: execution_hint

field

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

API name: field

gnd

public SignificantTermsAggregation.Builder gnd(@Nullable
GoogleNormalizedDistanceHeuristic value)

API name: gnd

gnd

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

API name: gnd

include

public SignificantTermsAggregation.Builder include(@Nullable
java.util.List<java.lang.String> value)

API name: include

include

public SignificantTermsAggregation.Builder include(java.lang.String... value)

API name: include

addInclude

public SignificantTermsAggregation.Builder addInclude(java.lang.String value)

Add a value to include(List), creating the list if needed.

minDocCount

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

API name: min_doc_count

mutualInformation

public SignificantTermsAggregation.Builder mutualInformation(@Nullable
MutualInformationHeuristic value)

API name: mutual_information

mutualInformation

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

API name: mutual_information

percentage

public SignificantTermsAggregation.Builder percentage(@Nullable
PercentageScoreHeuristic value)

API name: percentage

percentage

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

API name: percentage

scriptHeuristic

public SignificantTermsAggregation.Builder scriptHeuristic(@Nullable
ScriptedHeuristic value)

API name: script_heuristic

scriptHeuristic

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

API name: script_heuristic

shardMinDocCount

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

API name: shard_min_doc_count

shardSize

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

API name: shard_size

size

public 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.