public class SignificantTermsBuilder extends AggregationBuilder<SignificantTermsBuilder>
This feature is marked as experimental, and may be subject to change in the future. If you use this feature, please let us know your experience with it!
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
type
EMPTY_PARAMS
Constructor and Description |
---|
SignificantTermsBuilder(String name)
Sole constructor.
|
Modifier and Type | Method and Description |
---|---|
SignificantTermsBuilder |
backgroundFilter(QueryBuilder filter)
Set the background filter to compare to.
|
SignificantTermsBuilder |
exclude(long[] terms)
Define a set of terms that should not be aggregated.
|
SignificantTermsBuilder |
exclude(String regex)
Define a regular expression that will filter out terms that should be excluded from the aggregation.
|
SignificantTermsBuilder |
exclude(String[] terms)
Define a set of terms that should not be aggregated.
|
SignificantTermsBuilder |
exclude(String regex,
int flags)
Define a regular expression that will filter out terms that should be excluded from the aggregation.
|
SignificantTermsBuilder |
executionHint(String executionHint)
Expert: give an execution hint to this aggregation.
|
SignificantTermsBuilder |
field(String field)
Set the field to fetch significant terms from.
|
SignificantTermsBuilder |
include(long[] terms)
Define a set of terms that should be aggregated.
|
SignificantTermsBuilder |
include(String regex)
Define a regular expression that will determine what terms should be aggregated.
|
SignificantTermsBuilder |
include(String[] terms)
Define a set of terms that should be aggregated.
|
SignificantTermsBuilder |
include(String regex,
int flags)
Define a regular expression that will determine what terms should be aggregated.
|
protected XContentBuilder |
internalXContent(XContentBuilder builder,
ToXContent.Params params) |
SignificantTermsBuilder |
minDocCount(int minDocCount)
Only return significant terms that belong to at least
minDocCount documents. |
SignificantTermsBuilder |
shardMinDocCount(int shardMinDocCount)
Expert: set the minimum number of documents that a term should match to
be retrieved from a shard.
|
SignificantTermsBuilder |
shardSize(int shardSize)
Expert: Set the number of significant terms to retrieve on each shard.
|
SignificantTermsBuilder |
significanceHeuristic(SignificanceHeuristicBuilder significanceHeuristicBuilder)
Expert: set the
SignificanceHeuristic to use. |
SignificantTermsBuilder |
size(int requiredSize)
Set the number of significant terms to retrieve.
|
setMetaData, subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, toXContent
getName
public SignificantTermsBuilder(String name)
public SignificantTermsBuilder field(String field)
public SignificantTermsBuilder size(int requiredSize)
public SignificantTermsBuilder shardSize(int shardSize)
public SignificantTermsBuilder minDocCount(int minDocCount)
minDocCount
documents.public SignificantTermsBuilder backgroundFilter(QueryBuilder filter)
public SignificantTermsBuilder shardMinDocCount(int shardMinDocCount)
public SignificantTermsBuilder executionHint(String executionHint)
public SignificantTermsBuilder include(String regex)
Pattern
class.include(String, int)
public SignificantTermsBuilder include(String regex, int flags)
Pattern
class.Pattern.compile(String, int)
public SignificantTermsBuilder include(String[] terms)
public SignificantTermsBuilder include(long[] terms)
public SignificantTermsBuilder exclude(String regex)
Pattern
class.exclude(String, int)
public SignificantTermsBuilder exclude(String regex, int flags)
Pattern
class.Pattern.compile(String, int)
public SignificantTermsBuilder exclude(String[] terms)
public SignificantTermsBuilder exclude(long[] terms)
protected XContentBuilder internalXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
internalXContent
in class AggregationBuilder<SignificantTermsBuilder>
IOException
public SignificantTermsBuilder significanceHeuristic(SignificanceHeuristicBuilder significanceHeuristicBuilder)
SignificanceHeuristic
to use.Copyright © 2009–2017. All rights reserved.