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

Class GetGeoOptions

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.cloud.cloudant.v1.model.GetGeoOptions
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class GetGeoOptions extends com.ibm.cloud.sdk.core.service.model.GenericModel
The getGeo options.

  • Method Details

    • newBuilder

      public GetGeoOptions.Builder newBuilder()
      New builder.
      Returns:
      a GetGeoOptions builder

    • db

      public String db()
      Gets the db. Path parameter to specify the database name.
      Returns:
      the db

    • ddoc

      public String ddoc()
      Gets the ddoc. Path parameter to specify the design document name. The design document name is the design document ID excluding the `_design/` prefix.
      Returns:
      the ddoc

    • index

      public String index()
      Gets the index. Path parameter to specify the index name.
      Returns:
      the index

    • bbox

      public String bbox()
      Gets the bbox. Query parameter to specify a geospatial query bounding box with two latitude,longitude coordinates for the lower-left and upper-right corners. An example is `-11.05987446,12.28339928,-101.05987446,62.28339928`.
      Returns:
      the bbox

    • bookmark

      public String bookmark()
      Gets the bookmark. Query parameter to specify a bookmark that was received from a previous request. This parameter enables paging through the results. If there are no more results after the bookmark, you get a response containing no further results and the same bookmark, confirming the end of the result list.
      Returns:
      the bookmark

    • format

      public String format()
      Gets the format. Query parameter that causes the geospatial query output to be returned in the specified format.
      Returns:
      the format

    • g

      public String g()
      Gets the g. Query parameter to specify a Well Known Text (WKT) representation of a geospatial query geometry. The valid values for the WKT parameter include `Point`, `LineString`, `Polygon`, `MultiPoint`, `MultiLineString`, `MultiPolygon`, and `GeometryCollection`.
      Returns:
      the g

    • includeDocs

      public Boolean includeDocs()
      Gets the includeDocs. Query parameter to specify whether to include the full content of the documents in the response.
      Returns:
      the includeDocs

    • lat

      public Double lat()
      Gets the lat. Query parameter to specify a latitude coordinate for use with radius or ellipse geospatial queries.
      Returns:
      the lat

    • limit

      public Long limit()
      Gets the limit. Query parameter to specify the number of returned documents to limit the result to.
      Returns:
      the limit

    • lon

      public Double lon()
      Gets the lon. Query parameter to specify a longitude coordinate for use with radius or ellipse geospatial queries.
      Returns:
      the lon

    • nearest

      public Boolean nearest()
      Gets the nearest. Query parameter to specify whether to perform a nearest neighbour (NN) search. If provided, the `nearest=true` search returns all results by sorting their distances to the center of the query geometry. NN search can be used alone or with any of the supported DE-9IM (Dimensionally Extended nine-Intersection Model) specification geometric relations documented.
      Returns:
      the nearest

    • radius

      public Double radius()
      Gets the radius. Query parameter to specify the radius, in meters, to search from a lat,lon coordinate point in a circular geospatial query.
      Returns:
      the radius

    • rangex

      public Double rangex()
      Gets the rangex. Query parameter to specify the first radius, in meters, to search from a lat,lon coordinate point in an ellipse geospatial query.
      Returns:
      the rangex

    • rangey

      public Double rangey()
      Gets the rangey. Query parameter to specify the second radius, in meters, to search from a lat,lon coordinate point in an ellipse geospatial query.
      Returns:
      the rangey

    • relation

      public String relation()
      Gets the relation. Query parameter to specify the DE-9IM (Dimensionally Extended nine-Intersection Model)geospatial relationship between the query geometry and the result documents.
      Returns:
      the relation

    • skip

      public Long skip()
      Gets the skip. Query parameter to specify the number of records before starting to return the results.
      Returns:
      the skip

    • stale

      public String stale()
      Gets the stale. Query parameter to specify to not wait for the index to finish building before returning results.
      Returns:
      the stale