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 java.lang.Object 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 java.lang.String
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
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.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)
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.org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
ValueType
userValuetypeHint()
Gets theValueType
for the value produced by this sourceAB
userValuetypeHint(ValueType valueType)
Sets theValueType
for the value produced by this sourcevoid
writeTo(StreamOutput out)
Write this into the StreamOutput.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment
isFragment
-
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(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Throws:
java.io.IOException
-
toXContent
public final org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- 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 -
userValuetypeHint
Sets theValueType
for the value produced by this source -
userValuetypeHint
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 CompositeValuesSourceConfig innerBuild(ValuesSourceRegistry registry, ValuesSourceConfig config) throws java.io.IOExceptionActually build the values source and its associated configuration.- Throws:
java.io.IOException
-
getDefaultValuesSourceType
-
build
public final CompositeValuesSourceConfig build(AggregationContext context) 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.
-