Package com.google.cloud.bigquery

Class IndexUnusedReason

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:

  • Constructor Details

    • IndexUnusedReason

      public IndexUnusedReason()

  • Method Details

    • 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