BigQuery API v2 (revision 80)

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

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

JobConfigurationQuery()

Method Summary

JobConfigurationQuery	clone()
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.
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.
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	set(String fieldName, Object value)
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	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	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

getFactory, setFactory, toPrettyString, toString

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

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, 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.

Returns:

value or null for none

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.

Parameters:

allowLargeResults - allowLargeResults or null for none

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.

Returns:

value or null for none

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.

Parameters:

createDisposition - createDisposition or null for none

getDefaultDataset

public DatasetReference getDefaultDataset()

[Optional] Specifies the default dataset to assume for unqualified table names in the query.

Returns:

value or null for none

setDefaultDataset

public JobConfigurationQuery setDefaultDataset(DatasetReference defaultDataset)

[Optional] Specifies the default dataset to assume for unqualified table names in the query.

Parameters:

defaultDataset - defaultDataset or null for none

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.

Returns:

value or null for none

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.

Parameters:

destinationTable - destinationTable or null for none

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.

Returns:

value or null for none

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.

Parameters:

preserveNulls - preserveNulls or null for none

getPriority

public String getPriority()

[Optional] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH.

Returns:

value or null for none

setPriority

public JobConfigurationQuery setPriority(String priority)

[Optional] Specifies a priority for the query. Default is INTERACTIVE. Alternative is BATCH.

Parameters:

priority - priority or null for none

getQuery

public String getQuery()

[Required] BigQuery SQL query to execute.

Returns:

value or null for none

setQuery

public JobConfigurationQuery setQuery(String query)

[Required] BigQuery SQL query to execute.

Parameters:

query - query or null for none

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.

Returns:

value or null for none

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.

Parameters:

writeDisposition - writeDisposition or null for none

set

public JobConfigurationQuery set(String fieldName,
                                 Object value)

Overrides:

set in class GenericJson

clone

public JobConfigurationQuery clone()

Overrides:

clone in class GenericJson