BigqueryJobQuery class
query job-type block. Required field: query (the SQL text).
All other fields are optional. When destinationTable is set,
the query result is materialized to that table according to
createDisposition / writeDisposition.
Note: DML statements (INSERT, UPDATE, DELETE, MERGE)
must be configured with both create_disposition and
write_disposition set to the empty string per the provider
docs — this wrapper exposes the enums as nullable so callers
can simply omit them for the DML case.
- Annotations
-
- @immutable
Constructors
-
BigqueryJobQuery({required TfArg<
String> query, BigqueryJobDestinationTable? destinationTable, BigqueryJobDefaultDataset? defaultDataset, BigqueryJobEncryptionConfiguration? destinationEncryptionConfiguration, List<BigqueryJobUserDefinedFunctionResource> ? userDefinedFunctionResources, List<BigqueryJobQueryConnectionProperty> ? connectionProperties, BigqueryJobScriptOptions? scriptOptions, BigqueryJobCreateDisposition? createDisposition, BigqueryJobWriteDisposition? writeDisposition, BigqueryJobQueryPriority? priority, BigqueryJobParameterMode? parameterMode, TfArg<bool> ? useQueryCache, TfArg<bool> ? flattenResults, TfArg<bool> ? allowLargeResults, TfArg<int> ? maximumBillingTier, TfArg<String> ? maximumBytesBilled, TfArg<bool> ? useLegacySql, List<String> ? schemaUpdateOptions}) -
const
Properties
-
allowLargeResults
→ TfArg<
bool> ? -
final
-
connectionProperties
→ List<
BigqueryJobQueryConnectionProperty> ? -
Session / connection settings (
{key, value}pairs).final - createDisposition → BigqueryJobCreateDisposition?
-
final
- defaultDataset → BigqueryJobDefaultDataset?
-
Default dataset for unqualified references in the SQL.
final
- destinationEncryptionConfiguration → BigqueryJobEncryptionConfiguration?
-
CMEK key applied to destinationTable.
final
- destinationTable → BigqueryJobDestinationTable?
-
Optional materialization target. If null, the query is
"anonymous" (results queryable for 24h via the job ID only).
final
-
flattenResults
→ TfArg<
bool> ? -
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
maximumBillingTier
→ TfArg<
int> ? -
Legacy SQL only. Cap on billing tier for the query.
final
-
maximumBytesBilled
→ TfArg<
String> ? -
Int64 as a String per BigQuery API convention. Cap on bytes
billed; the job aborts if exceeded.
final
- parameterMode → BigqueryJobParameterMode?
-
final
- priority → BigqueryJobQueryPriority?
-
final
-
query
→ TfArg<
String> -
SQL text to execute. See useLegacySql for dialect selection.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
schemaUpdateOptions
→ List<
String> ? -
One or more of
ALLOW_FIELD_ADDITION,ALLOW_FIELD_RELAXATION. Only honored forWRITE_APPEND(andWRITE_TRUNCATEagainst a partition).final - scriptOptions → BigqueryJobScriptOptions?
-
Script execution behavior for multi-statement scripts.
final
-
useLegacySql
→ TfArg<
bool> ? -
final
-
useQueryCache
→ TfArg<
bool> ? -
final
-
userDefinedFunctionResources
→ List<
BigqueryJobUserDefinedFunctionResource> ? -
JS UDF resources loaded into the query's scope.
final
- writeDisposition → BigqueryJobWriteDisposition?
-
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toArgMap(
) → Map< String, Object?> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited