Class IndexUnusedReason (2.37.2) 

public abstract class IndexUnusedReason implements Serializable

Represents Reason of why the index was not used in a SQL search.

Inheritance

java.lang.Object > IndexUnusedReason

Implements

Serializable

Static Methods

newBuilder()

public static IndexUnusedReason.Builder newBuilder()
Returns
Type Description
IndexUnusedReason.Builder

Constructors

IndexUnusedReason()

public IndexUnusedReason()

Methods

getBaseTableId()

public abstract TableId getBaseTableId()

Returns the base table involved in the reason that no search index was used.

Returns
Type Description
TableId

value or null for none

getCode()

public abstract String getCode()

Returns the high-level reason for the scenario when no search index was used.

Returns
Type Description
String

value or null for none

getIndexName()

public abstract String getIndexName()

Returns the name of the unused search index, if available.

Returns
Type Description
String

value or null for none

getMessage()

public abstract String getMessage()

Returns free form human-readable reason for the scenario when no search index was used.

Returns
Type Description
String

value or null for none

toBuilder()

public abstract IndexUnusedReason.Builder toBuilder()
Returns
Type Description
IndexUnusedReason.Builder