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

Class SignificantTextAggregation.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

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

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

co.elastic.clients.elasticsearch._types.aggregations.SignificantTextAggregation.Builder

All Implemented Interfaces:

WithJson<SignificantTextAggregation.Builder>, 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
final SignificantTextAggregation.Builder	backgroundFilter(Query value)	A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.
final SignificantTextAggregation.Builder	backgroundFilter(Function<Query.Builder,ObjectBuilder<Query>> fn)	A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.
SignificantTextAggregation	build()	Builds a SignificantTextAggregation.
final SignificantTextAggregation.Builder	chiSquare(ChiSquareHeuristic value)	Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score.
final SignificantTextAggregation.Builder	chiSquare(Function<ChiSquareHeuristic.Builder,ObjectBuilder<ChiSquareHeuristic>> fn)	Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score.
final SignificantTextAggregation.Builder	exclude(TermsExclude value)	Values to exclude.
final SignificantTextAggregation.Builder	exclude(Function<TermsExclude.Builder,ObjectBuilder<TermsExclude>> fn)	Values to exclude.
final SignificantTextAggregation.Builder	executionHint(TermsAggregationExecutionHint value)	Determines whether the aggregation will use field values directly or global ordinals.
final SignificantTextAggregation.Builder	field(String value)	The field from which to return significant text.
final SignificantTextAggregation.Builder	filterDuplicateText(Boolean value)	Whether to out duplicate text to deal with noisy data.
final SignificantTextAggregation.Builder	gnd(GoogleNormalizedDistanceHeuristic value)	Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score.
final SignificantTextAggregation.Builder	gnd(Function<GoogleNormalizedDistanceHeuristic.Builder,ObjectBuilder<GoogleNormalizedDistanceHeuristic>> fn)	Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score.
final SignificantTextAggregation.Builder	include(String value, String... values)	Values to include.
final SignificantTextAggregation.Builder	include(List<String> list)	Values to include.
final SignificantTextAggregation.Builder	jlh(EmptyObject value)	Use JLH score as the significance score.
final SignificantTextAggregation.Builder	jlh(Function<EmptyObject.Builder,ObjectBuilder<EmptyObject>> fn)	Use JLH score as the significance score.
final SignificantTextAggregation.Builder	minDocCount(Long value)	Only return values that are found in more than min_doc_count hits.
final SignificantTextAggregation.Builder	mutualInformation(MutualInformationHeuristic value)	Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score.
final SignificantTextAggregation.Builder	mutualInformation(Function<MutualInformationHeuristic.Builder,ObjectBuilder<MutualInformationHeuristic>> fn)	Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score.
final SignificantTextAggregation.Builder	percentage(PercentageScoreHeuristic value)	A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term.
final SignificantTextAggregation.Builder	percentage(Function<PercentageScoreHeuristic.Builder,ObjectBuilder<PercentageScoreHeuristic>> fn)	A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term.
final SignificantTextAggregation.Builder	scriptHeuristic(ScriptedHeuristic value)	Customized score, implemented via a script.
final SignificantTextAggregation.Builder	scriptHeuristic(Function<ScriptedHeuristic.Builder,ObjectBuilder<ScriptedHeuristic>> fn)	Customized score, implemented via a script.
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)	Overrides the JSON _source fields from which text will be analyzed.
final SignificantTextAggregation.Builder	sourceFields(List<String> list)	Overrides the JSON _source fields from which text will be analyzed.

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

meta, meta, name

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

backgroundFilter

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

A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.

API name: background_filter

backgroundFilter

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

A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.

API name: background_filter

chiSquare

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

Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score.

API name: chi_square

chiSquare

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

Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score.

API name: chi_square

exclude

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

Values to exclude.

API name: exclude

exclude

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

Values to exclude.

API name: exclude

executionHint

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

Determines whether the aggregation will use field values directly or global ordinals.

API name: execution_hint

field

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

The field from which to return significant text.

API name: field

filterDuplicateText

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

Whether to out duplicate text to deal with noisy data.

API name: filter_duplicate_text

gnd

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

Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score.

API name: gnd

gnd

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

Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score.

API name: gnd

include

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

Values to include.

API name: include

Adds all elements of list to include.

include

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

Values to include.

API name: include

Adds one or more values to include.

jlh

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

Use JLH score as the significance score.

API name: jlh

jlh

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

Use JLH score as the significance score.

API name: jlh

minDocCount

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

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

Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score.

API name: mutual_information

mutualInformation

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

Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score.

API name: mutual_information

percentage

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

A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term.

API name: percentage

percentage

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

A simple calculation of the number of documents in the foreground sample with a term divided by the number of documents in the background with the term.

API name: percentage

scriptHeuristic

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

Customized score, implemented via a script.

API name: script_heuristic

scriptHeuristic

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

Customized score, implemented via a script.

API name: script_heuristic

shardMinDocCount

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

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

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

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

API name: size

sourceFields

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

Overrides the JSON _source fields from which text will be analyzed.

API name: source_fields

Adds all elements of list to sourceFields.

sourceFields

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

Overrides the JSON _source fields from which text will be analyzed.

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:

NullPointerException - if some of the required fields are null.