Module org.elasticsearch.server
Class TermsAggregator.BucketCountThresholds
java.lang.Object
org.elasticsearch.search.aggregations.bucket.terms.TermsAggregator.BucketCountThresholds
- All Implemented Interfaces:
Writeable,ToXContent,ToXContentFragment
- Enclosing class:
TermsAggregator
public static class TermsAggregator.BucketCountThresholds
extends Object
implements Writeable, ToXContentFragment
-
Nested Class Summary
Nested 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
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionBucketCountThresholds(long minDocCount, long shardMinDocCount, int requiredSize, int shardSize) Read from a stream.BucketCountThresholds(TermsAggregator.BucketCountThresholds bucketCountThresholds) BucketCountThresholds(TermsAggregator.ConstantBucketCountThresholds bucketCountThresholds) -
Method Summary
Modifier and TypeMethodDescriptionvoidbooleanlongThe minimum numbers of documents a bucket must have in order to survive the final reduction.intlongThe minimum number of documents a bucket must have in order to be returned from a shard.intinthashCode()voidsetMinDocCount(long minDocCount) voidsetRequiredSize(int requiredSize) voidsetShardMinDocCount(long shardMinDocCount) voidsetShardSize(int shardSize) toXContent(XContentBuilder builder, ToXContent.Params params) voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Constructor Details
-
BucketCountThresholds
public BucketCountThresholds(long minDocCount, long shardMinDocCount, int requiredSize, int shardSize) -
BucketCountThresholds
Read from a stream.- Throws:
IOException
-
BucketCountThresholds
-
BucketCountThresholds
-
-
Method Details
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
ensureValidity
public void ensureValidity() -
getShardMinDocCount
public long getShardMinDocCount()The minimum number of documents a bucket must have in order to be returned from a shard.Important: The default for this is 0, but we should only return 0 document buckets if
getMinDocCount()is *also* 0. -
setShardMinDocCount
public void setShardMinDocCount(long shardMinDocCount) -
getMinDocCount
public long getMinDocCount()The minimum numbers of documents a bucket must have in order to survive the final reduction. -
setMinDocCount
public void setMinDocCount(long minDocCount) -
getRequiredSize
public int getRequiredSize() -
setRequiredSize
public void setRequiredSize(int requiredSize) -
getShardSize
public int getShardSize() -
setShardSize
public void setShardSize(int shardSize) -
toXContent
public XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
hashCode
public int hashCode() -
equals
-