Package org.opensearch.join.aggregations
Class ParentAggregationBuilder
java.lang.Object
org.opensearch.search.aggregations.AggregationBuilder
org.opensearch.search.aggregations.AbstractAggregationBuilder<AB>
org.opensearch.search.aggregations.support.ValuesSourceAggregationBuilder<ParentAggregationBuilder>
org.opensearch.join.aggregations.ParentAggregationBuilder
- All Implemented Interfaces:
NamedWriteable,Writeable,ToXContent,ToXContentFragment,Rewriteable<AggregationBuilder>,BaseAggregationBuilder
public class ParentAggregationBuilder
extends ValuesSourceAggregationBuilder<ParentAggregationBuilder>
-
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.CommonFieldsNested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable
Writeable.Reader<V extends Object>, Writeable.Writer<V extends Object> -
Field Summary
FieldsFields inherited from class org.opensearch.search.aggregations.support.ValuesSourceAggregationBuilder
configFields inherited from class org.opensearch.search.aggregations.AbstractAggregationBuilder
metadataFields inherited from class org.opensearch.search.aggregations.AggregationBuilder
factoriesBuilder, nameFields inherited from interface org.opensearch.index.query.Rewriteable
MAX_REWRITE_ROUNDSFields inherited from interface org.opensearch.common.xcontent.ToXContent
EMPTY_PARAMS -
Constructor Summary
ConstructorsModifierConstructorDescriptionParentAggregationBuilder(String name, String childType) Read from a stream.protectedParentAggregationBuilder(ParentAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) -
Method Summary
Modifier and TypeMethodDescriptionprotected ValuesSourceTypeprotected XContentBuilderdoXContentBody(XContentBuilder builder, ToXContent.Params params) booleanprotected ValuesSourceRegistry.RegistryKey<?>getType()inthashCode()protected ValuesSourceAggregatorFactoryinnerBuild(QueryShardContext queryShardContext, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder) protected voidinnerWriteTo(StreamOutput out) static ParentAggregationBuilderparse(String aggregationName, XContentParser parser) protected ValuesSourceConfigresolveConfig(QueryShardContext queryShardContext) protected AggregationBuildershallowCopy(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, userValueTypeHintMethods inherited from class org.opensearch.search.aggregations.AbstractAggregationBuilder
build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, subAggregations, toXContent, writeToMethods inherited from class org.opensearch.search.aggregations.AggregationBuilder
buildPipelineTree, doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, toStringMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.opensearch.common.xcontent.ToXContentFragment
isFragment
-
Field Details
-
NAME
- See Also:
-
-
Constructor Details
-
ParentAggregationBuilder
- Parameters:
name- the name of this aggregationchildType- the type of children documents
-
ParentAggregationBuilder
protected ParentAggregationBuilder(ParentAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) -
ParentAggregationBuilder
Read from a stream.- Throws:
IOException
-
-
Method Details
-
defaultValueSourceType
- Specified by:
defaultValueSourceTypein classValuesSourceAggregationBuilder<ParentAggregationBuilder>
-
shallowCopy
protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String, Object> metadata) - Specified by:
shallowCopyin classAggregationBuilder
-
innerWriteTo
- Specified by:
innerWriteToin classValuesSourceAggregationBuilder<ParentAggregationBuilder>- Throws:
IOException
-
bucketCardinality
- Specified by:
bucketCardinalityin classAggregationBuilder
-
innerBuild
protected ValuesSourceAggregatorFactory innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig config, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder) throws IOException - Specified by:
innerBuildin classValuesSourceAggregationBuilder<ParentAggregationBuilder>- Throws:
IOException
-
resolveConfig
- Overrides:
resolveConfigin classValuesSourceAggregationBuilder<ParentAggregationBuilder>
-
doXContentBody
protected XContentBuilder doXContentBody(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
doXContentBodyin classValuesSourceAggregationBuilder<ParentAggregationBuilder>- Throws:
IOException
-
parse
public static ParentAggregationBuilder parse(String aggregationName, XContentParser parser) throws IOException - Throws:
IOException
-
hashCode
public int hashCode()- Overrides:
hashCodein classValuesSourceAggregationBuilder<ParentAggregationBuilder>
-
equals
- Overrides:
equalsin classValuesSourceAggregationBuilder<ParentAggregationBuilder>
-
getType
-
getRegistryKey
- Specified by:
getRegistryKeyin classValuesSourceAggregationBuilder<ParentAggregationBuilder>
-