com.cloudant.client.api.query

Interface Index<F extends Field>

All Known Implementing Classes:

com.cloudant.client.internal.query.InternalIndex, JsonIndex, TextIndex

public interface Index<F extends Field>

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDesignDocumentID()
java.util.List<F>	getFields()
java.lang.String	getName()
java.lang.String	getPartialFilterSelector() Get the JSON string representation of the selector configured for this index.
java.lang.String	getType()

Method Detail

getDesignDocumentID

java.lang.String getDesignDocumentID()

Returns:

the design document ID

getName

java.lang.String getName()

Returns:

the name of the index

getType

java.lang.String getType()

Returns:

the type of the index

getPartialFilterSelector

java.lang.String getPartialFilterSelector()

Get the JSON string representation of the selector configured for this index.

Returns:

selector JSON as string

getFields

java.util.List<F> getFields()

Returns:

the list of fields in the index