org.elasticsearch.search.aggregations.bucket.sampler

Class SamplerAggregatorBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.search.aggregations.AggregatorBuilder<SamplerAggregatorBuilder>

org.elasticsearch.search.aggregations.bucket.sampler.SamplerAggregatorBuilder

All Implemented Interfaces:

NamedWriteable<SamplerAggregatorBuilder>, StreamableReader<SamplerAggregatorBuilder>, Writeable<SamplerAggregatorBuilder>, ToXContent

public class SamplerAggregatorBuilder
extends AggregatorBuilder<SamplerAggregatorBuilder>

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<R>

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_SHARD_SAMPLE_SIZE

Fields inherited from class org.elasticsearch.search.aggregations.AggregatorBuilder

factoriesBuilder, metaData, name, type

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
SamplerAggregatorBuilder(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
protected SamplerAggregatorFactory	doBuild(AggregationContext context, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder)
protected boolean	doEquals(java.lang.Object obj)
protected int	doHashCode()
protected SamplerAggregatorBuilder	doReadFrom(java.lang.String name, StreamInput in)
protected void	doWriteTo(StreamOutput out)
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
int	shardSize() Get the max num docs to be returned from each shard.
SamplerAggregatorBuilder	shardSize(int shardSize) Set the max num docs to be returned from each shard.

Methods inherited from class org.elasticsearch.search.aggregations.AggregatorBuilder

build, equals, getType, getWriteableName, hashCode, readFrom, setMetaData, subAggregation, subAggregation, subAggregations, toXContent, writeTo

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SHARD_SAMPLE_SIZE

public static final int DEFAULT_SHARD_SAMPLE_SIZE

See Also:

Constant Field Values

Constructor Detail

SamplerAggregatorBuilder

public SamplerAggregatorBuilder(java.lang.String name)

Method Detail

shardSize

public SamplerAggregatorBuilder shardSize(int shardSize)

Set the max num docs to be returned from each shard.

shardSize

public int shardSize()

Get the max num docs to be returned from each shard.

doBuild

protected SamplerAggregatorFactory doBuild(AggregationContext context,
                                           AggregatorFactory<?> parent,
                                           AggregatorFactories.Builder subFactoriesBuilder)
                                    throws java.io.IOException

Specified by:

doBuild in class AggregatorBuilder<SamplerAggregatorBuilder>

Throws:

java.io.IOException

internalXContent

protected XContentBuilder internalXContent(XContentBuilder builder,
                                           ToXContent.Params params)
                                    throws java.io.IOException

Specified by:

internalXContent in class AggregatorBuilder<SamplerAggregatorBuilder>

Throws:

java.io.IOException

doReadFrom

protected SamplerAggregatorBuilder doReadFrom(java.lang.String name,
                                              StreamInput in)
                                       throws java.io.IOException

Specified by:

doReadFrom in class AggregatorBuilder<SamplerAggregatorBuilder>

Throws:

java.io.IOException

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws java.io.IOException

Specified by:

doWriteTo in class AggregatorBuilder<SamplerAggregatorBuilder>

Throws:

java.io.IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AggregatorBuilder<SamplerAggregatorBuilder>

doEquals

protected boolean doEquals(java.lang.Object obj)

Specified by:

doEquals in class AggregatorBuilder<SamplerAggregatorBuilder>