org.elasticsearch.search.aggregations.bucket.children

Class ChildrenBuilder

java.lang.Object

org.elasticsearch.search.aggregations.AbstractAggregationBuilder

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

org.elasticsearch.search.aggregations.bucket.children.ChildrenBuilder

All Implemented Interfaces:

ToXContent

public class ChildrenBuilder
extends AggregationBuilder<ChildrenBuilder>

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

Method Summary

Methods

Modifier and Type	Method and Description
ChildrenBuilder	childType(String childType) Set the type of children documents.
protected XContentBuilder	internalXContent(XContentBuilder builder, ToXContent.Params params)

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

ChildrenBuilder

public ChildrenBuilder(String name)

Sole constructor.

Method Detail

childType

public ChildrenBuilder childType(String childType)

Set the type of children documents. This parameter is compulsory.

internalXContent

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

Specified by:

internalXContent in class AggregationBuilder<ChildrenBuilder>

Throws:

IOException