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

Class GeoTileGridValuesSourceBuilder

java.lang.Object

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

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

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.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.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 Byte	COMPOSITE_AGGREGATION_SERIALISATION_BYTE_CODE	Deprecated.
static final String	TYPE

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

name

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
GeoTileGridValuesSourceBuilder(org.opensearch.core.common.io.stream.StreamInput in)

Method Summary

Modifier and Type	Method	Description
protected void	doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
boolean	equals(Object obj)
GeoTileGridValuesSourceBuilder	format(String format)
GeoTileGridValuesSourceBuilder	geoBoundingBox(GeoBoundingBox geoBoundingBox)
protected ValuesSourceType	getDefaultValuesSourceType()
int	hashCode()
protected CompositeValuesSourceConfig	innerBuild(QueryShardContext queryShardContext, ValuesSourceConfig config)
protected void	innerWriteTo(org.opensearch.core.common.io.stream.StreamOutput out)
static GeoTileGridValuesSourceBuilder	parse(String name, org.opensearch.core.xcontent.XContentParser parser)
GeoTileGridValuesSourceBuilder	precision(int precision)
static void	register(ValuesSourceRegistry.Builder builder)
protected String	type()

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.core.xcontent.ToXContentFragment

isFragment

Field Details

TYPE

public static final String TYPE

See Also:

• Constant Field Values

COMPOSITE_AGGREGATION_SERIALISATION_BYTE_CODE

@Deprecated
public static final Byte COMPOSITE_AGGREGATION_SERIALISATION_BYTE_CODE

Deprecated.

Constructor Details

GeoTileGridValuesSourceBuilder

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

Throws:

IOException

Method Details

parse

public static GeoTileGridValuesSourceBuilder parse(String name,
 org.opensearch.core.xcontent.XContentParser parser)
                                            throws IOException

Throws:

IOException

register

public static void register(ValuesSourceRegistry.Builder builder)

precision

public GeoTileGridValuesSourceBuilder precision(int precision)

geoBoundingBox

public GeoTileGridValuesSourceBuilder geoBoundingBox(GeoBoundingBox geoBoundingBox)

format

public GeoTileGridValuesSourceBuilder format(String format)

Overrides:

format in class CompositeValuesSourceBuilder<GeoTileGridValuesSourceBuilder>

innerWriteTo

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

Specified by:

innerWriteTo in class CompositeValuesSourceBuilder<GeoTileGridValuesSourceBuilder>

Throws:

IOException

doXContentBody

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

Specified by:

doXContentBody in class CompositeValuesSourceBuilder<GeoTileGridValuesSourceBuilder>

Throws:

IOException

type

protected String type()

Specified by:

type in class CompositeValuesSourceBuilder<GeoTileGridValuesSourceBuilder>

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

Specified by:

innerBuild in class CompositeValuesSourceBuilder<GeoTileGridValuesSourceBuilder>

Throws:

IOException