public class TextIndex extends com.cloudant.client.internal.query.InternalIndex<com.cloudant.client.api.query.TextIndex.Definition,TextIndex.Field>
Class model of a text index definition.
This class should not be instantiated directly, use TextIndex.Builder
to create a text
index definition string to pass to Database.createIndex(String)
or use Database.listIndexes()
and Indexes.textIndexes()
to retrieve existing
text index definitions.
Database.createIndex(String)
Modifier and Type | Class and Description |
---|---|
static class |
TextIndex.Builder
Class for building a definition for a text type index.
|
static class |
TextIndex.Field
Model of a field in the text index including the field name and type.
|
Modifier and Type | Method and Description |
---|---|
static TextIndex.Builder |
builder()
Get a new instance of a builder to configure a TextIndex.
|
java.lang.String |
getAnalyzer()
Get the JSON string representation of the analyzer configured for this text index.
|
java.lang.String |
getDefaultField()
Get the JSON string representation of the default field configuration.
|
boolean |
getIndexArrayLengths() |
public static TextIndex.Builder builder()
public java.lang.String getDefaultField()
public java.lang.String getAnalyzer()
public boolean getIndexArrayLengths()