public final class JobConfigurationQuery
extends com.google.api.client.json.GenericJson
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
com.google.api.client.util.GenericData.Flags
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
Constructor and Description |
---|
JobConfigurationQuery() |
Modifier and Type | Method and Description |
---|---|
JobConfigurationQuery |
clone() |
Boolean |
getAllowLargeResults()
Optional.
|
Clustering |
getClustering()
Clustering specification for the destination table.
|
List<ConnectionProperty> |
getConnectionProperties()
Connection properties which can modify the query behavior.
|
Boolean |
getContinuous()
[Optional] Specifies whether the query should be executed as a continuous query.
|
String |
getCreateDisposition()
Optional.
|
Boolean |
getCreateSession()
If this property is true, the job creates a new session using a randomly generated session_id.
|
DatasetReference |
getDefaultDataset()
Optional.
|
EncryptionConfiguration |
getDestinationEncryptionConfiguration()
Custom encryption configuration (e.g., Cloud KMS keys)
|
TableReference |
getDestinationTable()
Optional.
|
Boolean |
getFlattenResults()
Optional.
|
Integer |
getMaximumBillingTier()
Optional.
|
Long |
getMaximumBytesBilled()
Limits the bytes billed for this job.
|
String |
getParameterMode()
GoogleSQL only.
|
Boolean |
getPreserveNulls()
[Deprecated] This property is deprecated.
|
String |
getPriority()
Optional.
|
String |
getQuery()
[Required] SQL query text to execute.
|
List<QueryParameter> |
getQueryParameters()
Query parameters for GoogleSQL queries.
|
RangePartitioning |
getRangePartitioning()
Range partitioning specification for the destination table.
|
List<String> |
getSchemaUpdateOptions()
Allows the schema of the destination table to be updated as a side effect of the query job.
|
ScriptOptions |
getScriptOptions()
Options controlling the execution of scripts.
|
SystemVariables |
getSystemVariables()
Output only.
|
Map<String,ExternalDataConfiguration> |
getTableDefinitions()
Optional.
|
TimePartitioning |
getTimePartitioning()
Time-based partitioning specification for the destination table.
|
Boolean |
getUseLegacySql()
Optional.
|
Boolean |
getUseQueryCache()
Optional.
|
List<UserDefinedFunctionResource> |
getUserDefinedFunctionResources()
Describes user-defined function resources used in the query.
|
String |
getWriteDisposition()
Optional.
|
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.
|
JobConfigurationQuery |
setClustering(Clustering clustering)
Clustering specification for the destination table.
|
JobConfigurationQuery |
setConnectionProperties(List<ConnectionProperty> connectionProperties)
Connection properties which can modify the query behavior.
|
JobConfigurationQuery |
setContinuous(Boolean continuous)
[Optional] Specifies whether the query should be executed as a continuous query.
|
JobConfigurationQuery |
setCreateDisposition(String createDisposition)
Optional.
|
JobConfigurationQuery |
setCreateSession(Boolean createSession)
If this property is true, the job creates a new session using a randomly generated session_id.
|
JobConfigurationQuery |
setDefaultDataset(DatasetReference defaultDataset)
Optional.
|
JobConfigurationQuery |
setDestinationEncryptionConfiguration(EncryptionConfiguration destinationEncryptionConfiguration)
Custom encryption configuration (e.g., Cloud KMS keys)
|
JobConfigurationQuery |
setDestinationTable(TableReference destinationTable)
Optional.
|
JobConfigurationQuery |
setFlattenResults(Boolean flattenResults)
Optional.
|
JobConfigurationQuery |
setMaximumBillingTier(Integer maximumBillingTier)
Optional.
|
JobConfigurationQuery |
setMaximumBytesBilled(Long maximumBytesBilled)
Limits the bytes billed for this job.
|
JobConfigurationQuery |
setParameterMode(String parameterMode)
GoogleSQL only.
|
JobConfigurationQuery |
setPreserveNulls(Boolean preserveNulls)
[Deprecated] This property is deprecated.
|
JobConfigurationQuery |
setPriority(String priority)
Optional.
|
JobConfigurationQuery |
setQuery(String query)
[Required] SQL query text to execute.
|
JobConfigurationQuery |
setQueryParameters(List<QueryParameter> queryParameters)
Query parameters for GoogleSQL queries.
|
JobConfigurationQuery |
setRangePartitioning(RangePartitioning rangePartitioning)
Range partitioning specification for the destination 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 |
setScriptOptions(ScriptOptions scriptOptions)
Options controlling the execution of scripts.
|
JobConfigurationQuery |
setSystemVariables(SystemVariables systemVariables)
Output only.
|
JobConfigurationQuery |
setTableDefinitions(Map<String,ExternalDataConfiguration> tableDefinitions)
Optional.
|
JobConfigurationQuery |
setTimePartitioning(TimePartitioning timePartitioning)
Time-based partitioning specification for the destination table.
|
JobConfigurationQuery |
setUseLegacySql(Boolean useLegacySql)
Optional.
|
JobConfigurationQuery |
setUseQueryCache(Boolean useQueryCache)
Optional.
|
JobConfigurationQuery |
setUserDefinedFunctionResources(List<UserDefinedFunctionResource> userDefinedFunctionResources)
Describes user-defined function resources used in the query.
|
JobConfigurationQuery |
setWriteDisposition(String writeDisposition)
Optional.
|
getFactory, setFactory, toPrettyString, toString
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys
clear, containsKey, containsValue, isEmpty, keySet, size, values
finalize, getClass, notify, notifyAll, wait, wait, wait
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
public Boolean getAllowLargeResults()
null
for nonepublic JobConfigurationQuery setAllowLargeResults(Boolean allowLargeResults)
allowLargeResults
- allowLargeResults or null
for nonepublic boolean isAllowLargeResults()
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 GoogleSQL 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.
public Clustering getClustering()
null
for nonepublic JobConfigurationQuery setClustering(Clustering clustering)
clustering
- clustering or null
for nonepublic List<ConnectionProperty> getConnectionProperties()
null
for nonepublic JobConfigurationQuery setConnectionProperties(List<ConnectionProperty> connectionProperties)
connectionProperties
- connectionProperties or null
for nonepublic Boolean getContinuous()
null
for nonepublic JobConfigurationQuery setContinuous(Boolean continuous)
continuous
- continuous or null
for nonepublic String getCreateDisposition()
null
for nonepublic JobConfigurationQuery setCreateDisposition(String createDisposition)
createDisposition
- createDisposition or null
for nonepublic Boolean getCreateSession()
null
for nonepublic JobConfigurationQuery setCreateSession(Boolean createSession)
createSession
- createSession or null
for nonepublic DatasetReference getDefaultDataset()
null
for nonepublic JobConfigurationQuery setDefaultDataset(DatasetReference defaultDataset)
defaultDataset
- defaultDataset or null
for nonepublic EncryptionConfiguration getDestinationEncryptionConfiguration()
null
for nonepublic JobConfigurationQuery setDestinationEncryptionConfiguration(EncryptionConfiguration destinationEncryptionConfiguration)
destinationEncryptionConfiguration
- destinationEncryptionConfiguration or null
for nonepublic TableReference getDestinationTable()
null
for nonepublic JobConfigurationQuery setDestinationTable(TableReference destinationTable)
destinationTable
- destinationTable or null
for nonepublic Boolean getFlattenResults()
null
for nonepublic JobConfigurationQuery setFlattenResults(Boolean flattenResults)
flattenResults
- flattenResults or null
for nonepublic boolean isFlattenResults()
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 GoogleSQL queries, this flag is ignored and results are never flattened.
public Integer getMaximumBillingTier()
null
for nonepublic JobConfigurationQuery setMaximumBillingTier(Integer maximumBillingTier)
maximumBillingTier
- maximumBillingTier or null
for nonepublic Long getMaximumBytesBilled()
null
for nonepublic JobConfigurationQuery setMaximumBytesBilled(Long maximumBytesBilled)
maximumBytesBilled
- maximumBytesBilled or null
for nonepublic String getParameterMode()
null
for nonepublic JobConfigurationQuery setParameterMode(String parameterMode)
parameterMode
- parameterMode or null
for nonepublic Boolean getPreserveNulls()
null
for nonepublic JobConfigurationQuery setPreserveNulls(Boolean preserveNulls)
preserveNulls
- preserveNulls or null
for nonepublic String getPriority()
null
for nonepublic JobConfigurationQuery setPriority(String priority)
priority
- priority or null
for nonepublic String getQuery()
null
for nonepublic JobConfigurationQuery setQuery(String query)
query
- query or null
for nonepublic List<QueryParameter> getQueryParameters()
null
for nonepublic JobConfigurationQuery setQueryParameters(List<QueryParameter> queryParameters)
queryParameters
- queryParameters or null
for nonepublic RangePartitioning getRangePartitioning()
null
for nonepublic JobConfigurationQuery setRangePartitioning(RangePartitioning rangePartitioning)
rangePartitioning
- rangePartitioning or null
for nonepublic List<String> getSchemaUpdateOptions()
null
for nonepublic JobConfigurationQuery setSchemaUpdateOptions(List<String> schemaUpdateOptions)
schemaUpdateOptions
- schemaUpdateOptions or null
for nonepublic ScriptOptions getScriptOptions()
null
for nonepublic JobConfigurationQuery setScriptOptions(ScriptOptions scriptOptions)
scriptOptions
- scriptOptions or null
for nonepublic SystemVariables getSystemVariables()
null
for nonepublic JobConfigurationQuery setSystemVariables(SystemVariables systemVariables)
systemVariables
- systemVariables or null
for nonepublic Map<String,ExternalDataConfiguration> getTableDefinitions()
null
for nonepublic JobConfigurationQuery setTableDefinitions(Map<String,ExternalDataConfiguration> tableDefinitions)
tableDefinitions
- tableDefinitions or null
for nonepublic TimePartitioning getTimePartitioning()
null
for nonepublic JobConfigurationQuery setTimePartitioning(TimePartitioning timePartitioning)
timePartitioning
- timePartitioning or null
for nonepublic Boolean getUseLegacySql()
null
for nonepublic JobConfigurationQuery setUseLegacySql(Boolean useLegacySql)
useLegacySql
- useLegacySql or null
for nonepublic boolean isUseLegacySql()
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. 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 GoogleSQL: 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.
public Boolean getUseQueryCache()
null
for nonepublic JobConfigurationQuery setUseQueryCache(Boolean useQueryCache)
useQueryCache
- useQueryCache or null
for nonepublic boolean isUseQueryCache()
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.
public List<UserDefinedFunctionResource> getUserDefinedFunctionResources()
null
for nonepublic JobConfigurationQuery setUserDefinedFunctionResources(List<UserDefinedFunctionResource> userDefinedFunctionResources)
userDefinedFunctionResources
- userDefinedFunctionResources or null
for nonepublic String getWriteDisposition()
null
for nonepublic JobConfigurationQuery setWriteDisposition(String writeDisposition)
writeDisposition
- writeDisposition or null
for nonepublic JobConfigurationQuery set(String fieldName, Object value)
set
in class com.google.api.client.json.GenericJson
public JobConfigurationQuery clone()
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.