public final class QueryJobConfiguration extends JobConfiguration
JobConfiguration.Type.QUERY
type.Modifier and Type | Class and Description |
---|---|
static class |
QueryJobConfiguration.Builder |
static class |
QueryJobConfiguration.Priority
Priority levels for a query.
|
JobConfiguration.Type
Modifier and Type | Method and Description |
---|---|
Boolean |
allowLargeResults()
Returns whether the job is enabled to create arbitrarily large results.
|
Boolean |
dryRun()
Returns whether the job has to be dry run or not.
|
boolean |
equals(Object obj) |
Boolean |
flattenResults()
Returns whether nested and repeated fields should be flattened.
|
JobInfo.CreateDisposition |
getCreateDisposition()
Returns whether the job is allowed to create new tables.
|
DatasetId |
getDefaultDataset()
Returns the default dataset.
|
TableId |
getDestinationTable()
Returns the table where to put query results.
|
Integer |
getMaximumBillingTier()
Returns the optional billing tier limit for this job.
|
QueryJobConfiguration.Priority |
getPriority()
Returns the query priority.
|
String |
getQuery()
Returns the Google BigQuery SQL query.
|
List<JobInfo.SchemaUpdateOption> |
getSchemaUpdateOptions()
[Experimental] Returns options allowing the schema of the destination table to be updated as a side effect of the
query job.
|
Map<String,ExternalTableDefinition> |
getTableDefinitions()
Returns the external tables definitions.
|
List<UserDefinedFunction> |
getUserDefinedFunctions()
Returns user defined function resources that can be used by this query.
|
JobInfo.WriteDisposition |
getWriteDisposition()
Returns the action that should occur if the destination table already exists.
|
int |
hashCode() |
static QueryJobConfiguration.Builder |
newBuilder(String query)
Creates a builder for a BigQuery Query Job given the query to be run.
|
static QueryJobConfiguration |
of(String query)
Returns a BigQuery Copy Job for the given the query to be run.
|
QueryJobConfiguration.Builder |
toBuilder()
Returns a builder for the object.
|
Boolean |
useLegacySql()
Returns whether to use BigQuery's legacy SQL dialect for this query.
|
Boolean |
useQueryCache()
Returns whether to look for the result in the query cache.
|
getType, toString
public Boolean allowLargeResults()
true
the query is allowed to create large results at a slight cost in performance.
the query is allowed to create large results at a slight cost in performance.public JobInfo.CreateDisposition getCreateDisposition()
public DatasetId getDefaultDataset()
public TableId getDestinationTable()
allowLargeResults()
is true
.public Boolean flattenResults()
false
QueryJobConfiguration.Builder.setAllowLargeResults(Boolean)
must be true
.public QueryJobConfiguration.Priority getPriority()
public String getQuery()
public Map<String,ExternalTableDefinition> getTableDefinitions()
public Boolean useQueryCache()
QueryJobConfiguration.Builder.setDestinationTable(TableId)
is not set.public List<UserDefinedFunction> getUserDefinedFunctions()
UserDefinedFunction.Type.INLINE
) or loaded from
a Google Cloud Storage URI (UserDefinedFunction.Type.FROM_URI
.public JobInfo.WriteDisposition getWriteDisposition()
public Boolean dryRun()
public Boolean useLegacySql()
false
,
the query will use BigQuery's
Standard SQL. When set to false
, the values of allowLargeResults()
and
flattenResults()
are ignored; query will be run as if allowLargeResults()
is
true
and flattenResults()
is false
. If not set, legacy SQL dialect is
used. This property is experimental and might be subject to change.public Integer getMaximumBillingTier()
public List<JobInfo.SchemaUpdateOption> getSchemaUpdateOptions()
public QueryJobConfiguration.Builder toBuilder()
JobConfiguration
toBuilder
in class JobConfiguration
public static QueryJobConfiguration.Builder newBuilder(String query)
public static QueryJobConfiguration of(String query)
Copyright © 2017 Google. All rights reserved.