GeoIndexDefinition (IBM Cloudant Java SDK 0.0.31 API)

java.lang.Object
- com.ibm.cloud.sdk.core.service.model.GenericModel
- - com.ibm.cloud.cloudant.v1.model.GeoIndexDefinition

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel
```
public class GeoIndexDefinition
extends com.ibm.cloud.sdk.core.service.model.GenericModel
```
Schema for a geospatial index definition.

- Nested Class Summary
  
  Nested Classes
  Modifier and Type Class Description
  
  static class GeoIndexDefinition.Builder
  Builder.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  String index()
  Gets the index.
  
  GeoIndexDefinition.Builder newBuilder()
  New builder.
  - 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

- Method Detail
  - newBuilder
```
public GeoIndexDefinition.Builder newBuilder()
```
    New builder.
    
    Returns:
    
    a GeoIndexDefinition builder
  - index
```
public String index()
```
    Gets the index. String form of a JavaScript function that is called for each document in the database. The function takes the document as a parameter, extracts some geospatial data from it, and then calls the `st_index` function to index that data. The `st_index` takes a GeoJSON geometry as a parameter.
    
    Returns:
    
    the index