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

Class CompositeValuesSourceBuilder<AB extends CompositeValuesSourceBuilder<AB>>

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 implements Writeable, org.elasticsearch.common.xcontent.ToXContentFragment
A ValuesSource builder for CompositeAggregationBuilder

  • Nested Class Summary

    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

    Writeable.Reader<V>, Writeable.Writer<V>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected
    name
     

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

    EMPTY_PARAMS

  • Method Summary

    Modifier and Type
    Method
    Description
    CompositeValuesSourceConfig
    build​(AggregationContext context)
     
    protected abstract void
    doXContentBody​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     
    boolean
     o)
     
    field()
    Gets the field to use for this source
    AB
     field)
    Sets the field to use for this source
    format()
    Gets the format to use for the output of the aggregation.
    AB
     format)
    Sets the format to use for the output of the aggregation.
    protected abstract ValuesSourceType
    getDefaultValuesSourceType()
     
    int
    hashCode()
     
    protected abstract CompositeValuesSourceConfig
    innerBuild​(ValuesSourceRegistry registry, ValuesSourceConfig config)
    Actually build the values source and its associated configuration.
    protected abstract void
    innerWriteTo​(StreamOutput out)
     
    boolean
    missingBucket()
    False if documents with missing values are ignored, otherwise missing values are represented by an explicit `null` value.
    AB
    missingBucket​(boolean missingBucket)
    If true an explicit null bucket will represent documents with missing values.
    name()
     
    SortOrder
    order()
    Gets the SortOrder to use to sort values produced this source
    AB
     order)
    Sets the SortOrder to use to sort values produced this source
    AB
    order​(SortOrder order)
    Sets the SortOrder to use to sort values produced this source
    Script
    script()
    Gets the script to use for this source
    AB
    script​(Script script)
    Sets the script to use for this source
    protected
    timeZone()
    The time zone for this value source.
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     
    ValueType
    userValuetypeHint()
    Gets the ValueType for the value produced by this source
    AB
    userValuetypeHint​(ValueType valueType)
    Sets the ValueType for the value produced by this source
    void
    writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class java.lang.

    , , , , , , , ,

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

    isFragment

  • Field Details

    • name

      protected final  name

  • Method Details

    • writeTo

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

    • innerWriteTo

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

    • doXContentBody

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

    • toXContent

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

    • hashCode

      public int hashCode()
      Overrides:
       in class 

    • equals

      public boolean equals​( o)
      Overrides:
       in class 

    • name

      public  name()

    • field

      public  field)
      Sets the field to use for this source

    • field

      public  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  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  format)
      Sets the format to use for the output of the aggregation.

    • format

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

    • innerBuild

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

    • getDefaultValuesSourceType

      protected abstract ValuesSourceType getDefaultValuesSourceType()

    • build

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

    • timeZone

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