public class NestedAggregationBuilder extends AbstractAggregationBuilder<NestedAggregationBuilder>
AggregationBuilder.CommonFields
Writeable.Reader<V>, Writeable.Writer<V>
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAME |
metaData
factoriesBuilder, name
EMPTY_PARAMS
Constructor and Description |
---|
NestedAggregationBuilder(StreamInput in)
Read from a stream.
|
NestedAggregationBuilder(java.lang.String name,
java.lang.String path) |
Modifier and Type | Method and Description |
---|---|
protected AggregatorFactory<?> |
doBuild(SearchContext context,
AggregatorFactory<?> parent,
AggregatorFactories.Builder subFactoriesBuilder) |
protected boolean |
doEquals(java.lang.Object obj) |
protected int |
doHashCode() |
protected void |
doWriteTo(StreamOutput out) |
java.lang.String |
getType()
The name of the type of aggregation built by this builder.
|
protected XContentBuilder |
internalXContent(XContentBuilder builder,
ToXContent.Params params) |
static NestedAggregationBuilder |
parse(java.lang.String aggregationName,
XContentParser parser) |
java.lang.String |
path()
Get the path to use for this nested aggregation.
|
build, equals, getMetaData, getWriteableName, hashCode, setMetaData, subAggregation, subAggregation, subAggregations, toXContent, writeTo
doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
isFragment
public static final java.lang.String NAME
public NestedAggregationBuilder(java.lang.String name, java.lang.String path)
name
- the name of this aggregationpath
- the path to use for this nested aggregation. The path must
match the path to a nested object in the mappings.public NestedAggregationBuilder(StreamInput in) throws java.io.IOException
java.io.IOException
protected void doWriteTo(StreamOutput out) throws java.io.IOException
doWriteTo
in class AbstractAggregationBuilder<NestedAggregationBuilder>
java.io.IOException
public java.lang.String path()
protected AggregatorFactory<?> doBuild(SearchContext context, AggregatorFactory<?> parent, AggregatorFactories.Builder subFactoriesBuilder) throws java.io.IOException
doBuild
in class AbstractAggregationBuilder<NestedAggregationBuilder>
java.io.IOException
protected XContentBuilder internalXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException
internalXContent
in class AbstractAggregationBuilder<NestedAggregationBuilder>
java.io.IOException
public static NestedAggregationBuilder parse(java.lang.String aggregationName, XContentParser parser) throws java.io.IOException
java.io.IOException
protected int doHashCode()
doHashCode
in class AbstractAggregationBuilder<NestedAggregationBuilder>
protected boolean doEquals(java.lang.Object obj)
doEquals
in class AbstractAggregationBuilder<NestedAggregationBuilder>
public java.lang.String getType()
BaseAggregationBuilder