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

Class IndexInformation

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.cloudant.v1.model.IndexInformation

All Implemented Interfaces:

ObjectModel

public class IndexInformation
extends GenericModel

Schema for information about an index.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IndexInformation.Type	Schema for the type of an index.

Method Summary

Modifier and Type	Method	Description
String	getDdoc()	Gets the ddoc.
IndexDefinition	getDef()	Gets the def.
String	getName()	Gets the name.
String	getType()	Gets the type.
Boolean	isPartitioned()	Gets the partitioned.

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 Details

getDdoc

public String getDdoc()

Gets the ddoc. Schema for a nullable design document ID including a `_design/` prefix.

Returns:

the ddoc

getDef

public IndexDefinition getDef()

Gets the def. Schema for a `json` or `text` query index definition. Indexes of type `text` have additional configuration properties that do not apply to `json` indexes, these are: * `default_analyzer` - the default text analyzer to use * `default_field` - whether to index the text in all document fields and what analyzer to use for that purpose.

Returns:

the def

getName

public String getName()

Gets the name. Index name.

Returns:

the name

isPartitioned

public Boolean isPartitioned()

Gets the partitioned. Indicates if index is partitioned.

Returns:

the partitioned

getType

public String getType()

Gets the type. Schema for the type of an index.

Returns:

the type