Package org.opensearch.plugins

Class SearchPlugin.AggregationSpec

java.lang.Object

org.opensearch.plugins.SearchPlugin.SearchExtensionSpec<AggregationBuilder,org.opensearch.common.xcontent.ContextParser<java.lang.String,? extends AggregationBuilder>>

org.opensearch.plugins.SearchPlugin.AggregationSpec

Enclosing interface:

SearchPlugin

public static class SearchPlugin.AggregationSpec
extends SearchPlugin.SearchExtensionSpec<AggregationBuilder,org.opensearch.common.xcontent.ContextParser<java.lang.String,? extends AggregationBuilder>>

Specification for an Aggregation.

Constructor Summary

Constructors

Constructor	Description
AggregationSpec(java.lang.String name, Writeable.Reader<? extends AggregationBuilder> reader, Aggregator.Parser parser)	Deprecated. Use the ctor that takes a ContextParser instead
AggregationSpec(java.lang.String name, Writeable.Reader<T> reader, org.opensearch.common.xcontent.ContextParser<java.lang.String,T> parser)	Specification for an Aggregation.
AggregationSpec(org.opensearch.common.ParseField name, Writeable.Reader<? extends AggregationBuilder> reader, Aggregator.Parser parser)	Deprecated. Use the ctor that takes a ContextParser instead
AggregationSpec(org.opensearch.common.ParseField name, Writeable.Reader<T> reader, org.opensearch.common.xcontent.ContextParser<java.lang.String,T> parser)	Specification for an Aggregation.

Method Summary

Modifier and Type	Method	Description
SearchPlugin.AggregationSpec	addResultReader(java.lang.String writeableName, Writeable.Reader<? extends InternalAggregation> resultReader)	Add a reader for the shard level results of the aggregation.
SearchPlugin.AggregationSpec	addResultReader(Writeable.Reader<? extends InternalAggregation> resultReader)	Add a reader for the shard level results of the aggregation with SearchPlugin.SearchExtensionSpec.getName()'s ParseField.getPreferredName() as the NamedWriteable.getWriteableName().
java.util.function.Consumer<ValuesSourceRegistry.Builder>	getAggregatorRegistrar()	Get the function to register the ValuesSource to aggregator mappings for this aggregation
java.util.Map<java.lang.String,Writeable.Reader<? extends InternalAggregation>>	getResultReaders()	Get the readers that must be registered for this aggregation's results.
SearchPlugin.AggregationSpec	setAggregatorRegistrar(java.util.function.Consumer<ValuesSourceRegistry.Builder> aggregatorRegistrar)	Set the function to register the ValuesSource to aggregator mappings for this aggregation

Methods inherited from class org.opensearch.plugins.SearchPlugin.SearchExtensionSpec

getName, getParser, getReader

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AggregationSpec

public AggregationSpec(org.opensearch.common.ParseField name, Writeable.Reader<T> reader, org.opensearch.common.xcontent.ContextParser<java.lang.String,T> parser)

Specification for an Aggregation.

Parameters:

name - holds the names by which this aggregation might be parsed. The ParseField.getPreferredName() is special as it is the name by under which the reader is registered. So it is the name that the AggregationBuilder should return from NamedWriteable.getWriteableName().

reader - the reader registered for this aggregation's builder. Typically a reference to a constructor that takes a StreamInput

parser - the parser the reads the aggregation builder from xcontent

AggregationSpec

public AggregationSpec(java.lang.String name, Writeable.Reader<T> reader, org.opensearch.common.xcontent.ContextParser<java.lang.String,T> parser)

Specification for an Aggregation.

Parameters:

name - the name by which this aggregation might be parsed or deserialized. Make sure that the AggregationBuilder returns this from NamedWriteable.getWriteableName().

reader - the reader registered for this aggregation's builder. Typically a reference to a constructor that takes a StreamInput

parser - the parser the reads the aggregation builder from xcontent

AggregationSpec

@Deprecated public AggregationSpec(org.opensearch.common.ParseField name, Writeable.Reader<? extends AggregationBuilder> reader, Aggregator.Parser parser)

Deprecated.

Use the ctor that takes a ContextParser instead

Specification for an Aggregation.

Parameters:

name - holds the names by which this aggregation might be parsed. The ParseField.getPreferredName() is special as it is the name by under which the reader is registered. So it is the name that the AggregationBuilder should return from NamedWriteable.getWriteableName().

reader - the reader registered for this aggregation's builder. Typically a reference to a constructor that takes a StreamInput

parser - the parser the reads the aggregation builder from xcontent

AggregationSpec

@Deprecated public AggregationSpec(java.lang.String name, Writeable.Reader<? extends AggregationBuilder> reader, Aggregator.Parser parser)

Deprecated.

Use the ctor that takes a ContextParser instead

Specification for an Aggregation.

Parameters:

name - the name by which this aggregation might be parsed or deserialized. Make sure that the AggregationBuilder returns this from NamedWriteable.getWriteableName().

reader - the reader registered for this aggregation's builder. Typically a reference to a constructor that takes a StreamInput

parser - the parser the reads the aggregation builder from xcontent

Method Details

addResultReader

public SearchPlugin.AggregationSpec addResultReader(Writeable.Reader<? extends InternalAggregation> resultReader)

Add a reader for the shard level results of the aggregation with SearchPlugin.SearchExtensionSpec.getName()'s ParseField.getPreferredName() as the NamedWriteable.getWriteableName().

addResultReader

public SearchPlugin.AggregationSpec addResultReader(java.lang.String writeableName, Writeable.Reader<? extends InternalAggregation> resultReader)

Add a reader for the shard level results of the aggregation.

getResultReaders

public java.util.Map<java.lang.String,Writeable.Reader<? extends InternalAggregation>> getResultReaders()

Get the readers that must be registered for this aggregation's results.

getAggregatorRegistrar

public java.util.function.Consumer<ValuesSourceRegistry.Builder> getAggregatorRegistrar()

Get the function to register the ValuesSource to aggregator mappings for this aggregation

setAggregatorRegistrar

public SearchPlugin.AggregationSpec setAggregatorRegistrar(java.util.function.Consumer<ValuesSourceRegistry.Builder> aggregatorRegistrar)

Set the function to register the ValuesSource to aggregator mappings for this aggregation