com.google.api.services.bigquery.model

Class SearchStatistics

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.bigquery.model.SearchStatistics

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SearchStatistics
extends com.google.api.client.json.GenericJson

Statistics for a search query. Populated as part of JobStatistics2.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the BigQuery API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
SearchStatistics()

Method Summary

Modifier and Type	Method and Description
SearchStatistics	clone()
List<IndexPruningStats>	getIndexPruningStats() Search index pruning statistics, one for each base table that has a search index.
List<IndexUnusedReason>	getIndexUnusedReasons() When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the search query.
String	getIndexUsageMode() Specifies the index usage mode for the query.
SearchStatistics	set(String fieldName, Object value)
SearchStatistics	setIndexPruningStats(List<IndexPruningStats> indexPruningStats) Search index pruning statistics, one for each base table that has a search index.
SearchStatistics	setIndexUnusedReasons(List<IndexUnusedReason> indexUnusedReasons) When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the search query.
SearchStatistics	setIndexUsageMode(String indexUsageMode) Specifies the index usage mode for the query.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

SearchStatistics

public SearchStatistics()

Method Detail

getIndexPruningStats

public List<IndexPruningStats> getIndexPruningStats()

Search index pruning statistics, one for each base table that has a search index. If a base table does not have a search index or the index does not help with pruning on the base table, then there is no pruning statistics for that table.

Returns:

value or null for none

setIndexPruningStats

public SearchStatistics setIndexPruningStats(List<IndexPruningStats> indexPruningStats)

Search index pruning statistics, one for each base table that has a search index. If a base table does not have a search index or the index does not help with pruning on the base table, then there is no pruning statistics for that table.

Parameters:

indexPruningStats - indexPruningStats or null for none

getIndexUnusedReasons

public List<IndexUnusedReason> getIndexUnusedReasons()

When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the search query. If `indexUsageMode` is `FULLY_USED`, this field is not populated.

Returns:

value or null for none

setIndexUnusedReasons

public SearchStatistics setIndexUnusedReasons(List<IndexUnusedReason> indexUnusedReasons)

When `indexUsageMode` is `UNUSED` or `PARTIALLY_USED`, this field explains why indexes were not used in all or part of the search query. If `indexUsageMode` is `FULLY_USED`, this field is not populated.

Parameters:

indexUnusedReasons - indexUnusedReasons or null for none

getIndexUsageMode

public String getIndexUsageMode()

Specifies the index usage mode for the query.

Returns:

value or null for none

setIndexUsageMode

public SearchStatistics setIndexUsageMode(String indexUsageMode)

Specifies the index usage mode for the query.

Parameters:

indexUsageMode - indexUsageMode or null for none

set

public SearchStatistics set(String fieldName,
                            Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public SearchStatistics clone()

Overrides:

clone in class com.google.api.client.json.GenericJson