Package com.ibm.cloud.cloudant.v1.model

Class GeoResult

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.cloudant.v1.model.GeoResult

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class GeoResult
extends com.ibm.cloud.sdk.core.service.model.GenericModel

Schema for the result of a geospatial query operation. For the `legacy`, `geojson`, or `application/vnd.geo+json` format this is a GeoJson FeatureCollection with additional metadata in foreign members.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GeoResult.Type	Declaration of the GeoJSON type: FeatureCollection Object.

Constructor Summary

Constructors

Constructor	Description
GeoResult()

Method Summary

Modifier and Type	Method	Description
String	getBookmark()	Gets the bookmark.
List<GeoJsonFeature>	getFeatures()	Gets the features.
List<GeoResultRow>	getRows()	Gets the rows.
String	getType()	Gets the type.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

GeoResult

public GeoResult()

Method Details

getBookmark

public String getBookmark()

Gets the bookmark. Opaque bookmark token used when paginating results.

Returns:

the bookmark

getFeatures

public List<GeoJsonFeature> getFeatures()

Gets the features. The array of GeoJSON Feature Objects matching the geospatial query.

Returns:

the features

getRows

public List<GeoResultRow> getRows()

Gets the rows. The array of rows matching the geospatial query. Present only when using `view` format.

Returns:

the rows

getType

public String getType()

Gets the type. Declaration of the GeoJSON type: FeatureCollection Object.

Returns:

the type