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

Class ParsedGeoBounds

java.lang.Object

org.opensearch.search.aggregations.ParsedAggregation

org.opensearch.geo.search.aggregations.metrics.ParsedGeoBounds

All Implemented Interfaces:

org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment, GeoBounds, Aggregation

public class ParsedGeoBounds
extends ParsedAggregation
implements GeoBounds

A geo bounds agg result parsed between nodes

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.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.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
ParsedGeoBounds()

Method Summary

Modifier and Type	Method	Description
GeoPoint	bottomRight()	Get the bottom-right location of the bounding box.
org.opensearch.core.xcontent.XContentBuilder	doXContentBody(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
static ParsedGeoBounds	fromXContent(org.opensearch.core.xcontent.XContentParser parser, String name)
String	getType()
GeoPoint	topLeft()	Get the top-left location of the bounding box.

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

declareAggregationFields, getMetadata, getName, parseDouble, setName, 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

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

toXContent

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

isFragment

Constructor Details

ParsedGeoBounds

public ParsedGeoBounds()

Method Details

getType

public String getType()

Specified by:

getType in interface Aggregation

doXContentBody

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

Specified by:

doXContentBody in class ParsedAggregation

Throws:

IOException

topLeft

@Nullable
public GeoPoint topLeft()

Description copied from interface: GeoBounds

Get the top-left location of the bounding box.

Specified by:

topLeft in interface GeoBounds

bottomRight

@Nullable
public GeoPoint bottomRight()

Description copied from interface: GeoBounds

Get the bottom-right location of the bounding box.

Specified by:

bottomRight in interface GeoBounds

fromXContent

public static ParsedGeoBounds fromXContent(org.opensearch.core.xcontent.XContentParser parser,
 String name)