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

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

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

All Implemented Interfaces:

WithJson<SignificantTermsAggregation.Builder>, 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
final SignificantTermsAggregation.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 SignificantTermsAggregation.Builder	backgroundFilter(QueryVariant value)	A background filter that can be used to focus in on significant terms within a narrower context, instead of the entire index.
final SignificantTermsAggregation.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.
SignificantTermsAggregation	build()	Builds a SignificantTermsAggregation.
final SignificantTermsAggregation.Builder	chiSquare(ChiSquareHeuristic value)	Use Chi square, as described in "Information Retrieval", Manning et al., Chapter 13.5.2, as the significance score.
final SignificantTermsAggregation.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 SignificantTermsAggregation.Builder	exclude(TermsExclude value)	Terms to exclude.
final SignificantTermsAggregation.Builder	exclude(Function<TermsExclude.Builder,ObjectBuilder<TermsExclude>> fn)	Terms to exclude.
final SignificantTermsAggregation.Builder	executionHint(TermsAggregationExecutionHint value)	Mechanism by which the aggregation should be executed: using field values directly or using global ordinals.
final SignificantTermsAggregation.Builder	field(String value)	The field from which to return significant terms.
final SignificantTermsAggregation.Builder	gnd(GoogleNormalizedDistanceHeuristic value)	Use Google normalized distance as described in "The Google Similarity Distance", Cilibrasi and Vitanyi, 2007, as the significance score.
final SignificantTermsAggregation.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 SignificantTermsAggregation.Builder	include(TermsInclude value)	Terms to include.
final SignificantTermsAggregation.Builder	include(Function<TermsInclude.Builder,ObjectBuilder<TermsInclude>> fn)	Terms to include.
final SignificantTermsAggregation.Builder	jlh(EmptyObject value)	Use JLH score as the significance score.
final SignificantTermsAggregation.Builder	jlh(Function<EmptyObject.Builder,ObjectBuilder<EmptyObject>> fn)	Use JLH score as the significance score.
final SignificantTermsAggregation.Builder	minDocCount(Long value)	Only return terms that are found in more than min_doc_count hits.
final SignificantTermsAggregation.Builder	mutualInformation(MutualInformationHeuristic value)	Use mutual information as described in "Information Retrieval", Manning et al., Chapter 13.5.1, as the significance score.
final SignificantTermsAggregation.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 SignificantTermsAggregation.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 SignificantTermsAggregation.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 SignificantTermsAggregation.Builder	pValue(PValueHeuristic value)	Significant terms heuristic that calculates the p-value between the term existing in foreground and background sets.
final SignificantTermsAggregation.Builder	pValue(Function<PValueHeuristic.Builder,ObjectBuilder<PValueHeuristic>> fn)	Significant terms heuristic that calculates the p-value between the term existing in foreground and background sets.
final SignificantTermsAggregation.Builder	scriptHeuristic(ScriptedHeuristic value)	Customized score, implemented via a script.
final SignificantTermsAggregation.Builder	scriptHeuristic(Function<ScriptedHeuristic.Builder,ObjectBuilder<ScriptedHeuristic>> fn)	Customized score, implemented via a script.
protected SignificantTermsAggregation.Builder	self()
final SignificantTermsAggregation.Builder	shardMinDocCount(Long value)	Regulates the certainty a shard has if the term should actually be added to the candidate list or not with respect to the min_doc_count.
final SignificantTermsAggregation.Builder	shardSize(Integer value)	Can be used to control the volumes of candidate terms produced by each shard.
final SignificantTermsAggregation.Builder	size(Integer value)	The number of buckets returned out of the overall terms list.

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

backgroundFilter

public final SignificantTermsAggregation.Builder backgroundFilter(QueryVariant 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

chiSquare

public final SignificantTermsAggregation.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 SignificantTermsAggregation.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 SignificantTermsAggregation.Builder exclude(@Nullable
 TermsExclude value)

Terms to exclude.

API name: exclude

exclude

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

Terms to exclude.

API name: exclude

executionHint

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

Mechanism by which the aggregation should be executed: using field values directly or using global ordinals.

API name: execution_hint

field

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

The field from which to return significant terms.

API name: field

gnd

public final SignificantTermsAggregation.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 SignificantTermsAggregation.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 SignificantTermsAggregation.Builder include(@Nullable
 TermsInclude value)

Terms to include.

API name: include

include

public final SignificantTermsAggregation.Builder include(Function<TermsInclude.Builder,ObjectBuilder<TermsInclude>> fn)

Terms to include.

API name: include

jlh

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

Use JLH score as the significance score.

API name: jlh

jlh

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

Use JLH score as the significance score.

API name: jlh

minDocCount

public final SignificantTermsAggregation.Builder minDocCount(@Nullable
 Long value)

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

API name: min_doc_count

mutualInformation

public final SignificantTermsAggregation.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 SignificantTermsAggregation.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 SignificantTermsAggregation.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 SignificantTermsAggregation.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 SignificantTermsAggregation.Builder scriptHeuristic(@Nullable
 ScriptedHeuristic value)

Customized score, implemented via a script.

API name: script_heuristic

scriptHeuristic

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

Customized score, implemented via a script.

API name: script_heuristic

pValue

public final SignificantTermsAggregation.Builder pValue(@Nullable
 PValueHeuristic value)

Significant terms heuristic that calculates the p-value between the term existing in foreground and background sets.

The p-value is the probability of obtaining test results at least as extreme as the results actually observed, under the assumption that the null hypothesis is correct. The p-value is calculated assuming that the foreground set and the background set are independent https://en.wikipedia.org/wiki/Bernoulli_trial, with the null hypothesis that the probabilities are the same.

API name: p_value

pValue

public final SignificantTermsAggregation.Builder pValue(Function<PValueHeuristic.Builder,ObjectBuilder<PValueHeuristic>> fn)

Significant terms heuristic that calculates the p-value between the term existing in foreground and background sets.

The p-value is the probability of obtaining test results at least as extreme as the results actually observed, under the assumption that the null hypothesis is correct. The p-value is calculated assuming that the foreground set and the background set are independent https://en.wikipedia.org/wiki/Bernoulli_trial, with the null hypothesis that the probabilities are the same.

API name: p_value

shardMinDocCount

public final SignificantTermsAggregation.Builder shardMinDocCount(@Nullable
 Long value)

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

Can be used to control the volumes 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 SignificantTermsAggregation.Builder size(@Nullable
 Integer value)

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

API name: size

self

protected SignificantTermsAggregation.Builder self()

Specified by:

self in class BucketAggregationBase.AbstractBuilder<SignificantTermsAggregation.Builder>

build

public SignificantTermsAggregation build()

Builds a SignificantTermsAggregation.

Specified by:

build in interface ObjectBuilder<SignificantTermsAggregation>

Throws:

NullPointerException - if some of the required fields are null.