org.elasticsearch.search.aggregations.bucket.nested

Class NestedBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AbstractAggregationBuilder

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

org.elasticsearch.search.aggregations.bucket.nested.NestedBuilder

All Implemented Interfaces:

ToXContent

public class NestedBuilder
extends AggregationBuilder<NestedBuilder>

Builder for the Nested 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
NestedBuilder(String name) Sole constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)
NestedBuilder	path(String path) Set the path to use for this nested aggregation.

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

NestedBuilder

public NestedBuilder(String name)

Sole constructor.

Method Detail

path

public NestedBuilder path(String path)

Set the path to use for this nested aggregation. The path must match the path to a nested object in the mappings. This parameter is compulsory.

internalXContent

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

Specified by:

internalXContent in class AggregationBuilder<NestedBuilder>

Throws:

IOException