Module org.elasticsearch.server
Class SignificantTermsAggregationBuilder
java.lang.Object
org.elasticsearch.search.aggregations.AggregationBuilder
org.elasticsearch.search.aggregations.AbstractAggregationBuilder<SignificantTermsAggregationBuilder>
org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>
org.elasticsearch.search.aggregations.bucket.terms.SignificantTermsAggregationBuilder
- All Implemented Interfaces:
NamedWriteable,VersionedNamedWriteable,Writeable,Rewriteable<AggregationBuilder>,BaseAggregationBuilder,ToXContent,ToXContentFragment
public class SignificantTermsAggregationBuilder
extends ValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>
-
Nested Class Summary
Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder
ValuesSourceAggregationBuilder.LeafOnly<AB extends ValuesSourceAggregationBuilder<AB>>, ValuesSourceAggregationBuilder.MetricsAggregationBuilder<AB extends ValuesSourceAggregationBuilder<AB>>, ValuesSourceAggregationBuilder.SingleMetricAggregationBuilder<AB extends ValuesSourceAggregationBuilder<AB>>Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFieldsNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringstatic final ValuesSourceRegistry.RegistryKey<org.elasticsearch.search.aggregations.bucket.terms.SignificantTermsAggregatorSupplier> Fields inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
metadataFields inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
DEFAULT_PREALLOCATION, factoriesBuilder, nameFields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDSFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsModifierConstructorDescriptionRead from a Stream.protectedSignificantTermsAggregationBuilder(SignificantTermsAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) -
Method Summary
Modifier and TypeMethodDescriptionbackgroundFilter(QueryBuilder backgroundFilter) A rough count of the number of buckets thatAggregators built by this builder will contain per owning parent bucket.protected ValuesSourceTypeAggregations should use this method to define aValuesSourceTypeof last resort.protected AggregationBuilderdoRewrite(QueryRewriteContext queryRewriteContext) Rewrites this aggregation builder into its primitive form.protected XContentBuilderdoXContentBody(XContentBuilder builder, ToXContent.Params params) booleanexecutionHint(String executionHint) Expert: sets an execution hint to the aggregation.The minimal version of the recipient this object can be sent togetQuery()Return the aggregation's query if it's different from the search query, or null otherwise.getType()The name of the type of aggregation built by this builder.inthashCode()Get terms to include and exclude from the aggregation resultsincludeExclude(IncludeExclude includeExclude) Set terms to include and exclude from the aggregation resultsprotected ValuesSourceAggregatorFactoryinnerBuild(AggregationContext context, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder) protected voidinnerWriteTo(StreamOutput out) Write subclass's state to the stream.minDocCount(long minDocCount) Set the minimum document count terms should have in order to appear in the response.parse(String aggregationName, XContentParser parser) static voidprotected booleanserializeTargetValueType(TransportVersion version) DO NOT OVERRIDE THIS!protected SignificantTermsAggregationBuildershallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) Create a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilderandmetadata.shardMinDocCount(long shardMinDocCount) Set the minimum document count terms should have on the shard in order to appear in the response.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 significanceHeuristic) size(int size) Sets the size - indicating how many term buckets should be returned (defaults to 10)booleansupportsParallelCollection(ToLongFunction<String> fieldCardinalityResolver) Return false if this aggregation or any of the child aggregations does not support parallel collection.booleanDoes this aggregation support running with in a sampling context.Methods inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder
declareFields, declareFields, doBuild, doWriteTo, field, field, format, format, internalXContent, missing, resolveConfig, script, script, timeZone, timeZone, userValueTypeHint, userValueTypeHintMethods inherited from class org.elasticsearch.search.aggregations.AbstractAggregationBuilder
build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, subAggregations, toXContent, writeToMethods inherited from class org.elasticsearch.search.aggregations.AggregationBuilder
buildPipelineTree, bytesToPreallocate, deepCopy, getName, getOutputFieldNames, getPipelineAggregations, getSubAggregations, isInSortOrderExecutionRequired, rewrite, toString, validateSequentiallyOrdered, validateSequentiallyOrderedWithoutGapsMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Field Details
-
NAME
- See Also:
-
REGISTRY_KEY
public static final ValuesSourceRegistry.RegistryKey<org.elasticsearch.search.aggregations.bucket.terms.SignificantTermsAggregatorSupplier> REGISTRY_KEY
-
-
Constructor Details
-
SignificantTermsAggregationBuilder
-
SignificantTermsAggregationBuilder
Read from a Stream.- Throws:
IOException
-
SignificantTermsAggregationBuilder
protected SignificantTermsAggregationBuilder(SignificantTermsAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata)
-
-
Method Details
-
parse
public static SignificantTermsAggregationBuilder parse(String aggregationName, XContentParser parser) throws IOException - Throws:
IOException
-
registerAggregators
-
supportsSampling
public boolean supportsSampling()Description copied from class:AggregationBuilderDoes this aggregation support running with in a sampling context. By default, it's false for all aggregations. If the sub-classed builder supports sampling, be sure of the following that the resulting internal aggregation objects override theInternalAggregation.finalizeSampling(SamplingContext)and scales any values that require scaling.- Overrides:
supportsSamplingin classAggregationBuilder- Returns:
- does this aggregation builder support sampling
-
supportsParallelCollection
Description copied from class:AggregationBuilderReturn false if this aggregation or any of the child aggregations does not support parallel collection. As a result, a request including such aggregation is always executed sequentially despite concurrency is enabled for the query phase.- Overrides:
supportsParallelCollectionin classAggregationBuilder
-
defaultValueSourceType
Description copied from class:ValuesSourceAggregationBuilderAggregations should use this method to define aValuesSourceTypeof 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:
defaultValueSourceTypein classValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>- Returns:
- The CoreValuesSourceType we expect this script to yield.
-
shallowCopy
protected SignificantTermsAggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) Description copied from class:AggregationBuilderCreate a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilderandmetadata.- Specified by:
shallowCopyin classAggregationBuilder
-
doRewrite
Description copied from class:AggregationBuilderRewrites 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:
doRewritein classAggregationBuilder- Throws:
IOException
-
innerWriteTo
Description copied from class:ValuesSourceAggregationBuilderWrite subclass's state to the stream.- Specified by:
innerWriteToin classValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>- Throws:
IOException
-
serializeTargetValueType
Description copied from class:ValuesSourceAggregationBuilderDO NOT OVERRIDE THIS!This method only exists for legacy support. No new aggregations need this, nor should they override it.
- Overrides:
serializeTargetValueTypein classValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>- Parameters:
version- For backwards compatibility, subclasses can change behavior based on the version
-
getBucketCountThresholds
-
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. -
backgroundFilter
-
getQuery
Description copied from class:AggregationBuilderReturn the aggregation's query if it's different from the search query, or null otherwise.- Overrides:
getQueryin classAggregationBuilder
-
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:AggregationBuilderA rough count of the number of buckets thatAggregators built by this builder will contain per owning parent bucket.- Specified by:
bucketCardinalityin classAggregationBuilder
-
innerBuild
protected ValuesSourceAggregatorFactory innerBuild(AggregationContext context, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder) throws IOException - Specified by:
innerBuildin classValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>- Throws:
IOException
-
doXContentBody
protected XContentBuilder doXContentBody(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
doXContentBodyin classValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>- Throws:
IOException
-
hashCode
public int hashCode()- Overrides:
hashCodein classValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>
-
equals
- Overrides:
equalsin classValuesSourceAggregationBuilder<SignificantTermsAggregationBuilder>
-
getType
Description copied from interface:BaseAggregationBuilderThe name of the type of aggregation built by this builder. -
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteableThe minimal version of the recipient this object can be sent to
-