Package org.opensearch.join.aggregations

Class ChildrenAggregationBuilder

java.lang.Object

org.opensearch.search.aggregations.AggregationBuilder

org.opensearch.search.aggregations.AbstractAggregationBuilder<AB>

org.opensearch.search.aggregations.support.ValuesSourceAggregationBuilder<ChildrenAggregationBuilder>

org.opensearch.join.aggregations.ChildrenAggregationBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, Rewriteable<AggregationBuilder>, BaseAggregationBuilder

public class ChildrenAggregationBuilder
extends ValuesSourceAggregationBuilder<ChildrenAggregationBuilder>

Nested Class Summary

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.support.ValuesSourceAggregationBuilder

ValuesSourceAggregationBuilder.LeafOnly<VS extends ValuesSource,AB extends ValuesSourceAggregationBuilder<AB>>

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

AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable

Writeable.Reader<V extends Object>, Writeable.WriteableRegistry, Writeable.Writer<V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Fields inherited from class org.opensearch.search.aggregations.support.ValuesSourceAggregationBuilder

config

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

metadata

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

factoriesBuilder, name

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

MAX_REWRITE_ROUNDS

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
	ChildrenAggregationBuilder(String name, String childType)
	ChildrenAggregationBuilder(StreamInput in)	Read from a stream.
protected	ChildrenAggregationBuilder(ChildrenAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
AggregationBuilder.BucketCardinality	bucketCardinality()
protected ValuesSourceType	defaultValueSourceType()
protected org.opensearch.core.xcontent.XContentBuilder	doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
boolean	equals(Object obj)
protected ValuesSourceRegistry.RegistryKey<?>	getRegistryKey()
String	getType()
int	hashCode()
protected ValuesSourceAggregatorFactory	innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected void	innerWriteTo(StreamOutput out)
static ChildrenAggregationBuilder	parse(String aggregationName, org.opensearch.core.xcontent.XContentParser parser)
protected ValuesSourceConfig	resolveConfig(QueryShardContext queryShardContext)
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Methods inherited from class org.opensearch.search.aggregations.support.ValuesSourceAggregationBuilder

declareFields, declareFields, doBuild, doWriteTo, field, field, format, format, internalXContent, missing, missing, script, script, serializeTargetValueType, timeZone, timeZone, userValueTypeHint, userValueTypeHint

Methods inherited from class org.opensearch.search.aggregations.AbstractAggregationBuilder

build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, subAggregations, toXContent, writeTo

Methods inherited from class org.opensearch.search.aggregations.AggregationBuilder

buildPipelineTree, doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

ChildrenAggregationBuilder

public ChildrenAggregationBuilder(String name,
 String childType)

Parameters:

name - the name of this aggregation

childType - the type of children documents

ChildrenAggregationBuilder

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

ChildrenAggregationBuilder

public ChildrenAggregationBuilder(StreamInput in)
                           throws IOException

Read from a stream.

Throws:

IOException

Method Details

defaultValueSourceType

protected ValuesSourceType defaultValueSourceType()

Specified by:

defaultValueSourceType in class ValuesSourceAggregationBuilder<ChildrenAggregationBuilder>

shallowCopy

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

Specified by:

shallowCopy in class AggregationBuilder

innerWriteTo

protected void innerWriteTo(StreamOutput out)
                     throws IOException

Specified by:

innerWriteTo in class ValuesSourceAggregationBuilder<ChildrenAggregationBuilder>

Throws:

IOException

bucketCardinality

public AggregationBuilder.BucketCardinality bucketCardinality()

Specified by:

bucketCardinality in class AggregationBuilder

innerBuild

protected ValuesSourceAggregatorFactory innerBuild(QueryShardContext queryShardContext,
 ValuesSourceConfig config,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder)
                                            throws IOException

Specified by:

innerBuild in class ValuesSourceAggregationBuilder<ChildrenAggregationBuilder>

Throws:

IOException

resolveConfig

protected ValuesSourceConfig resolveConfig(QueryShardContext queryShardContext)

Overrides:

resolveConfig in class ValuesSourceAggregationBuilder<ChildrenAggregationBuilder>

doXContentBody

protected org.opensearch.core.xcontent.XContentBuilder doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                               throws IOException

Specified by:

doXContentBody in class ValuesSourceAggregationBuilder<ChildrenAggregationBuilder>

Throws:

IOException

parse

public static ChildrenAggregationBuilder parse(String aggregationName,
 org.opensearch.core.xcontent.XContentParser parser)
                                        throws IOException

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class ValuesSourceAggregationBuilder<ChildrenAggregationBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class ValuesSourceAggregationBuilder<ChildrenAggregationBuilder>

getType

public String getType()

getRegistryKey

protected ValuesSourceRegistry.RegistryKey<?> getRegistryKey()

Specified by:

getRegistryKey in class ValuesSourceAggregationBuilder<ChildrenAggregationBuilder>