Class CustomAggregationBuilder

  • All Implemented Interfaces:
    org.elasticsearch.common.io.stream.NamedWriteable, org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.index.query.Rewriteable<org.elasticsearch.search.aggregations.AggregationBuilder>, org.elasticsearch.search.aggregations.BaseAggregationBuilder, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentFragment

    public final class CustomAggregationBuilder
    extends org.elasticsearch.search.aggregations.AggregationBuilder
    • Nested Class Summary

      • 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.xcontent.ToXContent

        org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.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 Object DECIMAL_PRECISION_TO_PARAM  
      • 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.xcontent.ToXContent

        EMPTY_PARAMS
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      org.elasticsearch.search.aggregations.AggregationBuilder.BucketCardinality bucketCardinality()  
      protected org.elasticsearch.search.aggregations.AggregatorFactory build​(org.elasticsearch.search.aggregations.support.AggregationContext context, org.elasticsearch.search.aggregations.AggregatorFactory parent)  
      boolean equals​(Object obj)  
      Map<String,​Object> getMetadata()  
      String getType()  
      String getWriteableName()  
      int hashCode()  
      CustomAggregationBuilder setMetadata​(Map<String,​Object> metaData)  
      protected org.elasticsearch.search.aggregations.AggregationBuilder shallowCopy​(org.elasticsearch.search.aggregations.AggregatorFactories.Builder originalFactoriesBuilder, Map<String,​Object> originalMetaData)  
      CustomAggregationBuilder subAggregation​(org.elasticsearch.search.aggregations.AggregationBuilder aggregation)  
      CustomAggregationBuilder subAggregation​(org.elasticsearch.search.aggregations.PipelineAggregationBuilder aggregation)
      Add a sub aggregation to this aggregation.
      CustomAggregationBuilder subAggregations​(org.elasticsearch.search.aggregations.AggregatorFactories.Builder subFactories)
      Registers sub-factories with this factory.
      org.elasticsearch.xcontent.XContentBuilder toXContent​(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)  
      void writeTo​(org.elasticsearch.common.io.stream.StreamOutput out)  
      • Methods inherited from class org.elasticsearch.search.aggregations.AggregationBuilder

        buildPipelineTree, bytesToPreallocate, doRewrite, getName, getOutputFieldNames, getPipelineAggregations, getSubAggregations, isInSortOrderExecutionRequired, rewrite, toString, validateSequentiallyOrdered, validateSequentiallyOrderedWithoutGaps
      • Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

        isFragment
    • Field Detail

      • DECIMAL_PRECISION_TO_PARAM

        public static final Object DECIMAL_PRECISION_TO_PARAM
    • Constructor Detail

      • CustomAggregationBuilder

        public CustomAggregationBuilder​(String name,
                                        String field,
                                        Map<String,​String> customParams)
        Constructs a new aggregation builder.
        Parameters:
        name - The aggregation name
    • Method Detail

      • getType

        public String getType()
      • writeTo

        public void writeTo​(org.elasticsearch.common.io.stream.StreamOutput out)
                     throws IOException
        Throws:
        IOException
      • subAggregation

        public CustomAggregationBuilder subAggregation​(org.elasticsearch.search.aggregations.AggregationBuilder aggregation)
        Specified by:
        subAggregation in class org.elasticsearch.search.aggregations.AggregationBuilder
      • subAggregation

        public CustomAggregationBuilder subAggregation​(org.elasticsearch.search.aggregations.PipelineAggregationBuilder aggregation)
        Add a sub aggregation to this aggregation.
        Specified by:
        subAggregation in class org.elasticsearch.search.aggregations.AggregationBuilder
      • subAggregations

        public CustomAggregationBuilder subAggregations​(org.elasticsearch.search.aggregations.AggregatorFactories.Builder subFactories)
        Registers sub-factories with this factory. The sub-factory will be responsible for the creation of sub-aggregators under the aggregator created by this factory.
        Specified by:
        subAggregations in interface org.elasticsearch.search.aggregations.BaseAggregationBuilder
        Specified by:
        subAggregations in class org.elasticsearch.search.aggregations.AggregationBuilder
        Parameters:
        subFactories - The sub-factories
        Returns:
        this factory (fluent interface)
      • setMetadata

        public CustomAggregationBuilder setMetadata​(Map<String,​Object> metaData)
        Specified by:
        setMetadata in interface org.elasticsearch.search.aggregations.BaseAggregationBuilder
        Specified by:
        setMetadata in class org.elasticsearch.search.aggregations.AggregationBuilder
      • getMetadata

        public Map<String,​Object> getMetadata()
        Specified by:
        getMetadata in class org.elasticsearch.search.aggregations.AggregationBuilder
      • getWriteableName

        public String getWriteableName()
      • toXContent

        public org.elasticsearch.xcontent.XContentBuilder toXContent​(org.elasticsearch.xcontent.XContentBuilder builder,
                                                                     org.elasticsearch.xcontent.ToXContent.Params params)
                                                              throws IOException
        Throws:
        IOException
      • shallowCopy

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

        protected org.elasticsearch.search.aggregations.AggregatorFactory build​(org.elasticsearch.search.aggregations.support.AggregationContext context,
                                                                                org.elasticsearch.search.aggregations.AggregatorFactory parent)
        Specified by:
        build in class org.elasticsearch.search.aggregations.AggregationBuilder
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object
      • bucketCardinality

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