Class IndexUnusedReason.Builder (2.38.2)

public abstract static class IndexUnusedReason.Builder

Inheritance

java.lang.Object > IndexUnusedReason.Builder

Constructors

Builder()

public Builder()

Methods

build()

public abstract IndexUnusedReason build()

Creates a @code IndexUnusedReason} object.

Returns
TypeDescription
IndexUnusedReason

setBaseTableId(TableId baseTable)

public abstract IndexUnusedReason.Builder setBaseTableId(TableId baseTable)

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

Parameter
NameDescription
baseTableTableId

baseTable or null for none

Returns
TypeDescription
IndexUnusedReason.Builder

setCode(String code)

public abstract IndexUnusedReason.Builder setCode(String code)

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

Parameter
NameDescription
codeString

code or null for none

Returns
TypeDescription
IndexUnusedReason.Builder

setIndexName(String indexName)

public abstract IndexUnusedReason.Builder setIndexName(String indexName)

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

Parameter
NameDescription
indexNameString

indexName or null for none

Returns
TypeDescription
IndexUnusedReason.Builder

setMessage(String message)

public abstract IndexUnusedReason.Builder setMessage(String message)

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

Parameter
NameDescription
messageString

message or null for none

Returns
TypeDescription
IndexUnusedReason.Builder