Class ChildrenAggregationBuilder

java.lang.Object
org.elasticsearch.search.aggregations.AggregationBuilder
org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB>
org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ChildrenAggregationBuilder>
org.elasticsearch.join.aggregations.ChildrenAggregationBuilder
All Implemented Interfaces:
org.elasticsearch.common.io.stream.NamedWriteable, org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment, org.elasticsearch.index.query.Rewriteable<org.elasticsearch.search.aggregations.AggregationBuilder>, org.elasticsearch.search.aggregations.BaseAggregationBuilder

public class ChildrenAggregationBuilder extends org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ChildrenAggregationBuilder>
  • Nested Class Summary

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

    org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder.LeafOnly<VS extends org.elasticsearch.search.aggregations.support.ValuesSource,​AB extends org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<AB>>

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

    org.elasticsearch.search.aggregations.AggregationBuilder.BucketCardinality, org.elasticsearch.search.aggregations.AggregationBuilder.CommonFields

    Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

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

    org.elasticsearch.common.io.stream.Writeable.Reader<V extends Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends Object>
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static String
     

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

    config

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

    metadata

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

    DEFAULT_PREALLOCATION, factoriesBuilder, name

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

    MAX_REWRITE_ROUNDS

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
     
     
    ChildrenAggregationBuilder​(org.elasticsearch.common.io.stream.StreamInput in)
    Read from a stream.
    protected
    ChildrenAggregationBuilder​(ChildrenAggregationBuilder clone, org.elasticsearch.search.aggregations.AggregatorFactories.Builder factoriesBuilder, Map<String,​Object> metadata)
     
  • Method Summary

    Modifier and Type
    Method
    Description
    org.elasticsearch.search.aggregations.AggregationBuilder.BucketCardinality
     
    protected org.elasticsearch.search.aggregations.support.ValuesSourceType
     
    protected org.elasticsearch.common.xcontent.XContentBuilder
    doXContentBody​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     
    boolean
    equals​(Object obj)
     
    protected org.elasticsearch.search.aggregations.support.ValuesSourceRegistry.RegistryKey<?>
     
     
    int
     
    protected org.elasticsearch.search.aggregations.support.ValuesSourceAggregatorFactory
    innerBuild​(org.elasticsearch.search.aggregations.support.AggregationContext context, org.elasticsearch.search.aggregations.support.ValuesSourceConfig config, org.elasticsearch.search.aggregations.AggregatorFactory parent, org.elasticsearch.search.aggregations.AggregatorFactories.Builder subFactoriesBuilder)
     
    protected void
    innerWriteTo​(org.elasticsearch.common.io.stream.StreamOutput out)
     
    parse​(String aggregationName, org.elasticsearch.common.xcontent.XContentParser parser)
     
    protected org.elasticsearch.search.aggregations.support.ValuesSourceConfig
    resolveConfig​(org.elasticsearch.search.aggregations.support.AggregationContext context)
     
    protected org.elasticsearch.search.aggregations.AggregationBuilder
    shallowCopy​(org.elasticsearch.search.aggregations.AggregatorFactories.Builder factoriesBuilder, Map<String,​Object> metadata)
     

    Methods inherited from class org.elasticsearch.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.elasticsearch.search.aggregations.AbstractAggregationBuilder

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

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

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

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

    isFragment
  • Field Details

  • 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, org.elasticsearch.search.aggregations.AggregatorFactories.Builder factoriesBuilder, Map<String,​Object> metadata)
    • ChildrenAggregationBuilder

      public ChildrenAggregationBuilder(org.elasticsearch.common.io.stream.StreamInput in) throws IOException
      Read from a stream.
      Throws:
      IOException
  • Method Details

    • defaultValueSourceType

      protected org.elasticsearch.search.aggregations.support.ValuesSourceType defaultValueSourceType()
      Specified by:
      defaultValueSourceType in class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ChildrenAggregationBuilder>
    • shallowCopy

      protected org.elasticsearch.search.aggregations.AggregationBuilder shallowCopy(org.elasticsearch.search.aggregations.AggregatorFactories.Builder factoriesBuilder, Map<String,​Object> metadata)
      Specified by:
      shallowCopy in class org.elasticsearch.search.aggregations.AggregationBuilder
    • innerWriteTo

      protected void innerWriteTo(org.elasticsearch.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      innerWriteTo in class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ChildrenAggregationBuilder>
      Throws:
      IOException
    • bucketCardinality

      public org.elasticsearch.search.aggregations.AggregationBuilder.BucketCardinality bucketCardinality()
      Specified by:
      bucketCardinality in class org.elasticsearch.search.aggregations.AggregationBuilder
    • innerBuild

      protected org.elasticsearch.search.aggregations.support.ValuesSourceAggregatorFactory innerBuild(org.elasticsearch.search.aggregations.support.AggregationContext context, org.elasticsearch.search.aggregations.support.ValuesSourceConfig config, org.elasticsearch.search.aggregations.AggregatorFactory parent, org.elasticsearch.search.aggregations.AggregatorFactories.Builder subFactoriesBuilder) throws IOException
      Specified by:
      innerBuild in class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ChildrenAggregationBuilder>
      Throws:
      IOException
    • resolveConfig

      protected org.elasticsearch.search.aggregations.support.ValuesSourceConfig resolveConfig(org.elasticsearch.search.aggregations.support.AggregationContext context)
      Overrides:
      resolveConfig in class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ChildrenAggregationBuilder>
    • doXContentBody

      protected org.elasticsearch.common.xcontent.XContentBuilder doXContentBody(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      doXContentBody in class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ChildrenAggregationBuilder>
      Throws:
      IOException
    • parse

      public static ChildrenAggregationBuilder parse(String aggregationName, org.elasticsearch.common.xcontent.XContentParser parser) throws IOException
      Throws:
      IOException
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ChildrenAggregationBuilder>
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ChildrenAggregationBuilder>
    • getType

      public String getType()
    • getRegistryKey

      protected org.elasticsearch.search.aggregations.support.ValuesSourceRegistry.RegistryKey<?> getRegistryKey()
      Specified by:
      getRegistryKey in class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ChildrenAggregationBuilder>