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

Class SignificantTextAggregation.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<SignificantTextAggregation.Builder>

org.opensearch.client.opensearch._types.aggregations.SignificantTextAggregation.Builder

All Implemented Interfaces:

ObjectBuilder<SignificantTextAggregation>

Enclosing class:

SignificantTextAggregation

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

Builder for SignificantTextAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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 SignificantTextAggregation.Builder backgroundFilter(@Nullable
                                                                 Query value)

API name: background_filter

backgroundFilter

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

API name: background_filter

chiSquare

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

API name: chi_square

chiSquare

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

API name: chi_square

exclude

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

API name: exclude

exclude

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

API name: exclude

executionHint

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

API name: execution_hint

field

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

API name: field

filterDuplicateText

public final SignificantTextAggregation.Builder filterDuplicateText(@Nullable
                                                                    java.lang.Boolean value)

API name: filter_duplicate_text

gnd

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

API name: gnd

gnd

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

API name: gnd

include

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

API name: include

Adds all elements of list to include.

include

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

API name: include

Adds one or more values to include.

minDocCount

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

API name: min_doc_count

mutualInformation

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

API name: mutual_information

mutualInformation

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

API name: mutual_information

percentage

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

API name: percentage

percentage

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

API name: percentage

scriptHeuristic

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

API name: script_heuristic

scriptHeuristic

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

API name: script_heuristic

shardMinDocCount

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

API name: shard_min_doc_count

shardSize

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

API name: shard_size

size

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

API name: size

sourceFields

public final SignificantTextAggregation.Builder sourceFields(java.util.List<java.lang.String> list)

API name: source_fields

Adds all elements of list to sourceFields.

sourceFields

public final SignificantTextAggregation.Builder sourceFields(java.lang.String value,
                                                             java.lang.String... values)

API name: source_fields

Adds one or more values to sourceFields.

self

protected SignificantTextAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<SignificantTextAggregation.Builder>

build

public SignificantTextAggregation build()

Builds a SignificantTextAggregation.

Specified by:

build in interface ObjectBuilder<SignificantTextAggregation>

Throws:

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