Module org.elasticsearch.server

Package org.elasticsearch.search.aggregations.bucket.composite

Class CompositeAggregationBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AggregationBuilder

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

org.elasticsearch.search.aggregations.bucket.composite.CompositeAggregationBuilder

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, Rewriteable<AggregationBuilder>, BaseAggregationBuilder, ToXContent, ToXContentFragment

public class CompositeAggregationBuilder
extends AbstractAggregationBuilder<CompositeAggregationBuilder>

Nested Class Summary

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

AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields

Nested classes/interfaces inherited from interface org.elasticsearch.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 final ParseField	AFTER_FIELD_NAME
static final String	NAME
static final ConstructingObjectParser<CompositeAggregationBuilder,String>	PARSER
static final ParseField	SIZE_FIELD_NAME
static final ParseField	SOURCES_FIELD_NAME

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

metadata

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

DEFAULT_PREALLOCATION, factoriesBuilder, name

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CompositeAggregationBuilder(String name, List<CompositeValuesSourceBuilder<?>> sources)
	CompositeAggregationBuilder(StreamInput in)
protected	CompositeAggregationBuilder(CompositeAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
CompositeAggregationBuilder	aggregateAfter(Map<String,Object> afterKey)	Sets the values that indicates which composite bucket this request should "aggregate after".
AggregationBuilder.BucketCardinality	bucketCardinality()	A rough count of the number of buckets that Aggregators built by this builder will contain per owning parent bucket.
protected AggregatorFactory	doBuild(AggregationContext context, AggregatorFactory parent, AggregatorFactories.Builder subfactoriesBuilder)
protected void	doWriteTo(StreamOutput out)
boolean	equals(Object obj)
TransportVersion	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getType()	The name of the type of aggregation built by this builder.
int	hashCode()
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
static void	registerAggregators(ValuesSourceRegistry.Builder builder)
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)	Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata.
int	size()
CompositeAggregationBuilder	size(int size)	The number of composite buckets to return.
List<CompositeValuesSourceBuilder<?>>	sources()	Gets the list of CompositeValuesSourceBuilder for this aggregation.
boolean	supportsParallelCollection(ToLongFunction<String> fieldCardinalityResolver)	Return false if this aggregation or any of the child aggregations does not support parallel collection.
boolean	supportsSampling()	Does this aggregation support running with in a sampling context.

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, bytesToPreallocate, deepCopy, doRewrite, getName, getOutputFieldNames, getPipelineAggregations, getQuery, getSubAggregations, isInSortOrderExecutionRequired, rewrite, toString, validateSequentiallyOrdered, validateSequentiallyOrderedWithoutGaps

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

AFTER_FIELD_NAME

public static final ParseField AFTER_FIELD_NAME

SIZE_FIELD_NAME

public static final ParseField SIZE_FIELD_NAME

SOURCES_FIELD_NAME

public static final ParseField SOURCES_FIELD_NAME

PARSER

public static final ConstructingObjectParser<CompositeAggregationBuilder,String> PARSER

Constructor Details

CompositeAggregationBuilder

public CompositeAggregationBuilder(String name,
 List<CompositeValuesSourceBuilder<?>> sources)

CompositeAggregationBuilder

protected CompositeAggregationBuilder(CompositeAggregationBuilder clone,
 AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

CompositeAggregationBuilder

public CompositeAggregationBuilder(StreamInput in)
                            throws IOException

Throws:

IOException

Method Details

registerAggregators

public static void registerAggregators(ValuesSourceRegistry.Builder builder)

shallowCopy

protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

Description copied from class: AggregationBuilder

Create a shallow copy of this builder and replacing AggregationBuilder.factoriesBuilder and metadata.

Specified by:

shallowCopy in class AggregationBuilder

supportsSampling

public boolean supportsSampling()

Description copied from class: AggregationBuilder

Does this aggregation support running with in a sampling context. By default, it's false for all aggregations. If the sub-classed builder supports sampling, be sure of the following that the resulting internal aggregation objects override the InternalAggregation.finalizeSampling(SamplingContext) and scales any values that require scaling.

Overrides:

supportsSampling in class AggregationBuilder

Returns:

does this aggregation builder support sampling

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractAggregationBuilder<CompositeAggregationBuilder>

Throws:

IOException

getType

public String getType()

Description copied from interface: BaseAggregationBuilder

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

sources

public List<CompositeValuesSourceBuilder<?>> sources()

Gets the list of CompositeValuesSourceBuilder for this aggregation.

aggregateAfter

public CompositeAggregationBuilder aggregateAfter(Map<String,Object> afterKey)

Sets the values that indicates which composite bucket this request should "aggregate after". Defaults to null.

size

public CompositeAggregationBuilder size(int size)

The number of composite buckets to return. Defaults to 10.

size

public int size()

Returns:

the number of composite buckets. Defaults to 10.

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

doBuild

protected AggregatorFactory doBuild(AggregationContext context,
 AggregatorFactory parent,
 AggregatorFactories.Builder subfactoriesBuilder)
                             throws IOException

Specified by:

doBuild in class AbstractAggregationBuilder<CompositeAggregationBuilder>

Throws:

IOException

internalXContent

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

Specified by:

internalXContent in class AbstractAggregationBuilder<CompositeAggregationBuilder>

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractAggregationBuilder<CompositeAggregationBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractAggregationBuilder<CompositeAggregationBuilder>

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to

supportsParallelCollection

public boolean supportsParallelCollection(ToLongFunction<String> fieldCardinalityResolver)

Description copied from class: AggregationBuilder

Return false if this aggregation or any of the child aggregations does not support parallel collection. As a result, a request including such aggregation is always executed sequentially despite concurrency is enabled for the query phase.

Overrides:

supportsParallelCollection in class AggregationBuilder