Package org.elasticsearch.search.aggregations.bucket.sampler

Class DiversifiedAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

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

org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ValuesSource,DiversifiedAggregationBuilder>

org.elasticsearch.search.aggregations.bucket.sampler.DiversifiedAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentFragment, BaseAggregationBuilder

public class DiversifiedAggregationBuilder
extends ValuesSourceAggregationBuilder<ValuesSource,DiversifiedAggregationBuilder>

Nested Class Summary

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

ValuesSourceAggregationBuilder.LeafOnly<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<VS,AB>>

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

AggregationBuilder.CommonFields

Nested classes/interfaces inherited from interface org.elasticsearch.common.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

Modifier and Type	Field	Description
static int	MAX_DOCS_PER_VALUE_DEFAULT
static java.lang.String	NAME

Fields inherited from class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder

config

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

Modifier	Constructor	Description
	DiversifiedAggregationBuilder(java.lang.String name)
	DiversifiedAggregationBuilder(StreamInput in)	Read from a stream.
protected	DiversifiedAggregationBuilder(DiversifiedAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)

Method Summary

Modifier and Type	Method	Description
protected XContentBuilder	doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean	equals(java.lang.Object obj)
java.lang.String	executionHint()	Get the execution hint.
DiversifiedAggregationBuilder	executionHint(java.lang.String executionHint)	Set the execution hint.
java.lang.String	getType()	The name of the type of aggregation built by this builder.
int	hashCode()
protected ValuesSourceAggregatorFactory<ValuesSource,?>	innerBuild(SearchContext context, ValuesSourceConfig<ValuesSource> config, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder)
protected void	innerWriteTo(StreamOutput out)	Write subclass's state to the stream.
int	maxDocsPerValue()	Get the max num docs to be returned per value.
DiversifiedAggregationBuilder	maxDocsPerValue(int maxDocsPerValue)	Set the max num docs to be returned per value.
static AggregationBuilder	parse(java.lang.String aggregationName, XContentParser parser)
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,java.lang.Object> metaData)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metaData.
int	shardSize()	Get the max num docs to be returned from each shard.
DiversifiedAggregationBuilder	shardSize(int shardSize)	Set the max num docs to be returned from each shard.

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

doBuild, doWriteTo, field, field, format, format, internalXContent, missing, missing, resolveConfig, script, script, serializeTargetValueType, timeZone, timeZone, valueType, valueType

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

build, getMetaData, getWriteableName, 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

MAX_DOCS_PER_VALUE_DEFAULT

public static final int MAX_DOCS_PER_VALUE_DEFAULT

See Also:

Constant Field Values

Constructor Detail

DiversifiedAggregationBuilder

public DiversifiedAggregationBuilder(java.lang.String name)

DiversifiedAggregationBuilder

protected DiversifiedAggregationBuilder(DiversifiedAggregationBuilder clone,
                                        AggregatorFactories.Builder factoriesBuilder,
                                        java.util.Map<java.lang.String,java.lang.Object> metaData)

DiversifiedAggregationBuilder

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

Read from a stream.

Throws:

java.io.IOException

Method Detail

parse

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

Throws:

java.io.IOException

shallowCopy

protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder,
                                         java.util.Map<java.lang.String,java.lang.Object> metaData)

Description copied from class: AggregationBuilder

Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metaData. Used by AggregationBuilder.rewrite(QueryRewriteContext).

Specified by:

shallowCopy in class AggregationBuilder

innerWriteTo

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

Description copied from class: ValuesSourceAggregationBuilder

Write subclass's state to the stream.

Specified by:

innerWriteTo in class ValuesSourceAggregationBuilder<ValuesSource,DiversifiedAggregationBuilder>

Throws:

java.io.IOException

shardSize

public DiversifiedAggregationBuilder 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.

maxDocsPerValue

public DiversifiedAggregationBuilder maxDocsPerValue(int maxDocsPerValue)

Set the max num docs to be returned per value.

maxDocsPerValue

public int maxDocsPerValue()

Get the max num docs to be returned per value.

executionHint

public DiversifiedAggregationBuilder executionHint(java.lang.String executionHint)

Set the execution hint.

executionHint

public java.lang.String executionHint()

Get the execution hint.

innerBuild

protected ValuesSourceAggregatorFactory<ValuesSource,?> innerBuild(SearchContext context,
                                                                         ValuesSourceConfig<ValuesSource> config,
                                                                         AggregatorFactory<?> parent,
                                                                         AggregatorFactories.Builder subFactoriesBuilder)
                                                                  throws java.io.IOException

Specified by:

innerBuild in class ValuesSourceAggregationBuilder<ValuesSource,DiversifiedAggregationBuilder>

Throws:

java.io.IOException

doXContentBody

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

Specified by:

doXContentBody in class ValuesSourceAggregationBuilder<ValuesSource,DiversifiedAggregationBuilder>

Throws:

java.io.IOException

hashCode

public int hashCode()

Overrides:

hashCode in class ValuesSourceAggregationBuilder<ValuesSource,DiversifiedAggregationBuilder>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class ValuesSourceAggregationBuilder<ValuesSource,DiversifiedAggregationBuilder>

getType

public java.lang.String getType()

Description copied from interface: BaseAggregationBuilder

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