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

Class SignificantTextAggregation.Builder

java.lang.Object

org.opensearch.client.opensearch._types.aggregations.Aggregation.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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SignificantTextAggregation.Builder	addExclude(java.lang.String value)	Add a value to exclude(List), creating the list if needed.
SignificantTextAggregation.Builder	addInclude(java.lang.String value)	Add a value to include(List), creating the list if needed.
SignificantTextAggregation.Builder	addSourceFields(java.lang.String value)	Add a value to sourceFields(List), creating the list if needed.
SignificantTextAggregation.Builder	backgroundFilter(java.util.function.Function<QueryContainer.Builder,ObjectBuilder<QueryContainer>> fn)	API name: background_filter
SignificantTextAggregation.Builder	backgroundFilter(QueryContainer 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.lang.String... value)	API name: exclude
SignificantTextAggregation.Builder	exclude(java.util.List<java.lang.String> value)	API name: exclude
SignificantTextAggregation.Builder	executionHint(jakarta.json.JsonValue 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)	API name: include
SignificantTextAggregation.Builder	include(java.util.List<java.lang.String> value)	API name: include
SignificantTextAggregation.Builder	minDocCount(java.lang.Number 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(jakarta.json.JsonValue 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.Number value)	API name: shard_min_doc_count
SignificantTextAggregation.Builder	shardSize(java.lang.Number value)	API name: shard_size
SignificantTextAggregation.Builder	size(java.lang.Number value)	API name: size
SignificantTextAggregation.Builder	sourceFields(java.lang.String... value)	API name: source_fields
SignificantTextAggregation.Builder	sourceFields(java.util.List<java.lang.String> value)	API name: source_fields

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.BucketAggregationBase.AbstractBuilder

aggregations, aggregations, putAggregations, putAggregations

Methods inherited from class org.opensearch.client.opensearch._types.aggregations.Aggregation.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 SignificantTextAggregation.Builder backgroundFilter(@Nullable QueryContainer value)

API name: background_filter

backgroundFilter

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

API name: background_filter

chiSquare

public SignificantTextAggregation.Builder chiSquare(@Nullable ChiSquareHeuristic value)

API name: chi_square

chiSquare

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

API name: chi_square

exclude

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

API name: exclude

exclude

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

API name: exclude

addExclude

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

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

executionHint

public SignificantTextAggregation.Builder executionHint(@Nullable jakarta.json.JsonValue value)

API name: execution_hint

field

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

API name: field

filterDuplicateText

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

API name: filter_duplicate_text

gnd

public SignificantTextAggregation.Builder gnd(@Nullable GoogleNormalizedDistanceHeuristic value)

API name: gnd

gnd

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

API name: gnd

include

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

API name: include

include

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

API name: include

addInclude

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

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

minDocCount

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

API name: min_doc_count

mutualInformation

public SignificantTextAggregation.Builder mutualInformation(@Nullable MutualInformationHeuristic value)

API name: mutual_information

mutualInformation

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

API name: mutual_information

percentage

public SignificantTextAggregation.Builder percentage(@Nullable jakarta.json.JsonValue value)

API name: percentage

scriptHeuristic

public SignificantTextAggregation.Builder scriptHeuristic(@Nullable ScriptedHeuristic value)

API name: script_heuristic

scriptHeuristic

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

API name: script_heuristic

shardMinDocCount

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

API name: shard_min_doc_count

shardSize

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

API name: shard_size

size

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

API name: size

sourceFields

public SignificantTextAggregation.Builder sourceFields(@Nullable java.util.List<java.lang.String> value)

API name: source_fields

sourceFields

public SignificantTextAggregation.Builder sourceFields(java.lang.String... value)

API name: source_fields

addSourceFields

public SignificantTextAggregation.Builder addSourceFields(java.lang.String value)

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

self

protected SignificantTextAggregation.Builder self()

Specified by:

self in class Aggregation.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.