Class ArrayValuesSourceAggregationBuilder<AB extends ArrayValuesSourceAggregationBuilder<AB>>

java.lang.Object

org.opensearch.search.aggregations.AggregationBuilder

org.opensearch.search.aggregations.AbstractAggregationBuilder<AB>

org.opensearch.search.aggregations.support.ArrayValuesSourceAggregationBuilder<AB>

All Implemented Interfaces:

org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, Rewriteable<AggregationBuilder>, BaseAggregationBuilder

Direct Known Subclasses:

ArrayValuesSourceAggregationBuilder.LeafOnly

public abstract class ArrayValuesSourceAggregationBuilder<AB extends ArrayValuesSourceAggregationBuilder<AB>>
extends AbstractAggregationBuilder<AB>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ArrayValuesSourceAggregationBuilder.LeafOnly<AB extends ArrayValuesSourceAggregationBuilder<AB>>

Nested classes/interfaces inherited from class org.opensearch.search.aggregations.AggregationBuilder

AggregationBuilder.BucketCardinality, AggregationBuilder.CommonFields

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final org.opensearch.core.ParseField	MULTIVALUE_MODE_FIELD

Fields inherited from class org.opensearch.search.aggregations.AbstractAggregationBuilder

metadata

Fields inherited from class org.opensearch.search.aggregations.AggregationBuilder

factoriesBuilder, name

Fields inherited from interface org.opensearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ArrayValuesSourceAggregationBuilder(String name)
protected	ArrayValuesSourceAggregationBuilder(org.opensearch.core.common.io.stream.StreamInput in)
protected	ArrayValuesSourceAggregationBuilder(ArrayValuesSourceAggregationBuilder<AB> clone, AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
protected final ArrayValuesSourceAggregatorFactory	doBuild(QueryShardContext queryShardContext, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected final void	doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
protected abstract org.opensearch.core.xcontent.XContentBuilder	doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
boolean	equals(Object obj)
List<String>	fields()	Gets the field to use for this aggregation.
AB	fields(List<String> fields)	Sets the field to use for this aggregation.
String	format()	Gets the format to use for the output of the aggregation.
AB	format(String format)	Sets the format to use for the output of the aggregation.
int	hashCode()
protected abstract ArrayValuesSourceAggregatorFactory	innerBuild(QueryShardContext queryShardContext, Map<String, ValuesSourceConfig> configs, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected abstract void	innerWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)	Write subclass' state to the stream
final org.opensearch.core.xcontent.XContentBuilder	internalXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
Map<String,Object>	missingMap()	Gets the value to use when the aggregation finds a missing value in a document
AB	missingMap(Map<String,Object> missingMap)	Sets the value to use when the aggregation finds a missing value in a document
protected Map<String, ValuesSourceConfig>	resolveConfig(QueryShardContext queryShardContext)

Methods inherited from class org.opensearch.search.aggregations.AbstractAggregationBuilder

build, getMetadata, getWriteableName, setMetadata, subAggregation, subAggregation, subAggregations, toXContent, writeTo

Methods inherited from class org.opensearch.search.aggregations.AggregationBuilder

bucketCardinality, buildPipelineTree, doRewrite, getName, getPipelineAggregations, getSubAggregations, rewrite, shallowCopy, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.search.aggregations.BaseAggregationBuilder

getType

Methods inherited from interface org.opensearch.core.xcontent.ToXContentFragment

isFragment

Field Details

MULTIVALUE_MODE_FIELD

public static final org.opensearch.core.ParseField MULTIVALUE_MODE_FIELD

Constructor Details

ArrayValuesSourceAggregationBuilder

protected ArrayValuesSourceAggregationBuilder(String name)

ArrayValuesSourceAggregationBuilder

protected ArrayValuesSourceAggregationBuilder(ArrayValuesSourceAggregationBuilder<AB> clone,
 AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

ArrayValuesSourceAggregationBuilder

protected ArrayValuesSourceAggregationBuilder(org.opensearch.core.common.io.stream.StreamInput in)
                                       throws IOException

Throws:

IOException

Method Details

doWriteTo

protected final void doWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
                        throws IOException

Specified by:

doWriteTo in class AbstractAggregationBuilder<AB extends ArrayValuesSourceAggregationBuilder<AB>>

Throws:

IOException

innerWriteTo

protected abstract void innerWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
                              throws IOException

Write subclass' state to the stream

Throws:

IOException

fields

public AB fields(List<String> fields)

Sets the field to use for this aggregation.

fields

public List<String> fields()

Gets the field to use for this aggregation.

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.

missingMap

public AB missingMap(Map<String,Object> missingMap)

Sets the value to use when the aggregation finds a missing value in a document

missingMap

public Map<String,Object> missingMap()

Gets the value to use when the aggregation finds a missing value in a document

doBuild

protected final ArrayValuesSourceAggregatorFactory doBuild(QueryShardContext queryShardContext,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder)
                                                    throws IOException

Specified by:

doBuild in class AbstractAggregationBuilder<AB extends ArrayValuesSourceAggregationBuilder<AB>>

Throws:

IOException

resolveConfig

protected Map<String, ValuesSourceConfig> resolveConfig(QueryShardContext queryShardContext)

innerBuild

protected abstract ArrayValuesSourceAggregatorFactory innerBuild(QueryShardContext queryShardContext,
 Map<String, ValuesSourceConfig> configs,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder)
                                                          throws IOException

Throws:

IOException

internalXContent

public final org.opensearch.core.xcontent.XContentBuilder internalXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                                    throws IOException

Specified by:

internalXContent in class AbstractAggregationBuilder<AB extends ArrayValuesSourceAggregationBuilder<AB>>

Throws:

IOException

doXContentBody

protected abstract org.opensearch.core.xcontent.XContentBuilder doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                                        throws IOException

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class AbstractAggregationBuilder<AB extends ArrayValuesSourceAggregationBuilder<AB>>

equals

public boolean equals(Object obj)

Overrides:

equals in class AbstractAggregationBuilder<AB extends ArrayValuesSourceAggregationBuilder<AB>>