Package org.opensearch.search.aggregations.bucket.composite

Class GeoTileGridValuesSourceBuilder

java.lang.Object

org.opensearch.search.aggregations.bucket.composite.CompositeValuesSourceBuilder<GeoTileGridValuesSourceBuilder>

org.opensearch.search.aggregations.bucket.composite.GeoTileGridValuesSourceBuilder

All Implemented Interfaces:

Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentFragment

public class GeoTileGridValuesSourceBuilder
extends CompositeValuesSourceBuilder<GeoTileGridValuesSourceBuilder>

Builds values source for geotile_grid agg

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GeoTileGridValuesSourceBuilder.GeoTileCompositeSuppier	Supplier for a composite geotile

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

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

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

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields inherited from class org.opensearch.search.aggregations.bucket.composite.CompositeValuesSourceBuilder

name

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
protected void	doXContentBody(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
boolean	equals(Object obj)
GeoTileGridValuesSourceBuilder	format(String format)	Sets the format to use for the output of the aggregation.
GeoTileGridValuesSourceBuilder	geoBoundingBox(GeoBoundingBox geoBoundingBox)
protected ValuesSourceType	getDefaultValuesSourceType()
int	hashCode()
protected CompositeValuesSourceConfig	innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig config)	Creates a CompositeValuesSourceConfig for this source.
protected void	innerWriteTo(StreamOutput out)
GeoTileGridValuesSourceBuilder	precision(int precision)

Methods inherited from class org.opensearch.search.aggregations.bucket.composite.CompositeValuesSourceBuilder

build, field, field, format, missingBucket, missingBucket, missingOrder, missingOrder, missingOrder, name, order, order, order, script, script, timeZone, toXContent, userValuetypeHint, userValuetypeHint, writeTo

Methods inherited from class java.lang.Object

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

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

isFragment

Method Details

precision

public GeoTileGridValuesSourceBuilder precision(int precision)

geoBoundingBox

public GeoTileGridValuesSourceBuilder geoBoundingBox(GeoBoundingBox geoBoundingBox)

format

public GeoTileGridValuesSourceBuilder format(String format)

Description copied from class: CompositeValuesSourceBuilder

Sets the format to use for the output of the aggregation.

Overrides:

format in class CompositeValuesSourceBuilder<GeoTileGridValuesSourceBuilder>

innerWriteTo

protected void innerWriteTo(StreamOutput out)
                     throws IOException

Specified by:

innerWriteTo in class CompositeValuesSourceBuilder<GeoTileGridValuesSourceBuilder>

Throws:

IOException

doXContentBody

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

Specified by:

doXContentBody in class CompositeValuesSourceBuilder<GeoTileGridValuesSourceBuilder>

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class CompositeValuesSourceBuilder<GeoTileGridValuesSourceBuilder>

equals

public boolean equals(Object obj)

Overrides:

equals in class CompositeValuesSourceBuilder<GeoTileGridValuesSourceBuilder>

getDefaultValuesSourceType

protected ValuesSourceType getDefaultValuesSourceType()

Specified by:

getDefaultValuesSourceType in class CompositeValuesSourceBuilder<GeoTileGridValuesSourceBuilder>

innerBuild

protected CompositeValuesSourceConfig innerBuild(QueryShardContext queryShardContext,
 ValuesSourceConfig config)
                                          throws IOException

Description copied from class: CompositeValuesSourceBuilder

Creates a CompositeValuesSourceConfig for this source.

Specified by:

innerBuild in class CompositeValuesSourceBuilder<GeoTileGridValuesSourceBuilder>

Parameters:

queryShardContext - The shard context for this source.

config - The ValuesSourceConfig for this source.

Throws:

IOException