Module org.elasticsearch.server
Class UnmappedRareTerms
java.lang.Object
org.elasticsearch.search.aggregations.InternalAggregation
org.elasticsearch.search.aggregations.InternalMultiBucketAggregation<UnmappedRareTerms,UnmappedRareTerms.Bucket>
org.elasticsearch.search.aggregations.bucket.terms.InternalRareTerms<UnmappedRareTerms,UnmappedRareTerms.Bucket>
org.elasticsearch.search.aggregations.bucket.terms.UnmappedRareTerms
- All Implemented Interfaces:
NamedWriteable,Writeable,Aggregation,MultiBucketsAggregation,RareTerms,ToXContent,ToXContentFragment
public class UnmappedRareTerms
extends InternalRareTerms<UnmappedRareTerms,UnmappedRareTerms.Bucket>
Result of the RareTerms aggregation when the field is unmapped.
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class org.elasticsearch.search.aggregations.InternalMultiBucketAggregation
InternalMultiBucketAggregation.BucketAggregationList<B extends MultiBucketsAggregation.Bucket>, InternalMultiBucketAggregation.InternalBucket, InternalMultiBucketAggregation.InternalBucketWritableNested classes/interfaces inherited from interface org.elasticsearch.search.aggregations.Aggregation
Aggregation.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
FieldsFields inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalRareTerms
maxDocCount, orderFields inherited from class org.elasticsearch.search.aggregations.InternalMultiBucketAggregation
REPORT_EMPTY_EVERYFields inherited from class org.elasticsearch.search.aggregations.InternalAggregation
metadata, nameFields inherited from interface org.elasticsearch.search.aggregations.Aggregation
TYPED_KEYS_DELIMITERFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanReturn true if this aggregation can lead a reduction (ie, is not unmapped or empty).create(List<UnmappedRareTerms.Bucket> buckets) Create a new copy of thisAggregationwith the same settings as thisAggregationand contains the provided buckets.createBucket(InternalAggregations aggregations, UnmappedRareTerms.Bucket prototype) Create a newInternalMultiBucketAggregation.InternalBucketusing the provided prototype bucket and aggregations.protected UnmappedRareTermscreateWithFilter(String name, List<UnmappedRareTerms.Bucket> buckets, SetBackedScalingCuckooFilter filter) final XContentBuilderdoXContentBody(XContentBuilder builder, ToXContent.Params params) finalizeSampling(SamplingContext samplingContext) Called by the parent sampling context.Return the sorted list of the buckets in this terms aggregation.protected AggregatorReducergetLeaderReducer(AggregationReduceContext reduceContext, int size) Return an object that Reduces several aggregations to a single one.getType()Returns the name of the writeable objectprotected voidMethods inherited from class org.elasticsearch.search.aggregations.bucket.terms.InternalRareTerms
doWriteTo, doXContentCommon, equals, hashCodeMethods inherited from class org.elasticsearch.search.aggregations.InternalMultiBucketAggregation
copyWithRewritenBuckets, countInnerBucket, countInnerBucket, forEachBucket, getProperty, mustReduceOnSingleInternalAgg, reducePipelinesMethods inherited from class org.elasticsearch.search.aggregations.InternalAggregation
getMetadata, getName, getProperty, getReducer, readSize, sortValue, sortValue, toString, toXContent, writeSize, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.search.aggregations.Aggregation
getMetadata, getNameMethods inherited from interface org.elasticsearch.xcontent.ToXContent
toXContentMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Field Details
-
NAME
- See Also:
-
-
Constructor Details
-
UnmappedRareTerms
Read from a stream.- Throws:
IOException
-
-
Method Details
-
getLeaderReducer
Description copied from class:InternalAggregationReturn an object that Reduces several aggregations to a single one. This method is called whenInternalAggregation.canLeadReduction()returns true and expects an reducer that produces the right result.- Specified by:
getLeaderReducerin classInternalAggregation
-
writeTermTypeInfoTo
- Specified by:
writeTermTypeInfoToin classInternalRareTerms<UnmappedRareTerms,UnmappedRareTerms.Bucket> - Throws:
IOException
-
getWriteableName
Description copied from interface:NamedWriteableReturns the name of the writeable object -
getType
- Specified by:
getTypein interfaceAggregation- Overrides:
getTypein classInternalAggregation- Returns:
- a string representing the type of the aggregation. This type is added to the aggregation name in the response, so that it can later be used by clients to determine type of the aggregation and parse it into the proper object.
-
create
Description copied from class:InternalMultiBucketAggregationCreate a new copy of thisAggregationwith the same settings as thisAggregationand contains the provided buckets.- Specified by:
createin classInternalMultiBucketAggregation<UnmappedRareTerms,UnmappedRareTerms.Bucket> - Parameters:
buckets- the buckets to use in the newAggregation- Returns:
- the new
Aggregation
-
createBucket
public UnmappedRareTerms.Bucket createBucket(InternalAggregations aggregations, UnmappedRareTerms.Bucket prototype) Description copied from class:InternalMultiBucketAggregationCreate a newInternalMultiBucketAggregation.InternalBucketusing the provided prototype bucket and aggregations.- Specified by:
createBucketin classInternalMultiBucketAggregation<UnmappedRareTerms,UnmappedRareTerms.Bucket> - Parameters:
aggregations- the aggregations for the new bucketprototype- the bucket to use as a prototype- Returns:
- the new bucket
-
createWithFilter
protected UnmappedRareTerms createWithFilter(String name, List<UnmappedRareTerms.Bucket> buckets, SetBackedScalingCuckooFilter filter) - Specified by:
createWithFilterin classInternalRareTerms<UnmappedRareTerms,UnmappedRareTerms.Bucket>
-
finalizeSampling
Description copied from class:InternalAggregationCalled by the parent sampling context. Should only ever be called once as some aggregations scale their internal values- Overrides:
finalizeSamplingin classInternalAggregation- Parameters:
samplingContext- the current sampling context- Returns:
- new aggregation with the sampling context applied, could be the same aggregation instance if nothing needs to be done
-
canLeadReduction
public boolean canLeadReduction()Description copied from class:InternalAggregationReturn true if this aggregation can lead a reduction (ie, is not unmapped or empty). If this agg returns false, it should return itself if asked to lead a reduction.- Overrides:
canLeadReductionin classInternalAggregation
-
doXContentBody
public final XContentBuilder doXContentBody(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
doXContentBodyin classInternalAggregation- Throws:
IOException
-
getBuckets
Description copied from interface:RareTermsReturn the sorted list of the buckets in this terms aggregation.- Specified by:
getBucketsin interfaceMultiBucketsAggregation- Specified by:
getBucketsin interfaceRareTerms- Specified by:
getBucketsin classInternalRareTerms<UnmappedRareTerms,UnmappedRareTerms.Bucket> - Returns:
- The buckets of this aggregation.
-