Package org.elasticsearch.search.aggregations.bucket.terms

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.Params

Nested 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_PARAMS

Constructor Summary

Constructors

Constructor	Description
BucketCountThresholds(long minDocCount, long shardMinDocCount, int requiredSize, int shardSize)
BucketCountThresholds(StreamInput in)	Read from a stream.
BucketCountThresholds(TermsAggregator.BucketCountThresholds bucketCountThresholds)

Method Summary

Modifier and Type	Method	Description
void	ensureValidity()
boolean	equals(Object obj)
long	getMinDocCount()	The minimum numbers of documents a bucket must have in order to survive the final reduction.
int	getRequiredSize()
long	getShardMinDocCount()	The minimum number of documents a bucket must have in order to be returned from a shard.
int	getShardSize()
int	hashCode()
void	setMinDocCount(long minDocCount)
void	setRequiredSize(int requiredSize)
void	setShardMinDocCount(long shardMinDocCount)
void	setShardSize(int shardSize)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Constructor Details

BucketCountThresholds

public BucketCountThresholds(long minDocCount,
 long shardMinDocCount,
 int requiredSize,
 int shardSize)

BucketCountThresholds

public BucketCountThresholds(StreamInput in)
                      throws IOException

Read from a stream.

Throws:

IOException

BucketCountThresholds

public BucketCountThresholds(TermsAggregator.BucketCountThresholds bucketCountThresholds)

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

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:

toXContent in interface ToXContent

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object