IndexUnusedReason (BigQuery Parent 2.32.0 API)

java.lang.Object
- com.google.cloud.bigquery.IndexUnusedReason

All Implemented Interfaces:

Serializable
```
public abstract class IndexUnusedReason
extends Object
implements Serializable
```
Represents Reason of why the index was not used in a SQL search.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class IndexUnusedReason.Builder

Constructor Summary

Constructors
Constructor Description

IndexUnusedReason()

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract TableId`	`getBaseTableId()`	Returns the base table involved in the reason that no search index was used.
`abstract String`	`getCode()`	Returns the high-level reason for the scenario when no search index was used.
`abstract String`	`getIndexName()`	Returns the name of the unused search index, if available.
`abstract String`	`getMessage()`	Returns free form human-readable reason for the scenario when no search index was used.
`static IndexUnusedReason.Builder`	`newBuilder()`
`abstract IndexUnusedReason.Builder`	`toBuilder()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IndexUnusedReason
```
public IndexUnusedReason()
```
- Method Detail
  - toBuilder
```
public abstract IndexUnusedReason.Builder toBuilder()
```
  - newBuilder
```
public static IndexUnusedReason.Builder newBuilder()
```
  - getIndexName
```
@Nullable
public abstract String getIndexName()
```
    Returns the name of the unused search index, if available.
    
    Returns:
    
    value or null for none
  - getCode
```
@Nullable
public abstract String getCode()
```
    Returns the high-level reason for the scenario when no search index was used.
    
    Returns:
    
    value or null for none
  - getMessage
```
@Nullable
public abstract String getMessage()
```
    Returns free form human-readable reason for the scenario when no search index was used.
    
    Returns:
    
    value or null for none
  - getBaseTableId
```
@Nullable
public abstract TableId getBaseTableId()
```
    Returns the base table involved in the reason that no search index was used.
    
    Returns:
    
    value or null for none