public class TermsBuilder extends ValuesSourceAggregationBuilder<TermsBuilder>
Terms
aggregation.ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
type
EMPTY_PARAMS
Constructor and Description |
---|
TermsBuilder(String name)
Sole constructor.
|
Modifier and Type | Method and Description |
---|---|
TermsBuilder |
collectMode(Aggregator.SubAggCollectionMode mode)
Expert: set the collection mode.
|
protected XContentBuilder |
doInternalXContent(XContentBuilder builder,
ToXContent.Params params) |
TermsBuilder |
exclude(double[] terms)
Define a set of terms that should not be aggregated.
|
TermsBuilder |
exclude(long[] terms)
Define a set of terms that should not be aggregated.
|
TermsBuilder |
exclude(String regex)
Define a regular expression that will filter out terms that should be excluded from the aggregation.
|
TermsBuilder |
exclude(String[] terms)
Define a set of terms that should not be aggregated.
|
TermsBuilder |
executionHint(String executionHint)
Expert: provide an execution hint to the aggregation.
|
TermsBuilder |
include(double[] terms)
Define a set of terms that should be aggregated.
|
TermsBuilder |
include(long[] terms)
Define a set of terms that should be aggregated.
|
TermsBuilder |
include(String regex)
Define a regular expression that will determine what terms should be aggregated.
|
TermsBuilder |
include(String[] terms)
Define a set of terms that should be aggregated.
|
TermsBuilder |
minDocCount(long minDocCount)
Set the minimum document count terms should have in order to appear in the response.
|
TermsBuilder |
order(Terms.Order order)
Defines the order in which the buckets will be returned.
|
TermsBuilder |
shardMinDocCount(long shardMinDocCount)
Set the minimum document count terms should have on the shard in order to appear in the response.
|
TermsBuilder |
shardSize(int shardSize)
Sets the shard_size - indicating the number of term buckets each shard will return to the coordinating node (the
node that coordinates the search execution).
|
TermsBuilder |
showTermDocCountError(boolean showTermDocCountError)
Expert: return document count errors per term in the response.
|
TermsBuilder |
size(int size)
Sets the size - indicating how many term buckets should be returned (defaults to 10)
|
TermsBuilder |
valueType(Terms.ValueType valueType)
When using scripts, the value type indicates the types of the values the script is generating.
|
field, internalXContent, missing, script
setMetaData, subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, toXContent
getName
public TermsBuilder(String name)
public TermsBuilder size(int size)
public TermsBuilder shardSize(int shardSize)
public TermsBuilder minDocCount(long minDocCount)
public TermsBuilder shardMinDocCount(long shardMinDocCount)
public TermsBuilder include(String regex)
RegExp
class.RegExp.RegExp(String)
public TermsBuilder include(String[] terms)
public TermsBuilder include(long[] terms)
public TermsBuilder include(double[] terms)
public TermsBuilder exclude(String regex)
RegExp
class.RegExp.RegExp(String)
public TermsBuilder exclude(String[] terms)
public TermsBuilder exclude(long[] terms)
public TermsBuilder exclude(double[] terms)
public TermsBuilder valueType(Terms.ValueType valueType)
public TermsBuilder order(Terms.Order order)
public TermsBuilder executionHint(String executionHint)
public TermsBuilder collectMode(Aggregator.SubAggCollectionMode mode)
public TermsBuilder showTermDocCountError(boolean showTermDocCountError)
protected XContentBuilder doInternalXContent(XContentBuilder builder, ToXContent.Params params) throws IOException
doInternalXContent
in class ValuesSourceAggregationBuilder<TermsBuilder>
IOException
Copyright © 2009–2017. All rights reserved.