Module org.elasticsearch.server
Class CompositeValuesSourceBuilder<AB extends CompositeValuesSourceBuilder<AB>>
java.lang.Object
org.elasticsearch.search.aggregations.bucket.composite.CompositeValuesSourceBuilder<AB>
- All Implemented Interfaces:
Writeable,ToXContent,ToXContentFragment
- Direct Known Subclasses:
DateHistogramValuesSourceBuilder,GeoTileGridValuesSourceBuilder,HistogramValuesSourceBuilder,TermsValuesSourceBuilder
public abstract class CompositeValuesSourceBuilder<AB extends CompositeValuesSourceBuilder<AB>>
extends Object
implements Writeable, ToXContentFragment
A
ValuesSource builder for CompositeAggregationBuilder-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Method Summary
Modifier and TypeMethodDescriptionbuild(AggregationContext context) protected abstract voiddoXContentBody(XContentBuilder builder, ToXContent.Params params) booleanfield()Gets the field to use for this sourceSets the field to use for this sourceformat()Gets the format to use for the output of the aggregation.Sets the format to use for the output of the aggregation.protected abstract ValuesSourceTypeinthashCode()protected abstract CompositeValuesSourceConfiginnerBuild(ValuesSourceRegistry registry, ValuesSourceConfig config) Actually build the values source and its associated configuration.protected abstract voidinnerWriteTo(StreamOutput out) booleanFalse if documents with missing values are ignored, otherwise missing values are represented by an explicit `null` value.missingBucket(boolean missingBucket) Iftruean explicitnullbucket will represent documents with missing values.TheMissingOrderpolicy used for ordering missing values.missingOrder(String missingOrder) Sets theMissingOrderpolicy to use for ordering missing values.missingOrder(MissingOrder missingOrder) Sets theMissingOrderpolicy to use for ordering missing values.name()order()Gets theSortOrderto use to sort values produced this sourceSets theSortOrderto use to sort values produced this sourceSets theSortOrderto use to sort values produced this sourcescript()Gets the script to use for this sourceSets the script to use for this sourcebooleansupportsParallelCollection(ToLongFunction<String> fieldCardinalityResolver) Return false if this composite source does not support parallel collection.protected ZoneIdtimeZone()The time zone for this value source.final XContentBuildertoXContent(XContentBuilder builder, ToXContent.Params params) Gets theValueTypefor the value produced by this sourceuserValuetypeHint(ValueType valueType) Sets theValueTypefor the value produced by this sourcefinal voidwriteTo(StreamOutput out) Write this into the StreamOutput.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentFragment
isFragment
-
Field Details
-
name
-
-
Method Details
-
writeTo
Description copied from interface:WriteableWrite this into the StreamOutput.- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
innerWriteTo
- Throws:
IOException
-
doXContentBody
protected abstract void doXContentBody(XContentBuilder builder, ToXContent.Params params) throws IOException - Throws:
IOException
-
toXContent
public final XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceToXContent- Throws:
IOException
-
hashCode
public int hashCode() -
equals
-
name
-
field
Sets the field to use for this source -
field
Gets the field to use for this source -
script
Sets the script to use for this source -
script
Gets the script to use for this source -
userValuetypeHint
Sets theValueTypefor the value produced by this source -
userValuetypeHint
Gets theValueTypefor the value produced by this source -
missingBucket
Iftruean explicitnullbucket 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. -
missingOrder
Sets theMissingOrderpolicy to use for ordering missing values.- Parameters:
missingOrder- One of "first", "last" or "default".
-
missingOrder
Sets theMissingOrderpolicy to use for ordering missing values. -
missingOrder
TheMissingOrderpolicy used for ordering missing values. -
order
Sets theSortOrderto use to sort values produced this source -
order
Sets theSortOrderto use to sort values produced this source -
order
Gets theSortOrderto use to sort values produced this source -
format
Sets the format to use for the output of the aggregation. -
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
-
build
- Throws:
IOException
-
timeZone
The time zone for this value source. Default implementation returnsnullbecause most value source types don't support time zone. -
supportsParallelCollection
Return false if this composite source does not support parallel collection. As a result, a request including such aggregation is always executed sequentially despite concurrency is enabled for the query phase.
-