Package org.opensearch.geo.search.aggregations.metrics

Interface GeoBounds

All Superinterfaces:

Aggregation, ToXContent, ToXContentFragment

All Known Implementing Classes:

InternalGeoBounds, ParsedGeoBounds

public interface GeoBounds
extends Aggregation

An aggregation that computes a bounding box in which all documents of the current bucket are.

Opensearch.internal:

Nested Class Summary

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

Aggregation.CommonFields

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

TYPED_KEYS_DELIMITER

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
GeoPoint	bottomRight()	Get the bottom-right location of the bounding box.
GeoPoint	topLeft()	Get the top-left location of the bounding box.

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

getMetadata, getName, getType

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

toXContent

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

isFragment

Method Details

topLeft

GeoPoint topLeft()

Get the top-left location of the bounding box.

bottomRight

GeoPoint bottomRight()

Get the bottom-right location of the bounding box.