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

Class ParsedGeoGrid

java.lang.Object

org.opensearch.search.aggregations.ParsedAggregation

org.opensearch.search.aggregations.ParsedMultiBucketAggregation<ParsedGeoGridBucket>

org.opensearch.geo.search.aggregations.bucket.geogrid.ParsedGeoGrid

All Implemented Interfaces:

org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, GeoGrid, Aggregation, MultiBucketsAggregation

Direct Known Subclasses:

ParsedGeoHashGrid, ParsedGeoTileGrid

public abstract class ParsedGeoGrid
extends ParsedMultiBucketAggregation<ParsedGeoGridBucket>
implements GeoGrid

A geo grid result parsed between nodes

Opensearch.internal:

Nested Class Summary

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

ParsedMultiBucketAggregation.ParsedBucket

Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.Aggregation

Aggregation.CommonFields

Nested classes/interfaces inherited from interface org.opensearch.geo.search.aggregations.bucket.geogrid.GeoGrid

GeoGrid.Bucket

Nested classes/interfaces inherited from interface org.opensearch.search.aggregations.bucket.MultiBucketsAggregation

MultiBucketsAggregation.Bucket

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

Field Summary

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

buckets, keyed

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

metadata

Fields inherited from interface org.opensearch.search.aggregations.Aggregation

TYPED_KEYS_DELIMITER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ParsedGeoGrid()

Method Summary

Modifier and Type	Method	Description
static org.opensearch.core.xcontent.ObjectParser<ParsedGeoGrid,Void>	createParser(Supplier<ParsedGeoGrid> supplier, CheckedFunction<org.opensearch.core.xcontent.XContentParser,ParsedMultiBucketAggregation.ParsedBucket,IOException> bucketParser, CheckedFunction<org.opensearch.core.xcontent.XContentParser,ParsedMultiBucketAggregation.ParsedBucket,IOException> keyedBucketParser)
List<? extends GeoGrid.Bucket>	getBuckets()
void	setName(String name)

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

declareMultiBucketAggregationFields, doXContentBody

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

declareAggregationFields, getMetadata, getName, parseDouble, toXContent

Methods inherited from class java.lang.Object

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

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

getMetadata, getName, getType

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

toXContent

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

isFragment

Constructor Details

ParsedGeoGrid

public ParsedGeoGrid()

Method Details

getBuckets

public List<? extends GeoGrid.Bucket> getBuckets()

Specified by:

getBuckets in interface GeoGrid

Specified by:

getBuckets in interface MultiBucketsAggregation

Returns:

The buckets of this aggregation (each bucket representing a geo-grid cell)

createParser

public static org.opensearch.core.xcontent.ObjectParser<ParsedGeoGrid,Void> createParser(Supplier<ParsedGeoGrid> supplier,
 CheckedFunction<org.opensearch.core.xcontent.XContentParser,ParsedMultiBucketAggregation.ParsedBucket,IOException> bucketParser,
 CheckedFunction<org.opensearch.core.xcontent.XContentParser,ParsedMultiBucketAggregation.ParsedBucket,IOException> keyedBucketParser)

setName

public void setName(String name)

Overrides:

setName in class ParsedAggregation