Module org.elasticsearch.server
Class TermsAggregationBuilder
java.lang.Object
org.elasticsearch.search.aggregations.AggregationBuilder
org.elasticsearch.search.aggregations.AbstractAggregationBuilder<TermsAggregationBuilder>
org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<TermsAggregationBuilder>
org.elasticsearch.search.aggregations.bucket.terms.TermsAggregationBuilder
- All Implemented Interfaces:
NamedWriteable,VersionedNamedWriteable,Writeable,Rewriteable<AggregationBuilder>,BaseAggregationBuilder,ToXContent,ToXContentFragment
public class TermsAggregationBuilder
extends ValuesSourceAggregationBuilder<TermsAggregationBuilder>
-
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 ParseFieldstatic final intstatic final ParseFieldstatic final Stringstatic final ParseFieldstatic final ObjectParser<TermsAggregationBuilder, String> static final ValuesSourceRegistry.RegistryKey<org.elasticsearch.search.aggregations.bucket.terms.TermsAggregatorSupplier> static final ParseFieldstatic final ParseFieldstatic final ParseFieldstatic final ParseFieldFields 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.protectedTermsAggregationBuilder(TermsAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) -
Method Summary
Modifier and TypeMethodDescriptionA rough count of the number of buckets thatAggregators built by this builder will contain per owning parent bucket.Expert: get the collection mode.collectMode(Aggregator.SubAggCollectionMode collectMode) Expert: set the collection mode.protected ValuesSourceTypeAggregations should use this method to define aValuesSourceTypeof last resort.protected XContentBuilderdoXContentBody(XContentBuilder builder, ToXContent.Params params) booleanbooleanexcludeDeletedDocs(boolean excludeDeletedDocs) Set whether deleted documents should be explicitly excluded from the aggregation resultsExpert: gets an execution hint to the aggregation.executionHint(String executionHint) Expert: sets an execution hint to the aggregation.The minimal version of the recipient this object can be sent to.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.longReturns the minimum document count required per termminDocCount(long minDocCount) Set the minimum document count terms should have in order to appear in the response.order()Gets the order in which the buckets will be returned.order(List<BucketOrder> orders) Sets the order in which the buckets will be returned.order(BucketOrder order) Set a new order on this builder and return the builder so that calls can be chained.static voidprotected booleanserializeTargetValueType(TransportVersion version) DO NOT OVERRIDE THIS!protected AggregationBuildershallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) Create a shallow copy of this builder and replacingAggregationBuilder.factoriesBuilderandmetadata.longReturns the minimum document count required per term, per shardshardMinDocCount(long shardMinDocCount) Set the minimum document count terms should have on the shard in order to appear in the response.intReturns the number of term buckets per shard that are currently configuredshardSize(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).booleanGet whether doc count error will be return for individual termsshowTermDocCountError(boolean showTermDocCountError) Set whether doc count error will be return for individual termsintsize()Returns the number of term buckets currently configuredsize(int size) Sets the size - indicating how many term buckets should be returned (defaults to 10)static booleansupportsParallelCollection(long cardinality, BucketOrder order, TermsAggregator.BucketCountThresholds bucketCountThresholds) Whether a terms aggregation with the provided order and bucket count thresholds against a field with the given cardinality should be executed concurrency.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, doRewrite, getName, getOutputFieldNames, getPipelineAggregations, getQuery, 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
isFragmentMethods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable
supportsVersion
-
Field Details
-
KEY_ORDER_CONCURRENCY_THRESHOLD
public static final int KEY_ORDER_CONCURRENCY_THRESHOLD- See Also:
-
NAME
- See Also:
-
REGISTRY_KEY
public static final ValuesSourceRegistry.RegistryKey<org.elasticsearch.search.aggregations.bucket.terms.TermsAggregatorSupplier> REGISTRY_KEY -
EXECUTION_HINT_FIELD_NAME
-
SHARD_SIZE_FIELD_NAME
-
MIN_DOC_COUNT_FIELD_NAME
-
SHARD_MIN_DOC_COUNT_FIELD_NAME
-
REQUIRED_SIZE_FIELD_NAME
-
SHOW_TERM_DOC_COUNT_ERROR
-
ORDER_FIELD
-
PARSER
-
-
Constructor Details
-
TermsAggregationBuilder
-
TermsAggregationBuilder
protected TermsAggregationBuilder(TermsAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) -
TermsAggregationBuilder
Read from a stream.- Throws:
IOException
-
-
Method Details
-
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
-
supportsParallelCollection
public static boolean supportsParallelCollection(long cardinality, BucketOrder order, TermsAggregator.BucketCountThresholds bucketCountThresholds) Whether a terms aggregation with the provided order and bucket count thresholds against a field with the given cardinality should be executed concurrency. -
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<TermsAggregationBuilder>- Returns:
- The CoreValuesSourceType we expect this script to yield.
-
shallowCopy
protected AggregationBuilder 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
-
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<TermsAggregationBuilder>- Parameters:
version- For backwards compatibility, subclasses can change behavior based on the version
-
innerWriteTo
Description copied from class:ValuesSourceAggregationBuilderWrite subclass's state to the stream.- Specified by:
innerWriteToin classValuesSourceAggregationBuilder<TermsAggregationBuilder>- Throws:
IOException
-
size
Sets the size - indicating how many term buckets should be returned (defaults to 10) -
size
public int size()Returns the number of term buckets currently configured -
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. -
shardSize
public int shardSize()Returns the number of term buckets per shard that are currently configured -
minDocCount
Set the minimum document count terms should have in order to appear in the response. -
minDocCount
public long minDocCount()Returns the minimum document count required per term -
shardMinDocCount
Set the minimum document count terms should have on the shard in order to appear in the response. -
shardMinDocCount
public long shardMinDocCount()Returns the minimum document count required per term, per shard -
order
Set a new order on this builder and return the builder so that calls can be chained. A tie-breaker may be added to avoid non-deterministic ordering. -
order
Sets the order in which the buckets will be returned. A tie-breaker may be added to avoid non-deterministic ordering. -
order
Gets the order in which the buckets will be returned. -
executionHint
Expert: sets an execution hint to the aggregation. -
executionHint
Expert: gets an execution hint to the aggregation. -
collectMode
Expert: set the collection mode. -
collectMode
Expert: get the collection mode. -
includeExclude
Set terms to include and exclude from the aggregation results -
includeExclude
Get terms to include and exclude from the aggregation results -
showTermDocCountError
public boolean showTermDocCountError()Get whether doc count error will be return for individual terms -
showTermDocCountError
Set whether doc count error will be return for individual terms -
excludeDeletedDocs
Set whether deleted documents should be explicitly excluded from the aggregation results -
excludeDeletedDocs
public boolean excludeDeletedDocs() -
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<TermsAggregationBuilder>- Throws:
IOException
-
doXContentBody
protected XContentBuilder doXContentBody(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
doXContentBodyin classValuesSourceAggregationBuilder<TermsAggregationBuilder>- Throws:
IOException
-
hashCode
public int hashCode()- Overrides:
hashCodein classValuesSourceAggregationBuilder<TermsAggregationBuilder>
-
equals
- Overrides:
equalsin classValuesSourceAggregationBuilder<TermsAggregationBuilder>
-
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. SeeVersionedNamedWriteable.supportsVersion(TransportVersion)for the default serialization check.
-