OpenSearch/docs/java-api/aggregations/bucket/children-aggregation.asciidoc
Jim Ferenczi 279a18a527 Add parent-join module (#24638)
* Add parent-join module

This change adds a new module named `parent-join`.
The goal of this module is to provide a replacement for the `_parent` field but as a first step this change only moves the `has_child`, `has_parent` queries and the `children` aggregation to this module.
These queries and aggregations are no longer in core but they are deployed by default as a module.

Relates #20257
2017-05-12 15:58:06 +02:00

36 lines
1.0 KiB
Plaintext

[[java-aggs-bucket-children]]
==== Children Aggregation
Here is how you can use
{ref}/search-aggregations-bucket-children-aggregation.html[Children Aggregation]
with Java API.
===== Prepare aggregation request
Here is an example on how to create the aggregation request:
[source,java]
--------------------------------------------------
AggregationBuilder aggregation =
AggregationBuilders
.children("agg", "reseller"); <1>
--------------------------------------------------
1. `"agg"` is the name of the aggregation and `"reseller"` is the child type
===== Use aggregation response
Import Aggregation definition classes:
[source,java]
--------------------------------------------------
import org.elasticsearch.join.aggregations.Children;
--------------------------------------------------
[source,java]
--------------------------------------------------
// sr is here your SearchResponse object
Children agg = sr.getAggregations().get("agg");
agg.getDocCount(); // Doc count
--------------------------------------------------