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 com.google.api.client.json.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: 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
JobConfigurationQuery()

Method Summary

Modifier and Type	Method and Description
JobConfigurationQuery	clone()
Boolean	getAllowLargeResults() [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance.
Clustering	getClustering() [Beta] Clustering specification for the destination table.
String	getCreateDisposition() [Optional] Specifies whether the job is allowed to create new tables.
DatasetReference	getDefaultDataset() [Optional] Specifies the default dataset to use for unqualified table names in the query.
EncryptionConfiguration	getDestinationEncryptionConfiguration() Custom encryption configuration (e.g., Cloud KMS keys).
TableReference	getDestinationTable() [Optional] Describes the table where the query results should be stored.
Boolean	getFlattenResults() [Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results.
Integer	getMaximumBillingTier() [Optional] Limits the billing tier for this job.
Long	getMaximumBytesBilled() [Optional] Limits the bytes billed for this job.
String	getParameterMode() Standard SQL only.
Boolean	getPreserveNulls() [Deprecated] This property is deprecated.
String	getPriority() [Optional] Specifies a priority for the query.
String	getQuery() [Required] SQL query text to execute.
List<QueryParameter>	getQueryParameters() Query parameters for standard SQL queries.
RangePartitioning	getRangePartitioning() [Experimental] Range partitioning specification for this table.
List<String>	getSchemaUpdateOptions() Allows the schema of the destination table to be updated as a side effect of the query job.
Map<String,ExternalDataConfiguration>	getTableDefinitions() [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source.
TimePartitioning	getTimePartitioning() Time-based partitioning specification for the destination table.
Boolean	getUseLegacySql() Specifies whether to use BigQuery's legacy SQL dialect for this query.
Boolean	getUseQueryCache() [Optional] Whether to look for the result in the query cache.
List<UserDefinedFunctionResource>	getUserDefinedFunctionResources() Describes user-defined function resources used in the query.
String	getWriteDisposition() [Optional] Specifies the action that occurs if the destination table already exists.
boolean	isAllowLargeResults() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isFlattenResults() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isUseLegacySql() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
boolean	isUseQueryCache() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
JobConfigurationQuery	set(String fieldName, Object value)
JobConfigurationQuery	setAllowLargeResults(Boolean allowLargeResults) [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance.
JobConfigurationQuery	setClustering(Clustering clustering) [Beta] Clustering specification for the destination table.
JobConfigurationQuery	setCreateDisposition(String createDisposition) [Optional] Specifies whether the job is allowed to create new tables.
JobConfigurationQuery	setDefaultDataset(DatasetReference defaultDataset) [Optional] Specifies the default dataset to use for unqualified table names in the query.
JobConfigurationQuery	setDestinationEncryptionConfiguration(EncryptionConfiguration destinationEncryptionConfiguration) Custom encryption configuration (e.g., Cloud KMS keys).
JobConfigurationQuery	setDestinationTable(TableReference destinationTable) [Optional] Describes the table where the query results should be stored.
JobConfigurationQuery	setFlattenResults(Boolean flattenResults) [Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results.
JobConfigurationQuery	setMaximumBillingTier(Integer maximumBillingTier) [Optional] Limits the billing tier for this job.
JobConfigurationQuery	setMaximumBytesBilled(Long maximumBytesBilled) [Optional] Limits the bytes billed for this job.
JobConfigurationQuery	setParameterMode(String parameterMode) Standard SQL only.
JobConfigurationQuery	setPreserveNulls(Boolean preserveNulls) [Deprecated] This property is deprecated.
JobConfigurationQuery	setPriority(String priority) [Optional] Specifies a priority for the query.
JobConfigurationQuery	setQuery(String query) [Required] SQL query text to execute.
JobConfigurationQuery	setQueryParameters(List<QueryParameter> queryParameters) Query parameters for standard SQL queries.
JobConfigurationQuery	setRangePartitioning(RangePartitioning rangePartitioning) [Experimental] Range partitioning specification for this table.
JobConfigurationQuery	setSchemaUpdateOptions(List<String> schemaUpdateOptions) Allows the schema of the destination table to be updated as a side effect of the query job.
JobConfigurationQuery	setTableDefinitions(Map<String,ExternalDataConfiguration> tableDefinitions) [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source.
JobConfigurationQuery	setTimePartitioning(TimePartitioning timePartitioning) Time-based partitioning specification for the destination table.
JobConfigurationQuery	setUseLegacySql(Boolean useLegacySql) Specifies whether to use BigQuery's legacy SQL dialect for this query.
JobConfigurationQuery	setUseQueryCache(Boolean useQueryCache) [Optional] Whether to look for the result in the query cache.
JobConfigurationQuery	setUserDefinedFunctionResources(List<UserDefinedFunctionResource> userDefinedFunctionResources) Describes user-defined function resources used in the query.
JobConfigurationQuery	setWriteDisposition(String writeDisposition) [Optional] Specifies the action that occurs if the destination table already exists.

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

Methods inherited from interface java.util.Map

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

Constructor Detail

JobConfigurationQuery

public JobConfigurationQuery()

Method Detail

getAllowLargeResults

public Boolean getAllowLargeResults()

[Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.

Returns:

value or null for none

setAllowLargeResults

public JobConfigurationQuery setAllowLargeResults(Boolean allowLargeResults)

[Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.

Parameters:

allowLargeResults - allowLargeResults or null for none

isAllowLargeResults

public boolean isAllowLargeResults()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

[ Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large [ result tables at a slight cost in performance. Requires destinationTable to be set. For standard [ SQL queries, this flag is ignored and large results are always allowed. However, you must still [ set destinationTable when result size exceeds the allowed maximum response size.

getClustering

public Clustering getClustering()

[Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.

Returns:

value or null for none

setClustering

public JobConfigurationQuery setClustering(Clustering clustering)

[Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.

Parameters:

clustering - clustering or null for none

getCreateDisposition

public String getCreateDisposition()

[Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.

Returns:

value or null for none

setCreateDisposition

public JobConfigurationQuery setCreateDisposition(String createDisposition)

[Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.

Parameters:

createDisposition - createDisposition or null for none

getDefaultDataset

public DatasetReference getDefaultDataset()

[Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.

Returns:

value or null for none

setDefaultDataset

public JobConfigurationQuery setDefaultDataset(DatasetReference defaultDataset)

[Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.

Parameters:

defaultDataset - defaultDataset or null for none

getDestinationEncryptionConfiguration

public EncryptionConfiguration getDestinationEncryptionConfiguration()

Custom encryption configuration (e.g., Cloud KMS keys).

Returns:

value or null for none

setDestinationEncryptionConfiguration

public JobConfigurationQuery setDestinationEncryptionConfiguration(EncryptionConfiguration destinationEncryptionConfiguration)

Custom encryption configuration (e.g., Cloud KMS keys).

Parameters:

destinationEncryptionConfiguration - destinationEncryptionConfiguration 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. This property must be set for large results that exceed the maximum response size.

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. This property must be set for large results that exceed the maximum response size.

Parameters:

destinationTable - destinationTable or null for none

getFlattenResults

public Boolean getFlattenResults()

[Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened.

Returns:

value or null for none

setFlattenResults

public JobConfigurationQuery setFlattenResults(Boolean flattenResults)

[Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened.

Parameters:

flattenResults - flattenResults or null for none

isFlattenResults

public boolean isFlattenResults()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

[ Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in [ the query results. allowLargeResults must be true if this is set to false. For standard SQL [ queries, this flag is ignored and results are never flattened.

getMaximumBillingTier

public Integer getMaximumBillingTier()

[Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.

Returns:

value or null for none

setMaximumBillingTier

public JobConfigurationQuery setMaximumBillingTier(Integer maximumBillingTier)

[Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.

Parameters:

maximumBillingTier - maximumBillingTier or null for none

getMaximumBytesBilled

public Long getMaximumBytesBilled()

[Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.

Returns:

value or null for none

setMaximumBytesBilled

public JobConfigurationQuery setMaximumBytesBilled(Long maximumBytesBilled)

[Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.

Parameters:

maximumBytesBilled - maximumBytesBilled or null for none

getParameterMode

public String getParameterMode()

Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.

Returns:

value or null for none

setParameterMode

public JobConfigurationQuery setParameterMode(String parameterMode)

Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.

Parameters:

parameterMode - parameterMode or null for none

getPreserveNulls

public Boolean getPreserveNulls()

[Deprecated] This property is deprecated.

Returns:

value or null for none

setPreserveNulls

public JobConfigurationQuery setPreserveNulls(Boolean preserveNulls)

[Deprecated] This property is deprecated.

Parameters:

preserveNulls - preserveNulls or null for none

getPriority

public String getPriority()

[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.

Returns:

value or null for none

setPriority

public JobConfigurationQuery setPriority(String priority)

[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.

Parameters:

priority - priority or null for none

getQuery

public String getQuery()

[Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.

Returns:

value or null for none

setQuery

public JobConfigurationQuery setQuery(String query)

[Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.

Parameters:

query - query or null for none

getQueryParameters

public List<QueryParameter> getQueryParameters()

Query parameters for standard SQL queries.

Returns:

value or null for none

setQueryParameters

public JobConfigurationQuery setQueryParameters(List<QueryParameter> queryParameters)

Query parameters for standard SQL queries.

Parameters:

queryParameters - queryParameters or null for none

getRangePartitioning

public RangePartitioning getRangePartitioning()

[Experimental] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

Returns:

value or null for none

setRangePartitioning

public JobConfigurationQuery setRangePartitioning(RangePartitioning rangePartitioning)

[Experimental] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

Parameters:

rangePartitioning - rangePartitioning or null for none

getSchemaUpdateOptions

public List<String> getSchemaUpdateOptions()

Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.

Returns:

value or null for none

setSchemaUpdateOptions

public JobConfigurationQuery setSchemaUpdateOptions(List<String> schemaUpdateOptions)

Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.

Parameters:

schemaUpdateOptions - schemaUpdateOptions or null for none

getTableDefinitions

public Map<String,ExternalDataConfiguration> getTableDefinitions()

[Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

Returns:

value or null for none

setTableDefinitions

public JobConfigurationQuery setTableDefinitions(Map<String,ExternalDataConfiguration> tableDefinitions)

[Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

Parameters:

tableDefinitions - tableDefinitions or null for none

getTimePartitioning

public TimePartitioning getTimePartitioning()

Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

Returns:

value or null for none

setTimePartitioning

public JobConfigurationQuery setTimePartitioning(TimePartitioning timePartitioning)

Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

Parameters:

timePartitioning - timePartitioning or null for none

getUseLegacySql

public Boolean getUseLegacySql()

Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.

Returns:

value or null for none

setUseLegacySql

public JobConfigurationQuery setUseLegacySql(Boolean useLegacySql)

Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.

Parameters:

useLegacySql - useLegacySql or null for none

isUseLegacySql

public boolean isUseLegacySql()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql- reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.

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 default value is true.

Returns:

value or null for none

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 default value is true.

Parameters:

useQueryCache - useQueryCache or null for none

isUseQueryCache

public boolean isUseQueryCache()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

[ 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 default value is [ true.

getUserDefinedFunctionResources

public List<UserDefinedFunctionResource> getUserDefinedFunctionResources()

Describes user-defined function resources used in the query.

Returns:

value or null for none

setUserDefinedFunctionResources

public JobConfigurationQuery setUserDefinedFunctionResources(List<UserDefinedFunctionResource> userDefinedFunctionResources)

Describes user-defined function resources used in the query.

Parameters:

userDefinedFunctionResources - userDefinedFunctionResources or null for none

getWriteDisposition

public String getWriteDisposition()

[Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.

Returns:

value or null for none

setWriteDisposition

public JobConfigurationQuery setWriteDisposition(String writeDisposition)

[Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.

Parameters:

writeDisposition - writeDisposition or null for none

set

public JobConfigurationQuery set(String fieldName,
                                 Object value)

Overrides:

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

clone

public JobConfigurationQuery clone()

Overrides:

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