com.cloudant.client.api.query

Class JsonIndex

java.lang.Object

com.cloudant.client.internal.query.InternalIndex<com.cloudant.client.api.query.JsonIndex.Definition,JsonIndex.Field>

com.cloudant.client.api.query.JsonIndex

All Implemented Interfaces:

Index<JsonIndex.Field>

public class JsonIndex
extends com.cloudant.client.internal.query.InternalIndex<com.cloudant.client.api.query.JsonIndex.Definition,JsonIndex.Field>

Class model of a JSON index definition.

This class should not be instantiated directly, use JsonIndex.Builder to create an index definition string to pass to Database.createIndex(String) or use Database.listIndexes() and Indexes.jsonIndexes() to retrieve existing JSON index definitions.

See Also:

Database.createIndex(String)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JsonIndex.Builder Class for building a definition for a JSON type index.
static class	JsonIndex.Field Model of a field in a JSON index including the field name and sort order.

Field Summary

Fields inherited from class com.cloudant.client.internal.query.InternalIndex

ddoc, def, name

Method Summary

Modifier and Type	Method and Description
static JsonIndex.Builder	builder() Get a new instance of a builder to configure a JsonIndex.

Methods inherited from class com.cloudant.client.internal.query.InternalIndex

getDesignDocumentID, getFields, getName, getPartialFilterSelector, getType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static JsonIndex.Builder builder()

Get a new instance of a builder to configure a JsonIndex.

Returns:

a builder for configuring a JsonIndex