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

Class IndexAnalysis

java.lang.Object

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

com.ibm.cloud.cloudant.v1.model.IndexAnalysis

All Implemented Interfaces:

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

public class IndexAnalysis
extends com.ibm.cloud.sdk.core.service.model.GenericModel

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

Method Summary

Modifier and Type	Method	Description
Long	getRanking()	Gets the ranking.
List<IndexAnalysisExclusionReason>	getReasons()	Gets the reasons.
Boolean	isCovering()	Gets the covering.
Boolean	isUsable()	Gets the usable.

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

isCovering

public Boolean isCovering()

Gets the covering. When `true`, the query is answered using the index only and no documents are fetched.

Returns:

the covering

getRanking

public Long getRanking()

Gets the ranking. A position of the unused index based on its potential relevance to the query.

Returns:

the ranking

getReasons

public List<IndexAnalysisExclusionReason> getReasons()

Gets the reasons. A list of reasons explaining why index was not chosen for the query.

Returns:

the reasons

isUsable

public Boolean isUsable()

Gets the usable. Indicates whether an index can still be used for the query.

Returns:

the usable