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

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

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

All Implemented Interfaces:

CopyableBuilder<SignificantTextAggregation.Builder,SignificantTextAggregation>, MutableBuilder<SignificantTextAggregation.Builder,SignificantTextAggregation>, ObjectBuilder<SignificantTextAggregation>

Enclosing class:

SignificantTextAggregation

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

Builder for SignificantTextAggregation.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final SignificantTextAggregation.Builder	backgroundFilter(Function<Query.Builder,ObjectBuilder<Query>> fn)	API name: background_filter
final SignificantTextAggregation.Builder	backgroundFilter(Query value)	API name: background_filter
SignificantTextAggregation	build()	Builds a SignificantTextAggregation.
final SignificantTextAggregation.Builder	chiSquare(Function<ChiSquareHeuristic.Builder,ObjectBuilder<ChiSquareHeuristic>> fn)	API name: chi_square
final SignificantTextAggregation.Builder	chiSquare(ChiSquareHeuristic value)	API name: chi_square
SignificantTextAggregation.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SignificantTextAggregation.Builder	exclude(Function<TermsExclude.Builder,ObjectBuilder<TermsExclude>> fn)	API name: exclude
final SignificantTextAggregation.Builder	exclude(TermsExclude value)	API name: exclude
final SignificantTextAggregation.Builder	executionHint(TermsAggregationExecutionHint value)	API name: execution_hint
final SignificantTextAggregation.Builder	field(String value)	API name: field
final SignificantTextAggregation.Builder	filterDuplicateText(Boolean value)	Whether to out duplicate text to deal with noisy data.
final SignificantTextAggregation.Builder	gnd(Function<GoogleNormalizedDistanceHeuristic.Builder,ObjectBuilder<GoogleNormalizedDistanceHeuristic>> fn)	API name: gnd
final SignificantTextAggregation.Builder	gnd(GoogleNormalizedDistanceHeuristic value)	API name: gnd
final SignificantTextAggregation.Builder	include(Function<TermsInclude.Builder,ObjectBuilder<TermsInclude>> fn)	API name: include
final SignificantTextAggregation.Builder	include(TermsInclude value)	API name: include
final SignificantTextAggregation.Builder	jlh(Function<EmptyObject.Builder,ObjectBuilder<EmptyObject>> fn)	API name: jlh
final SignificantTextAggregation.Builder	jlh(EmptyObject value)	API name: jlh
final SignificantTextAggregation.Builder	minDocCount(Long value)	Only return values that are found in more than min_doc_count hits.
final SignificantTextAggregation.Builder	mutualInformation(Function<MutualInformationHeuristic.Builder,ObjectBuilder<MutualInformationHeuristic>> fn)	API name: mutual_information
final SignificantTextAggregation.Builder	mutualInformation(MutualInformationHeuristic value)	API name: mutual_information
final SignificantTextAggregation.Builder	percentage(Function<PercentageScoreHeuristic.Builder,ObjectBuilder<PercentageScoreHeuristic>> fn)	API name: percentage
final SignificantTextAggregation.Builder	percentage(PercentageScoreHeuristic value)	API name: percentage
final SignificantTextAggregation.Builder	scriptHeuristic(Function<ScriptedHeuristic.Builder,ObjectBuilder<ScriptedHeuristic>> fn)	API name: script_heuristic
final SignificantTextAggregation.Builder	scriptHeuristic(ScriptedHeuristic value)	API name: script_heuristic
protected SignificantTextAggregation.Builder	self()
final SignificantTextAggregation.Builder	shardMinDocCount(Long value)	Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count.
final SignificantTextAggregation.Builder	shardSize(Integer value)	The number of candidate terms produced by each shard.
final SignificantTextAggregation.Builder	size(Integer value)	The number of buckets returned out of the overall terms list.
final SignificantTextAggregation.Builder	sourceFields(String value, String... values)	API name: source_fields
final SignificantTextAggregation.Builder	sourceFields(List<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, _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 SignificantTextAggregation.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<SignificantTextAggregation.Builder,SignificantTextAggregation>

Returns:

a new builder instance.

self

@Nonnull
protected SignificantTextAggregation.Builder self()

Specified by:

self in class AggregationBase.AbstractBuilder<SignificantTextAggregation.Builder>

backgroundFilter

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

API name: background_filter

backgroundFilter

@Nonnull
public final SignificantTextAggregation.Builder backgroundFilter(Function<Query.Builder,ObjectBuilder<Query>> fn)

API name: background_filter

chiSquare

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

API name: chi_square

chiSquare

@Nonnull
public final SignificantTextAggregation.Builder chiSquare(Function<ChiSquareHeuristic.Builder,ObjectBuilder<ChiSquareHeuristic>> fn)

API name: chi_square

exclude

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

API name: exclude

exclude

@Nonnull
public final SignificantTextAggregation.Builder exclude(Function<TermsExclude.Builder,ObjectBuilder<TermsExclude>> fn)

API name: exclude

executionHint

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

API name: execution_hint

field

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

API name: field

filterDuplicateText

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

Whether to out duplicate text to deal with noisy data.

API name: filter_duplicate_text

gnd

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

API name: gnd

gnd

@Nonnull
public final SignificantTextAggregation.Builder gnd(Function<GoogleNormalizedDistanceHeuristic.Builder,ObjectBuilder<GoogleNormalizedDistanceHeuristic>> fn)

API name: gnd

include

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

API name: include

include

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

API name: include

jlh

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

API name: jlh

jlh

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

API name: jlh

minDocCount

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

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

API name: min_doc_count

mutualInformation

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

API name: mutual_information

mutualInformation

@Nonnull
public final SignificantTextAggregation.Builder mutualInformation(Function<MutualInformationHeuristic.Builder,ObjectBuilder<MutualInformationHeuristic>> fn)

API name: mutual_information

percentage

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

API name: percentage

percentage

@Nonnull
public final SignificantTextAggregation.Builder percentage(Function<PercentageScoreHeuristic.Builder,ObjectBuilder<PercentageScoreHeuristic>> fn)

API name: percentage

scriptHeuristic

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

API name: script_heuristic

scriptHeuristic

@Nonnull
public final SignificantTextAggregation.Builder scriptHeuristic(Function<ScriptedHeuristic.Builder,ObjectBuilder<ScriptedHeuristic>> fn)

API name: script_heuristic

shardMinDocCount

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

Regulates the certainty a shard has if the values should actually be added to the candidate list or not with respect to the min_doc_count. Values 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 SignificantTextAggregation.Builder shardSize(@Nullable
 Integer value)

The number 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 SignificantTextAggregation.Builder size(@Nullable
 Integer value)

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

API name: size

sourceFields

@Nonnull
public final SignificantTextAggregation.Builder sourceFields(List<String> list)

API name: source_fields

Adds all elements of list to sourceFields.

sourceFields

@Nonnull
public final SignificantTextAggregation.Builder sourceFields(String value,
 String... values)

API name: source_fields

Adds one or more values to sourceFields.

build

@Nonnull
public SignificantTextAggregation build()

Builds a SignificantTextAggregation.

Specified by:

build in interface ObjectBuilder<SignificantTextAggregation>

Throws:

NullPointerException - if some of the required fields are null.