org.elasticsearch.search.aggregations.bucket.sampler

Class SamplerAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AbstractAggregationBuilder

org.elasticsearch.search.aggregations.AggregationBuilder<B>

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

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

All Implemented Interfaces:

ToXContent

public class SamplerAggregationBuilder
extends ValuesSourceAggregationBuilder<SamplerAggregationBuilder>

Builder for the Sampler aggregation.

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

type

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
SamplerAggregationBuilder(String name) Sole constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected XContentBuilder	doInternalXContent(XContentBuilder builder, ToXContent.Params params)
SamplerAggregationBuilder	executionHint(String executionHint)
SamplerAggregationBuilder	maxDocsPerValue(int maxDocsPerValue)
SamplerAggregationBuilder	shardSize(int shardSize) Set the max num docs to be returned from each shard.

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

field, internalXContent, missing, script

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

setMetaData, subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, subAggregation, toXContent

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

getName

Methods inherited from class java.lang.Object

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

Constructor Detail

SamplerAggregationBuilder

public SamplerAggregationBuilder(String name)

Sole constructor.

Method Detail

shardSize

public SamplerAggregationBuilder shardSize(int shardSize)

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

maxDocsPerValue

public SamplerAggregationBuilder maxDocsPerValue(int maxDocsPerValue)

executionHint

public SamplerAggregationBuilder executionHint(String executionHint)

doInternalXContent

protected XContentBuilder doInternalXContent(XContentBuilder builder,
                                 ToXContent.Params params)
                                      throws IOException

Specified by:

doInternalXContent in class ValuesSourceAggregationBuilder<SamplerAggregationBuilder>

Throws:

IOException