Package org.opensearch.search.aggregations.matrix.stats

Class MatrixStatsAggregationBuilder

java.lang.Object

org.opensearch.search.aggregations.AggregationBuilder

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

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

org.opensearch.search.aggregations.support.ArrayValuesSourceAggregationBuilder.LeafOnly<MatrixStatsAggregationBuilder>

org.opensearch.search.aggregations.matrix.stats.MatrixStatsAggregationBuilder

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

public class MatrixStatsAggregationBuilder
extends ArrayValuesSourceAggregationBuilder.LeafOnly<MatrixStatsAggregationBuilder>

Nested Class Summary

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

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 String	NAME

Fields inherited from class org.opensearch.search.aggregations.support.ArrayValuesSourceAggregationBuilder

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
	MatrixStatsAggregationBuilder(String name)
	MatrixStatsAggregationBuilder(org.opensearch.core.common.io.stream.StreamInput in)	Read from a stream.
protected	MatrixStatsAggregationBuilder(MatrixStatsAggregationBuilder clone, AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Method Summary

Modifier and Type	Method	Description
org.opensearch.core.xcontent.XContentBuilder	doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
String	getType()
protected org.opensearch.search.aggregations.matrix.stats.MatrixStatsAggregatorFactory	innerBuild(QueryShardContext queryShardContext, Map<String,ValuesSourceConfig> configs, AggregatorFactory parent, AggregatorFactories.Builder subFactoriesBuilder)
protected void	innerWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)	Write subclass' state to the stream
MultiValueMode	multiValueMode()
MatrixStatsAggregationBuilder	multiValueMode(MultiValueMode multiValueMode)
protected AggregationBuilder	shallowCopy(AggregatorFactories.Builder factoriesBuilder, Map<String,Object> metadata)

Methods inherited from class org.opensearch.search.aggregations.support.ArrayValuesSourceAggregationBuilder.LeafOnly

bucketCardinality, subAggregations

Methods inherited from class org.opensearch.search.aggregations.support.ArrayValuesSourceAggregationBuilder

doBuild, doWriteTo, equals, fields, fields, format, format, hashCode, internalXContent, missingMap, missingMap, resolveConfig

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

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

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

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

Methods inherited from class java.lang.Object

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

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

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

MatrixStatsAggregationBuilder

public MatrixStatsAggregationBuilder(String name)

MatrixStatsAggregationBuilder

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

MatrixStatsAggregationBuilder

public MatrixStatsAggregationBuilder(org.opensearch.core.common.io.stream.StreamInput in)
                              throws IOException

Read from a stream.

Throws:

IOException

Method Details

shallowCopy

protected AggregationBuilder shallowCopy(AggregatorFactories.Builder factoriesBuilder,
 Map<String,Object> metadata)

Specified by:

shallowCopy in class AggregationBuilder

innerWriteTo

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

Description copied from class: ArrayValuesSourceAggregationBuilder

Write subclass' state to the stream

Specified by:

innerWriteTo in class ArrayValuesSourceAggregationBuilder<MatrixStatsAggregationBuilder>

multiValueMode

public MatrixStatsAggregationBuilder multiValueMode(MultiValueMode multiValueMode)

multiValueMode

public MultiValueMode multiValueMode()

innerBuild

protected org.opensearch.search.aggregations.matrix.stats.MatrixStatsAggregatorFactory innerBuild(QueryShardContext queryShardContext,
 Map<String,ValuesSourceConfig> configs,
 AggregatorFactory parent,
 AggregatorFactories.Builder subFactoriesBuilder)
                                                                                           throws IOException

Specified by:

innerBuild in class ArrayValuesSourceAggregationBuilder<MatrixStatsAggregationBuilder>

Throws:

IOException

doXContentBody

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

Specified by:

doXContentBody in class ArrayValuesSourceAggregationBuilder<MatrixStatsAggregationBuilder>

Throws:

IOException

getType

public String getType()