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 java.lang.Object implements Writeable, ToXContentFragment
A
ValuesSource
builder for CompositeAggregationBuilder
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, 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 java.lang.String
name
-
Method Summary
Modifier and Type Method Description org.elasticsearch.search.aggregations.bucket.composite.CompositeValuesSourceConfig
build(QueryShardContext queryShardContext)
protected abstract void
doXContentBody(XContentBuilder builder, ToXContent.Params params)
boolean
equals(java.lang.Object o)
java.lang.String
field()
Gets the field to use for this sourceAB
field(java.lang.String field)
Sets the field to use for this sourcejava.lang.String
format()
Gets the format to use for the output of the aggregation.AB
format(java.lang.String format)
Sets the format to use for the output of the aggregation.int
hashCode()
protected abstract org.elasticsearch.search.aggregations.bucket.composite.CompositeValuesSourceConfig
innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig<?> config)
Creates aCompositeValuesSourceConfig
for this source.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)
Iftrue
an explicitnull
bucket will represent documents with missing values.java.lang.String
name()
SortOrder
order()
Gets theSortOrder
to use to sort values produced this sourceAB
order(java.lang.String order)
Sets theSortOrder
to use to sort values produced this sourceAB
order(SortOrder order)
Sets theSortOrder
to use to sort values produced this sourceScript
script()
Gets the script to use for this sourceAB
script(Script script)
Sets the script to use for this sourceprotected java.time.ZoneId
timeZone()
The time zone for this value source.XContentBuilder
toXContent(XContentBuilder builder, ToXContent.Params params)
ValueType
valueType()
Gets theValueType
for the value produced by this sourceAB
valueType(ValueType valueType)
Sets theValueType
for the value produced by this sourcevoid
writeTo(StreamOutput out)
Write this into the StreamOutput.
-
Field Details
-
name
protected final java.lang.String name
-
-
Method Details
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
innerWriteTo
- Throws:
java.io.IOException
-
doXContentBody
protected abstract void doXContentBody(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Throws:
java.io.IOException
-
toXContent
public final XContentBuilder toXContent(XContentBuilder builder, ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceToXContent
- Throws:
java.io.IOException
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object o)- Overrides:
equals
in classjava.lang.Object
-
name
public java.lang.String name() -
field
Sets the field to use for this source -
field
public java.lang.String 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 -
valueType
Sets theValueType
for the value produced by this source -
valueType
Gets theValueType
for the value produced by this source -
missingBucket
Iftrue
an explicitnull
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
Sets theSortOrder
to use to sort values produced this source -
order
Sets theSortOrder
to use to sort values produced this source -
order
Gets theSortOrder
to use to sort values produced this source -
format
Sets the format to use for the output of the aggregation. -
format
public java.lang.String format()Gets the format to use for the output of the aggregation. -
innerBuild
protected abstract org.elasticsearch.search.aggregations.bucket.composite.CompositeValuesSourceConfig innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig<?> config) throws java.io.IOExceptionCreates aCompositeValuesSourceConfig
for this source.- Parameters:
queryShardContext
- The shard context for this source.config
- TheValuesSourceConfig
for this source.- Throws:
java.io.IOException
-
build
public final org.elasticsearch.search.aggregations.bucket.composite.CompositeValuesSourceConfig build(QueryShardContext queryShardContext) throws java.io.IOException- Throws:
java.io.IOException
-
timeZone
protected java.time.ZoneId timeZone()The time zone for this value source. Default implementation returnsnull
because most value source types don't support time zone.
-