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

Class IndexAnalysisExclusionReason

java.lang.Object

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

com.ibm.cloud.cloudant.v1.model.IndexAnalysisExclusionReason

All Implemented Interfaces:

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

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

A reason for index's exclusion.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IndexAnalysisExclusionReason.Name	A reason code for index's exclusion.

Method Summary

Modifier and Type	Method	Description
String	getName()	Gets the name.

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

getName

public String getName()

Gets the name. A reason code for index's exclusion. The full list of possible reason codes is following: * alphabetically_comes_after: json There is another suitable index whose name comes before that of this index. * empty_selector: text "text" indexes do not support queries with empty selectors. * excluded_by_user: any use_index was used to manually specify the index. * field_mismatch: any Fields in "selector" of the query do match with the fields available in the index. * is_partial: json, text Partial indexes can be selected only manually. * less_overlap: json There is a better match of fields available within the indexes for the query. * needs_text_search: json The use of the $text operator requires a "text" index. * scope_mismatch: json The scope of the query and the index is not the same. * sort_order_mismatch: json, special Fields in "sort" of the query do not match with the fields available in the index. * too_many_fields: json The index has more fields than the chosen one. * unfavored_type: any The type of the index is not preferred.

Returns:

the name