Package org.elasticsearch.search.aggregations.bucket.composite

Class CompositeValuesSourceBuilder<AB extends CompositeValuesSourceBuilder<AB>>

java.lang.Object
org.elasticsearch.search.aggregations.bucket.composite.CompositeValuesSourceBuilder<AB>
All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment
Direct Known Subclasses:
DateHistogramValuesSourceBuilder, GeoTileGridValuesSourceBuilder, HistogramValuesSourceBuilder, TermsValuesSourceBuilder
public abstract class CompositeValuesSourceBuilder<AB extends CompositeValuesSourceBuilder<AB>> extends Object implements Writeable, org.elasticsearch.common.xcontent.ToXContentFragment
A ValuesSource builder for CompositeAggregationBuilder

  • Field Details

    • name

      protected final String name

  • Method Details

    • writeTo

      public final void writeTo​(StreamOutput out) throws IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException

    • innerWriteTo

      protected abstract void innerWriteTo​(StreamOutput out) throws IOException
      Throws:
      IOException

    • doXContentBody

      protected abstract void doXContentBody​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException
      Throws:
      IOException

    • toXContent

      public final org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      IOException

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals​(Object o)
      Overrides:
      equals in class Object

    • name

      public String name()

    • field

      public AB field​(String field)
      Sets the field to use for this source

    • field

      public String field()
      Gets the field to use for this source

    • script

      public AB script​(Script script)
      Sets the script to use for this source

    • script

      public Script script()
      Gets the script to use for this source

    • userValuetypeHint

      public AB userValuetypeHint​(ValueType valueType)
      Sets the ValueType for the value produced by this source

    • userValuetypeHint

      public ValueType userValuetypeHint()
      Gets the ValueType for the value produced by this source

    • missingBucket

      public AB missingBucket​(boolean missingBucket)
      If true an explicit null bucket will represent documents with missing values.

    • missingBucket

      public boolean missingBucket()
      False if documents with missing values are ignored, otherwise missing values are represented by an explicit `null` value.

    • order

      public AB order​(String order)
      Sets the SortOrder to use to sort values produced this source

    • order

      public AB order​(SortOrder order)
      Sets the SortOrder to use to sort values produced this source

    • order

      public SortOrder order()
      Gets the SortOrder to use to sort values produced this source

    • format

      public AB format​(String format)
      Sets the format to use for the output of the aggregation.

    • format

      public String format()
      Gets the format to use for the output of the aggregation.

    • innerBuild

      protected abstract CompositeValuesSourceConfig innerBuild​(ValuesSourceRegistry registry, ValuesSourceConfig config) throws IOException
      Actually build the values source and its associated configuration.
      Throws:
      IOException

    • getDefaultValuesSourceType

      protected abstract ValuesSourceType getDefaultValuesSourceType()

    • build

      public final CompositeValuesSourceConfig build​(AggregationContext context) throws IOException
      Throws:
      IOException

    • timeZone

      protected ZoneId timeZone()
      The time zone for this value source. Default implementation returns null because most value source types don't support time zone.