NamedWriteable
, Writeable
, ToXContent
, ToXContentFragment
, BaseAggregationBuilder
, MultiBucketAggregationBuilder
public class SignificantTermsAggregationBuilder extends ValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder> implements MultiBucketAggregationBuilder
AggregationBuilder.CommonFields
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
ValuesSourceAggregationBuilder.LeafOnly<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<VS,AB>>
Writeable.Reader<V>, Writeable.Writer<V>
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
NAME |
metaData
factoriesBuilder, name
EMPTY_PARAMS
config
Modifier | Constructor | Description |
---|---|---|
|
SignificantTermsAggregationBuilder(java.lang.String name,
ValueType valueType) |
|
|
SignificantTermsAggregationBuilder(StreamInput in) |
Read from a Stream.
|
protected |
SignificantTermsAggregationBuilder(SignificantTermsAggregationBuilder clone,
AggregatorFactories.Builder factoriesBuilder,
java.util.Map<java.lang.String,java.lang.Object> metaData) |
Modifier and Type | Method | Description |
---|---|---|
QueryBuilder |
backgroundFilter() |
|
SignificantTermsAggregationBuilder |
backgroundFilter(QueryBuilder backgroundFilter) |
|
TermsAggregator.BucketCountThresholds |
bucketCountThresholds() |
|
SignificantTermsAggregationBuilder |
bucketCountThresholds(TermsAggregator.BucketCountThresholds bucketCountThresholds) |
|
protected XContentBuilder |
doXContentBody(XContentBuilder builder,
ToXContent.Params params) |
|
java.lang.String |
executionHint() |
Expert: gets an execution hint to the aggregation.
|
SignificantTermsAggregationBuilder |
executionHint(java.lang.String executionHint) |
Expert: sets an execution hint to the aggregation.
|
protected TermsAggregator.BucketCountThresholds |
getBucketCountThresholds() |
|
static Aggregator.Parser |
getParser(ParseFieldRegistry<SignificanceHeuristicParser> significanceHeuristicParserRegistry) |
|
java.lang.String |
getType() |
The name of the type of aggregation built by this builder.
|
IncludeExclude |
includeExclude() |
Get terms to include and exclude from the aggregation results
|
SignificantTermsAggregationBuilder |
includeExclude(IncludeExclude includeExclude) |
Set terms to include and exclude from the aggregation results
|
protected ValuesSourceAggregatorFactory<ValuesSource,?> |
innerBuild(SearchContext context,
ValuesSourceConfig<ValuesSource> config,
AggregatorFactory<?> parent,
AggregatorFactories.Builder subFactoriesBuilder) |
|
protected boolean |
innerEquals(java.lang.Object obj) |
|
protected int |
innerHashCode() |
|
protected void |
innerWriteTo(StreamOutput out) |
Write subclass's state to the stream.
|
SignificantTermsAggregationBuilder |
minDocCount(long minDocCount) |
Set the minimum document count terms should have in order to appear in
the response.
|
protected boolean |
serializeTargetValueType() |
Should this builder serialize its targetValueType? Defaults to false.
|
protected AggregationBuilder |
shallowCopy(AggregatorFactories.Builder factoriesBuilder,
java.util.Map<java.lang.String,java.lang.Object> metaData) |
Create a shallow copy of this builder and replacing
AggregationBuilder.factoriesBuilder and metaData . |
SignificantTermsAggregationBuilder |
shardMinDocCount(long shardMinDocCount) |
Set the minimum document count terms should have on the shard in order to
appear in the response.
|
SignificantTermsAggregationBuilder |
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).
|
SignificanceHeuristic |
significanceHeuristic() |
|
SignificantTermsAggregationBuilder |
significanceHeuristic(SignificanceHeuristic significanceHeuristic) |
|
SignificantTermsAggregationBuilder |
size(int size) |
Sets the size - indicating how many term buckets should be returned
(defaults to 10)
|
build, equals, getMetaData, getWriteableName, hashCode, setMetaData, subAggregation, subAggregation, subAggregations, toXContent, writeTo
doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
isFragment
doBuild, doEquals, doHashCode, doWriteTo, field, field, format, format, internalXContent, missing, missing, resolveConfig, script, script, timeZone, timeZone, valueType, valueType
public static final java.lang.String NAME
public SignificantTermsAggregationBuilder(java.lang.String name, ValueType valueType)
public SignificantTermsAggregationBuilder(StreamInput in) throws java.io.IOException
java.io.IOException
protected SignificantTermsAggregationBuilder(SignificantTermsAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)
public static Aggregator.Parser getParser(ParseFieldRegistry<SignificanceHeuristicParser> significanceHeuristicParserRegistry)
protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)
AggregationBuilder
AggregationBuilder.factoriesBuilder
and metaData
.
Used by AggregationBuilder.rewrite(QueryRewriteContext)
.shallowCopy
in class AggregationBuilder
protected void innerWriteTo(StreamOutput out) throws java.io.IOException
ValuesSourceAggregationBuilder
innerWriteTo
in class ValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder>
java.io.IOException
protected boolean serializeTargetValueType()
ValuesSourceAggregationBuilder
protected TermsAggregator.BucketCountThresholds getBucketCountThresholds()
public TermsAggregator.BucketCountThresholds bucketCountThresholds()
public SignificantTermsAggregationBuilder bucketCountThresholds(TermsAggregator.BucketCountThresholds bucketCountThresholds)
public SignificantTermsAggregationBuilder size(int size)
public SignificantTermsAggregationBuilder shardSize(int shardSize)
public SignificantTermsAggregationBuilder minDocCount(long minDocCount)
public SignificantTermsAggregationBuilder shardMinDocCount(long shardMinDocCount)
public SignificantTermsAggregationBuilder executionHint(java.lang.String executionHint)
public java.lang.String executionHint()
public SignificantTermsAggregationBuilder backgroundFilter(QueryBuilder backgroundFilter)
public QueryBuilder backgroundFilter()
public SignificantTermsAggregationBuilder includeExclude(IncludeExclude includeExclude)
public IncludeExclude includeExclude()
public SignificantTermsAggregationBuilder significanceHeuristic(SignificanceHeuristic significanceHeuristic)
public SignificanceHeuristic significanceHeuristic()
protected ValuesSourceAggregatorFactory<ValuesSource,?> innerBuild(SearchContext context, ValuesSourceConfig<ValuesSource> config, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder) throws java.io.IOException
innerBuild
in class ValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder>
java.io.IOException
protected XContentBuilder doXContentBody(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
doXContentBody
in class ValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder>
java.io.IOException
protected int innerHashCode()
innerHashCode
in class ValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder>
protected boolean innerEquals(java.lang.Object obj)
innerEquals
in class ValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder>
public java.lang.String getType()
BaseAggregationBuilder
getType
in interface BaseAggregationBuilder