Class SignificantTermsAggregationBuilder
java.lang.Object
org.elasticsearch.search.aggregations.AggregationBuilder
org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB>
org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>
org.elasticsearch.search.aggregations.bucket.terms.SignificantTermsAggregationBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentFragment
,Rewriteable<AggregationBuilder>
,BaseAggregationBuilder
public class SignificantTermsAggregationBuilder extends ValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder
ValuesSourceAggregationBuilder.LeafOnly<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<AB>>
Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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
static ValuesSourceRegistry.RegistryKey<org.elasticsearch.search.aggregations.bucket.terms.SignificantTermsAggregatorSupplier>
REGISTRY_KEY
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
DEFAULT_PREALLOCATION, factoriesBuilder, name
Fields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDS
Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
Constructors Modifier Constructor Description SignificantTermsAggregationBuilder(java.lang.String name)
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)
AggregationBuilder.BucketCardinality
bucketCardinality()
A rough count of the number of buckets thatAggregator
s built by this builder will contain per owning parent bucket.TermsAggregator.BucketCountThresholds
bucketCountThresholds()
SignificantTermsAggregationBuilder
bucketCountThresholds(TermsAggregator.BucketCountThresholds bucketCountThresholds)
protected ValuesSourceType
defaultValueSourceType()
Aggregations should use this method to define aValuesSourceType
of last resort.protected AggregationBuilder
doRewrite(QueryRewriteContext queryRewriteContext)
Rewrites this aggregation builder into its primitive form.protected org.elasticsearch.common.xcontent.XContentBuilder
doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
boolean
equals(java.lang.Object obj)
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()
protected ValuesSourceRegistry.RegistryKey<?>
getRegistryKey()
java.lang.String
getType()
The name of the type of aggregation built by this builder.int
hashCode()
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
innerBuild(AggregationContext context, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
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.static SignificantTermsAggregationBuilder
parse(java.lang.String aggregationName, org.elasticsearch.common.xcontent.XContentParser parser)
static void
registerAggregators(ValuesSourceRegistry.Builder builder)
protected boolean
serializeTargetValueType(Version version)
DO NOT OVERRIDE THIS!protected SignificantTermsAggregationBuilder
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
declareFields, declareFields, doBuild, doWriteTo, field, field, format, format, internalXContent, missing, missing, resolveConfig, script, script, timeZone, timeZone, userValueTypeHint, userValueTypeHint
Methods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, subAggregations, toXContent, writeTo
Methods inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
buildPipelineTree, bytesToPreallocate, getName, getOutputFieldNames, 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 Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
REGISTRY_KEY
public static final ValuesSourceRegistry.RegistryKey<org.elasticsearch.search.aggregations.bucket.terms.SignificantTermsAggregatorSupplier> REGISTRY_KEY
-
-
Constructor Details
-
SignificantTermsAggregationBuilder
public SignificantTermsAggregationBuilder(java.lang.String name) -
SignificantTermsAggregationBuilder
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 Details
-
parse
public static SignificantTermsAggregationBuilder parse(java.lang.String aggregationName, org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-
registerAggregators
-
defaultValueSourceType
Description copied from class:ValuesSourceAggregationBuilder
Aggregations should use this method to define aValuesSourceType
of last resort. This will only be used when the resolver can't find a field and the user hasn't provided a value type hint.- Specified by:
defaultValueSourceType
in classValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>
- Returns:
- The CoreValuesSourceType we expect this script to yield.
-
shallowCopy
protected SignificantTermsAggregationBuilder 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
-
doRewrite
protected AggregationBuilder doRewrite(QueryRewriteContext queryRewriteContext) throws java.io.IOExceptionDescription copied from class:AggregationBuilder
Rewrites this aggregation builder into its primitive form. By default this method return the builder itself. If the builder did not change the identity reference must be returned otherwise the builder will be rewritten infinitely.- Overrides:
doRewrite
in classAggregationBuilder
- Throws:
java.io.IOException
-
innerWriteTo
Description copied from class:ValuesSourceAggregationBuilder
Write subclass's state to the stream.- Specified by:
innerWriteTo
in classValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>
- Throws:
java.io.IOException
-
serializeTargetValueType
Description copied from class:ValuesSourceAggregationBuilder
DO NOT OVERRIDE THIS!This method only exists for legacy support. No new aggregations need this, nor should they override it.
- Overrides:
serializeTargetValueType
in classValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>
- Parameters:
version
- For backwards compatibility, subclasses can change behavior based on the version
-
getBucketCountThresholds
-
bucketCountThresholds
-
bucketCountThresholds
public SignificantTermsAggregationBuilder bucketCountThresholds(TermsAggregator.BucketCountThresholds bucketCountThresholds) -
size
Sets the size - indicating how many term buckets should be returned (defaults to 10) -
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
Set the minimum document count terms should have in order to appear in the response. -
shardMinDocCount
Set the minimum document count terms should have on the shard in order to appear in the response. -
executionHint
Expert: sets an execution hint to the aggregation. -
executionHint
public java.lang.String executionHint()Expert: gets an execution hint to the aggregation. -
backgroundFilter
-
backgroundFilter
-
includeExclude
Set terms to include and exclude from the aggregation results -
includeExclude
Get terms to include and exclude from the aggregation results -
significanceHeuristic
public SignificantTermsAggregationBuilder significanceHeuristic(SignificanceHeuristic significanceHeuristic) -
significanceHeuristic
-
bucketCardinality
Description copied from class:AggregationBuilder
A rough count of the number of buckets thatAggregator
s built by this builder will contain per owning parent bucket.- Specified by:
bucketCardinality
in classAggregationBuilder
-
innerBuild
protected ValuesSourceAggregatorFactory innerBuild(AggregationContext context, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder) throws java.io.IOException- Specified by:
innerBuild
in classValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>
- Throws:
java.io.IOException
-
doXContentBody
protected org.elasticsearch.common.xcontent.XContentBuilder doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
doXContentBody
in classValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>
- Throws:
java.io.IOException
-
hashCode
public int hashCode()- Overrides:
hashCode
in classValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>
-
getType
public java.lang.String getType()Description copied from interface:BaseAggregationBuilder
The name of the type of aggregation built by this builder. -
getRegistryKey
- Specified by:
getRegistryKey
in classValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>
-