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

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

All Implemented Interfaces:

NamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment, Rewriteable<AggregationBuilder>, BaseAggregationBuilder

public class DiversifiedAggregationBuilder
extends ValuesSourceAggregationBuilder<DiversifiedAggregationBuilder>

Nested Class Summary

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

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

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

AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields

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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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
static org.elasticsearch.common.xcontent.ObjectParser<DiversifiedAggregationBuilder,java.lang.String>	PARSER

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.index.query.Rewriteable

MAX_REWRITE_ROUNDS

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
AggregationBuilder.BucketCardinality	bucketCardinality()	A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.
protected ValuesSourceType	defaultValueSourceType()	Aggregations should use this method to define a ValuesSourceType of last resort.
protected org.elasticsearch.common.xcontent.XContentBuilder	doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.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	innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig 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 void	registerAggregators(ValuesSourceRegistry.Builder builder)
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

declareFields, doBuild, doWriteTo, field, field, format, format, internalXContent, missing, missing, resolveConfig, script, script, serializeTargetValueType, timeZone, timeZone, userValueTypeHint, userValueTypeHint

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

buildPipelineTree, 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 Details

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

PARSER

public static final org.elasticsearch.common.xcontent.ObjectParser<DiversifiedAggregationBuilder,java.lang.String> PARSER

Constructor Details

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 Details

registerAggregators

public static void registerAggregators(ValuesSourceRegistry.Builder builder)

defaultValueSourceType

protected ValuesSourceType defaultValueSourceType()

Description copied from class: ValuesSourceAggregationBuilder

Aggregations should use this method to define a ValuesSourceType of last resort. This will only be used when the resolver can't find a field and the user hasn't provided a value type hint.

Specified by:

defaultValueSourceType in class ValuesSourceAggregationBuilder<DiversifiedAggregationBuilder>

Returns:

The CoreValuesSourceType we expect this script to yield.

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

bucketCardinality

public AggregationBuilder.BucketCardinality bucketCardinality()

Description copied from class: AggregationBuilder

A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.

Specified by:

bucketCardinality in class AggregationBuilder

innerBuild

protected ValuesSourceAggregatorFactory innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder) throws java.io.IOException

Specified by:

innerBuild in class ValuesSourceAggregationBuilder<DiversifiedAggregationBuilder>

Throws:

java.io.IOException

doXContentBody

protected org.elasticsearch.common.xcontent.XContentBuilder doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException

Specified by:

doXContentBody in class ValuesSourceAggregationBuilder<DiversifiedAggregationBuilder>

Throws:

java.io.IOException

hashCode

public int hashCode()

Overrides:

hashCode in class ValuesSourceAggregationBuilder<DiversifiedAggregationBuilder>

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class ValuesSourceAggregationBuilder<DiversifiedAggregationBuilder>

getType

public java.lang.String getType()

Description copied from interface: BaseAggregationBuilder

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