Class TermsAggregationBuilder
java.lang.Object
org.elasticsearch.search.aggregations.AggregationBuilder
org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB>
org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<TermsAggregationBuilder>
org.elasticsearch.search.aggregations.bucket.terms.TermsAggregationBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentFragment
,Rewriteable<AggregationBuilder>
,BaseAggregationBuilder
public class TermsAggregationBuilder extends ValuesSourceAggregationBuilder<TermsAggregationBuilder>
-
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 org.elasticsearch.common.ParseField
EXECUTION_HINT_FIELD_NAME
static org.elasticsearch.common.ParseField
MIN_DOC_COUNT_FIELD_NAME
static java.lang.String
NAME
static org.elasticsearch.common.ParseField
ORDER_FIELD
static org.elasticsearch.common.xcontent.ObjectParser<TermsAggregationBuilder,java.lang.String>
PARSER
static ValuesSourceRegistry.RegistryKey<org.elasticsearch.search.aggregations.bucket.terms.TermsAggregatorSupplier>
REGISTRY_KEY
static org.elasticsearch.common.ParseField
REQUIRED_SIZE_FIELD_NAME
static org.elasticsearch.common.ParseField
SHARD_MIN_DOC_COUNT_FIELD_NAME
static org.elasticsearch.common.ParseField
SHARD_SIZE_FIELD_NAME
static org.elasticsearch.common.ParseField
SHOW_TERM_DOC_COUNT_ERROR
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 TermsAggregationBuilder(java.lang.String name)
TermsAggregationBuilder(StreamInput in)
Read from a stream.protected
TermsAggregationBuilder(TermsAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata)
-
Method Summary
Modifier and Type Method Description AggregationBuilder.BucketCardinality
bucketCardinality()
A rough count of the number of buckets thatAggregator
s built by this builder will contain per owning parent bucket.Aggregator.SubAggCollectionMode
collectMode()
Expert: get the collection mode.TermsAggregationBuilder
collectMode(Aggregator.SubAggCollectionMode collectMode)
Expert: set the collection mode.protected ValuesSourceType
defaultValueSourceType()
Aggregations should use this method to define aValuesSourceType
of last resort.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.TermsAggregationBuilder
executionHint(java.lang.String executionHint)
Expert: sets an execution hint to the aggregation.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 resultsTermsAggregationBuilder
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.long
minDocCount()
Returns the minimum document count required per termTermsAggregationBuilder
minDocCount(long minDocCount)
Set the minimum document count terms should have in order to appear in the response.BucketOrder
order()
Gets the order in which the buckets will be returned.TermsAggregationBuilder
order(java.util.List<BucketOrder> orders)
Sets the order in which the buckets will be returned.TermsAggregationBuilder
order(BucketOrder order)
Set a new order on this builder and return the builder so that calls can be chained.static void
registerAggregators(ValuesSourceRegistry.Builder builder)
protected boolean
serializeTargetValueType(Version version)
DO NOT OVERRIDE THIS!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
.long
shardMinDocCount()
Returns the minimum document count required per term, per shardTermsAggregationBuilder
shardMinDocCount(long shardMinDocCount)
Set the minimum document count terms should have on the shard in order to appear in the response.int
shardSize()
Returns the number of term buckets per shard that are currently configuredTermsAggregationBuilder
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).boolean
showTermDocCountError()
Get whether doc count error will be return for individual termsTermsAggregationBuilder
showTermDocCountError(boolean showTermDocCountError)
Set whether doc count error will be return for individual termsint
size()
Returns the number of term buckets currently configuredTermsAggregationBuilder
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, doRewrite, 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.TermsAggregatorSupplier> REGISTRY_KEY -
EXECUTION_HINT_FIELD_NAME
public static final org.elasticsearch.common.ParseField EXECUTION_HINT_FIELD_NAME -
SHARD_SIZE_FIELD_NAME
public static final org.elasticsearch.common.ParseField SHARD_SIZE_FIELD_NAME -
MIN_DOC_COUNT_FIELD_NAME
public static final org.elasticsearch.common.ParseField MIN_DOC_COUNT_FIELD_NAME -
SHARD_MIN_DOC_COUNT_FIELD_NAME
public static final org.elasticsearch.common.ParseField SHARD_MIN_DOC_COUNT_FIELD_NAME -
REQUIRED_SIZE_FIELD_NAME
public static final org.elasticsearch.common.ParseField REQUIRED_SIZE_FIELD_NAME -
SHOW_TERM_DOC_COUNT_ERROR
public static final org.elasticsearch.common.ParseField SHOW_TERM_DOC_COUNT_ERROR -
ORDER_FIELD
public static final org.elasticsearch.common.ParseField ORDER_FIELD -
PARSER
public static final org.elasticsearch.common.xcontent.ObjectParser<TermsAggregationBuilder,java.lang.String> PARSER
-
-
Constructor Details
-
TermsAggregationBuilder
public TermsAggregationBuilder(java.lang.String name) -
TermsAggregationBuilder
protected TermsAggregationBuilder(TermsAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metadata) -
TermsAggregationBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
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<TermsAggregationBuilder>
- Returns:
- The CoreValuesSourceType we expect this script to yield.
-
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
-
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<TermsAggregationBuilder>
- Parameters:
version
- For backwards compatibility, subclasses can change behavior based on the version
-
innerWriteTo
Description copied from class:ValuesSourceAggregationBuilder
Write subclass's state to the stream.- Specified by:
innerWriteTo
in classValuesSourceAggregationBuilder<TermsAggregationBuilder>
- Throws:
java.io.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
public java.lang.String 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 -
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<TermsAggregationBuilder>
- 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<TermsAggregationBuilder>
- Throws:
java.io.IOException
-
hashCode
public int hashCode()- Overrides:
hashCode
in classValuesSourceAggregationBuilder<TermsAggregationBuilder>
-
equals
public boolean equals(java.lang.Object obj)- Overrides:
equals
in classValuesSourceAggregationBuilder<TermsAggregationBuilder>
-
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<TermsAggregationBuilder>
-