Package org.elasticsearch.join.aggregations

Class ParentAggregationBuilder

java.lang.Object
org.elasticsearch.search.aggregations.AggregationBuilder
org.elasticsearch.search.aggregations.AbstractAggregationBuilder<AB>
org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ParentAggregationBuilder>
org.elasticsearch.join.aggregations.ParentAggregationBuilder
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 ParentAggregationBuilder
extends org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ParentAggregationBuilder>

  • 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 java.lang.Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends java.lang.Object>

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static java.lang.String NAME  

    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

    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
      ParentAggregationBuilder​(java.lang.String name, java.lang.String childType)  
      ParentAggregationBuilder​(org.elasticsearch.common.io.stream.StreamInput in)
    Read from a stream.
    protected ParentAggregationBuilder​(ParentAggregationBuilder clone, org.elasticsearch.search.aggregations.AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,​java.lang.Object> metadata)  

  • Method Summary

    Modifier and Type Method Description
    org.elasticsearch.search.aggregations.AggregationBuilder.BucketCardinality bucketCardinality()  
    protected org.elasticsearch.search.aggregations.support.ValuesSourceType defaultValueSourceType()  
    protected org.elasticsearch.common.xcontent.XContentBuilder doXContentBody​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    boolean equals​(java.lang.Object obj)  
    protected org.elasticsearch.search.aggregations.support.ValuesSourceRegistry.RegistryKey<?> getRegistryKey()  
    java.lang.String getType()  
    int hashCode()  
    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)  
    static ParentAggregationBuilder parse​(java.lang.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, java.util.Map<java.lang.String,​java.lang.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, 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.elasticsearch.common.xcontent.ToXContentFragment

    isFragment

  • Field Details

  • Constructor Details

    • ParentAggregationBuilder

      public ParentAggregationBuilder​(java.lang.String name, java.lang.String childType)
      Parameters:
      name - the name of this aggregation
      childType - the type of children documents

    • ParentAggregationBuilder

      protected ParentAggregationBuilder​(ParentAggregationBuilder clone, org.elasticsearch.search.aggregations.AggregatorFactories.Builder factoriesBuilder, java.util.Map<java.lang.String,​java.lang.Object> metadata)

    • ParentAggregationBuilder

      public ParentAggregationBuilder​(org.elasticsearch.common.io.stream.StreamInput in) throws java.io.IOException
      Read from a stream.
      Throws:
      java.io.IOException

  • Method Details

    • defaultValueSourceType

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

    • shallowCopy

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

    • innerWriteTo

      protected void innerWriteTo​(org.elasticsearch.common.io.stream.StreamOutput out) throws java.io.IOException
      Specified by:
      innerWriteTo in class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ParentAggregationBuilder>
      Throws:
      java.io.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 java.io.IOException
      Specified by:
      innerBuild in class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ParentAggregationBuilder>
      Throws:
      java.io.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<ParentAggregationBuilder>

    • doXContentBody

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

    • parse

      public static ParentAggregationBuilder parse​(java.lang.String aggregationName, org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException
      Throws:
      java.io.IOException

    • hashCode

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

    • equals

      public boolean equals​(java.lang.Object obj)
      Overrides:
      equals in class org.elasticsearch.search.aggregations.support.ValuesSourceAggregationBuilder<ParentAggregationBuilder>

    • getType

      public java.lang.String getType()

    • getRegistryKey

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