com.google.api.services.bigquery.model

Class JobConfigurationQuery

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.JobConfigurationQuery

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class JobConfigurationQuery
extends GenericJson

Model definition for JobConfigurationQuery.

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: http://code.google.com/p/google-api-java-client/wiki/Json

Upgrade warning: starting with version 1.12 getResponseHeaders() is removed, instead use JsonHttpRequest.getLastResponseHeaders()

Author:

Google, Inc.

Nested Class Summary

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

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
JobConfigurationQuery()

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	getAllowLargeResults() [Experimental] If true, allows >128M results to be materialized in the destination table.
String	getCreateDisposition() [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER).
DatasetReference	getDefaultDataset() [Optional] Specifies the default dataset to assume for unqualified table names in the query.
TableReference	getDestinationTable() [Optional] Describes the table where the query results should be stored.
Double	getMinCompletionRatio() [Experimental] Specifies the the minimum fraction of data that must be scanned before a query returns.
Boolean	getPreserveNulls() [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value.
String	getPriority() [Optional] Specifies a priority for the query.
String	getQuery() [Required] BigQuery SQL query to execute.
Boolean	getUseQueryCache() [Optional] Whether to look for the result in the query cache.
String	getWriteDisposition() [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY).
JobConfigurationQuery	setAllowLargeResults(Boolean allowLargeResults) [Experimental] If true, allows >128M results to be materialized in the destination table.
JobConfigurationQuery	setCreateDisposition(String createDisposition) [Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER).
JobConfigurationQuery	setDefaultDataset(DatasetReference defaultDataset) [Optional] Specifies the default dataset to assume for unqualified table names in the query.
JobConfigurationQuery	setDestinationTable(TableReference destinationTable) [Optional] Describes the table where the query results should be stored.
JobConfigurationQuery	setMinCompletionRatio(Double minCompletionRatio) [Experimental] Specifies the the minimum fraction of data that must be scanned before a query returns.
JobConfigurationQuery	setPreserveNulls(Boolean preserveNulls) [Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value.
JobConfigurationQuery	setPriority(String priority) [Optional] Specifies a priority for the query.
JobConfigurationQuery	setQuery(String query) [Required] BigQuery SQL query to execute.
JobConfigurationQuery	setUseQueryCache(Boolean useQueryCache) [Optional] Whether to look for the result in the query cache.
JobConfigurationQuery	setWriteDisposition(String writeDisposition) [Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY).

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

clone, getFactory, setFactory, toPrettyString, toString

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

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, set, setUnknownKeys

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

JobConfigurationQuery

public JobConfigurationQuery()

Method Detail

getAllowLargeResults

public Boolean getAllowLargeResults()

[Experimental] If true, allows >128M results to be materialized in the destination table. Requires destination_table to be set. The value returned may be null.

setAllowLargeResults

public JobConfigurationQuery setAllowLargeResults(Boolean allowLargeResults)

[Experimental] If true, allows >128M results to be materialized in the destination table. Requires destination_table to be set. The value set may be null.

getCreateDisposition

public String getCreateDisposition()

[Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED. The value returned may be null.

setCreateDisposition

public JobConfigurationQuery setCreateDisposition(String createDisposition)

[Optional] Whether to create the table if it doesn't already exist (CREATE_IF_NEEDED) or to require the table already exist (CREATE_NEVER). Default is CREATE_IF_NEEDED. The value set may be null.

getDefaultDataset

public DatasetReference getDefaultDataset()

[Optional] Specifies the default dataset to assume for unqualified table names in the query. The value returned may be null.

setDefaultDataset

public JobConfigurationQuery setDefaultDataset(DatasetReference defaultDataset)

[Optional] Specifies the default dataset to assume for unqualified table names in the query. The value set may be null.

getDestinationTable

public TableReference getDestinationTable()

[Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. The value returned may be null.

setDestinationTable

public JobConfigurationQuery setDestinationTable(TableReference destinationTable)

[Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. The value set may be null.

getMinCompletionRatio

public Double getMinCompletionRatio()

[Experimental] Specifies the the minimum fraction of data that must be scanned before a query returns. This should be specified as a value between 0.0 and 1.0 inclusive. The default value is 1.0. The value returned may be null.

setMinCompletionRatio

public JobConfigurationQuery setMinCompletionRatio(Double minCompletionRatio)

[Experimental] Specifies the the minimum fraction of data that must be scanned before a query returns. This should be specified as a value between 0.0 and 1.0 inclusive. The default value is 1.0. The value set may be null.

getPreserveNulls

public Boolean getPreserveNulls()

[Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code. The value returned may be null.

setPreserveNulls

public JobConfigurationQuery setPreserveNulls(Boolean preserveNulls)

[Experimental] If set, preserve null values in table data, rather than mapping null values to the column's default value. This flag currently defaults to false, but the default will soon be changed to true. Shortly afterward, this flag will be removed completely. Please specify true if possible, and false only if you need to force the old behavior while updating client code. The value set may be null.

getPriority

public String getPriority()

[Optional] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH. The value returned may be null.

setPriority

public JobConfigurationQuery setPriority(String priority)

[Optional] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH. The value set may be null.

getQuery

public String getQuery()

[Required] BigQuery SQL query to execute. The value returned may be null.

setQuery

public JobConfigurationQuery setQuery(String query)

[Required] BigQuery SQL query to execute. The value set may be null.

getUseQueryCache

public Boolean getUseQueryCache()

[Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The value returned may be null.

setUseQueryCache

public JobConfigurationQuery setUseQueryCache(Boolean useQueryCache)

[Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The value set may be null.

getWriteDisposition

public String getWriteDisposition()

[Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY. The value returned may be null.

setWriteDisposition

public JobConfigurationQuery setWriteDisposition(String writeDisposition)

[Optional] Whether to overwrite an existing table (WRITE_TRUNCATE), append to an existing table (WRITE_APPEND), or require that the the table is empty (WRITE_EMPTY). Default is WRITE_EMPTY. The value set may be null.