org.elasticsearch.search.aggregations.bucket.sampler

Class SamplerAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

org.elasticsearch.search.aggregations.AbstractAggregationBuilder<SamplerAggregationBuilder>

org.elasticsearch.search.aggregations.bucket.sampler.SamplerAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, BaseAggregationBuilder

public class SamplerAggregationBuilder
extends AbstractAggregationBuilder<SamplerAggregationBuilder>

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

AggregationBuilder.CommonFields

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

Writeable.Reader<V>, Writeable.Writer<V>

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
static java.lang.String	NAME

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

metaData

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

factoriesBuilder, name

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
SamplerAggregationBuilder(StreamInput in) Read from a stream.
SamplerAggregationBuilder(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
protected SamplerAggregatorFactory	doBuild(SearchContext context, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder)
protected boolean	doEquals(java.lang.Object obj)
protected int	doHashCode()
protected void	doWriteTo(StreamOutput out)
java.lang.String	getType() The name of the type of aggregation built by this builder.
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
static SamplerAggregationBuilder	parse(java.lang.String aggregationName, XContentParser parser)
int	shardSize() Get the max num docs to be returned from each shard.
SamplerAggregationBuilder	shardSize(int shardSize) Set the max num docs to be returned from each shard.

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

build, equals, getMetaData, getWriteableName, hashCode, setMetaData, subAggregation, subAggregation, subAggregations, toXContent, writeTo

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

doRewrite, getName, 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 Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

DEFAULT_SHARD_SAMPLE_SIZE

public static final int DEFAULT_SHARD_SAMPLE_SIZE

See Also:

Constant Field Values

Constructor Detail

SamplerAggregationBuilder

public SamplerAggregationBuilder(java.lang.String name)

SamplerAggregationBuilder

public SamplerAggregationBuilder(StreamInput in)
                          throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

doWriteTo

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

Specified by:

doWriteTo in class AbstractAggregationBuilder<SamplerAggregationBuilder>

Throws:

java.io.IOException

shardSize

public SamplerAggregationBuilder 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(SearchContext context,
                                           AggregatorFactory<?> parent,
                                           AggregatorFactories.Builder subFactoriesBuilder)
                                    throws java.io.IOException

Specified by:

doBuild in class AbstractAggregationBuilder<SamplerAggregationBuilder>

Throws:

java.io.IOException

internalXContent

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

Specified by:

internalXContent in class AbstractAggregationBuilder<SamplerAggregationBuilder>

Throws:

java.io.IOException

parse

public static SamplerAggregationBuilder parse(java.lang.String aggregationName,
                                              XContentParser parser)
                                       throws java.io.IOException

Throws:

java.io.IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractAggregationBuilder<SamplerAggregationBuilder>

doEquals

protected boolean doEquals(java.lang.Object obj)

Specified by:

doEquals in class AbstractAggregationBuilder<SamplerAggregationBuilder>

getType

public java.lang.String getType()

Description copied from interface: BaseAggregationBuilder

The name of the type of aggregation built by this builder.