Class SignificantTermsAggregationBuilder
- java.lang.Object
-
- org.elasticsearch.search.aggregations.AggregationBuilder
-
- org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB>
-
- org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder>
-
- org.elasticsearch.search.aggregations.bucket.significant.SignificantTermsAggregationBuilder
-
- All Implemented Interfaces:
NamedWriteable
,Writeable
,ToXContent
,ToXContentFragment
,BaseAggregationBuilder
,MultiBucketAggregationBuilder
public class SignificantTermsAggregationBuilder extends ValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder> implements MultiBucketAggregationBuilder
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder
ValuesSourceAggregationBuilder.LeafOnly<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<VS,AB>>
-
Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
AggregationBuilder.CommonFields
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
-
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
NAME
-
Fields inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder
config
-
Fields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
metaData
-
Fields inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
factoriesBuilder, name
-
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
-
Constructor Summary
Constructors 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)
-
Method Summary
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 resultsSignificantTermsAggregationBuilder
includeExclude(IncludeExclude includeExclude)
Set terms to include and exclude from the aggregation resultsprotected 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 replacingAggregationBuilder.factoriesBuilder
andmetaData
.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)-
Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder
doBuild, doEquals, doHashCode, doWriteTo, field, field, format, format, internalXContent, missing, missing, resolveConfig, script, script, timeZone, timeZone, valueType, valueType
-
Methods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
build, equals, getMetaData, getWriteableName, hashCode, setMetaData, subAggregation, subAggregation, subAggregations, toXContent, writeTo
-
Methods inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, toString
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment
isFragment
-
-
-
-
Field Detail
-
NAME
public static final java.lang.String NAME
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
SignificantTermsAggregationBuilder
public SignificantTermsAggregationBuilder(java.lang.String name, ValueType valueType)
-
SignificantTermsAggregationBuilder
public SignificantTermsAggregationBuilder(StreamInput in) throws java.io.IOException
Read from a Stream.- Throws:
java.io.IOException
-
SignificantTermsAggregationBuilder
protected SignificantTermsAggregationBuilder(SignificantTermsAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)
-
-
Method Detail
-
getParser
public static Aggregator.Parser getParser(ParseFieldRegistry<SignificanceHeuristicParser> significanceHeuristicParserRegistry)
-
shallowCopy
protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)
Description copied from class:AggregationBuilder
Create a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilder
andmetaData
. Used byAggregationBuilder.rewrite(QueryRewriteContext)
.- Specified by:
shallowCopy
in classAggregationBuilder
-
innerWriteTo
protected void innerWriteTo(StreamOutput out) throws java.io.IOException
Description copied from class:ValuesSourceAggregationBuilder
Write subclass's state to the stream.- Specified by:
innerWriteTo
in classValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder>
- Throws:
java.io.IOException
-
serializeTargetValueType
protected boolean serializeTargetValueType()
Description copied from class:ValuesSourceAggregationBuilder
Should this builder serialize its targetValueType? Defaults to false. All subclasses that override this to true should use the three argument read constructor rather than the four argument version.- Overrides:
serializeTargetValueType
in classValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder>
-
getBucketCountThresholds
protected TermsAggregator.BucketCountThresholds getBucketCountThresholds()
-
bucketCountThresholds
public TermsAggregator.BucketCountThresholds bucketCountThresholds()
-
bucketCountThresholds
public SignificantTermsAggregationBuilder bucketCountThresholds(TermsAggregator.BucketCountThresholds bucketCountThresholds)
-
size
public SignificantTermsAggregationBuilder size(int size)
Sets the size - indicating how many term buckets should be returned (defaults to 10)
-
shardSize
public 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). The higher the shard size is, the more accurate the results are.
-
minDocCount
public SignificantTermsAggregationBuilder minDocCount(long minDocCount)
Set the minimum document count terms should have in order to appear in the response.
-
shardMinDocCount
public SignificantTermsAggregationBuilder shardMinDocCount(long shardMinDocCount)
Set the minimum document count terms should have on the shard in order to appear in the response.
-
executionHint
public SignificantTermsAggregationBuilder executionHint(java.lang.String executionHint)
Expert: sets an execution hint to the aggregation.
-
executionHint
public java.lang.String executionHint()
Expert: gets an execution hint to the aggregation.
-
backgroundFilter
public SignificantTermsAggregationBuilder backgroundFilter(QueryBuilder backgroundFilter)
-
backgroundFilter
public QueryBuilder backgroundFilter()
-
includeExclude
public SignificantTermsAggregationBuilder includeExclude(IncludeExclude includeExclude)
Set terms to include and exclude from the aggregation results
-
includeExclude
public IncludeExclude includeExclude()
Get terms to include and exclude from the aggregation results
-
significanceHeuristic
public SignificantTermsAggregationBuilder significanceHeuristic(SignificanceHeuristic significanceHeuristic)
-
significanceHeuristic
public SignificanceHeuristic significanceHeuristic()
-
innerBuild
protected ValuesSourceAggregatorFactory<ValuesSource,?> innerBuild(SearchContext context, ValuesSourceConfig<ValuesSource> config, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder) throws java.io.IOException
- Specified by:
innerBuild
in classValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder>
- Throws:
java.io.IOException
-
doXContentBody
protected XContentBuilder doXContentBody(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
- Specified by:
doXContentBody
in classValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder>
- Throws:
java.io.IOException
-
innerHashCode
protected int innerHashCode()
- Specified by:
innerHashCode
in classValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder>
-
innerEquals
protected boolean innerEquals(java.lang.Object obj)
- Specified by:
innerEquals
in classValuesSourceAggregationBuilder<ValuesSource,SignificantTermsAggregationBuilder>
-
getType
public java.lang.String getType()
Description copied from interface:BaseAggregationBuilder
The name of the type of aggregation built by this builder.- Specified by:
getType
in interfaceBaseAggregationBuilder
-
-