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

Class IndexCandidate

java.lang.Object

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

com.ibm.cloud.cloudant.v1.model.IndexCandidate

All Implemented Interfaces:

ObjectModel

public class IndexCandidate
extends GenericModel

Schema for an index that was not chosen for serving the query with the reason for the exclusion.

Method Summary

Modifier and Type	Method	Description
IndexAnalysis	getAnalysis()	Gets the analysis.
IndexInformation	getIndex()	Gets the index.

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

getAnalysis

public IndexAnalysis getAnalysis()

Gets the analysis. Schema for detailed explanation of why the specific index was excluded by the query planner.

Returns:

the analysis

getIndex

public IndexInformation getIndex()

Gets the index. Schema for information about an index.

Returns:

the index