Package com.hashicorp.cdktf.providers.google.bigquery_job

Interface BigqueryJobQuery

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    BigqueryJobQuery.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:17.702Z")
@Stability(Stable)
public interface BigqueryJobQuery
extends software.amazon.jsii.JsiiSerializable

    • Method Detail

      • getQuery

        @Stability(Stable)
@NotNull
String getQuery()
        SQL query text to execute.

        The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL. *NOTE*: queries containing [DML language](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) ('DELETE', 'UPDATE', 'MERGE', 'INSERT') must specify 'create_disposition = ""' and 'write_disposition = ""'. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_job#query BigqueryJob#query}

      • getAllowLargeResults

        @Stability(Stable)
@Nullable
default Object getAllowLargeResults()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_job#allow_large_results BigqueryJob#allow_large_results}

      • getCreateDisposition

        @Stability(Stable)
@Nullable
default String getCreateDisposition()
        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. Creation, truncation and append actions occur as one atomic update upon job completion Default value: "CREATE_IF_NEEDED" Possible values: ["CREATE_IF_NEEDED", "CREATE_NEVER"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_job#create_disposition BigqueryJob#create_disposition}

      • getDefaultDataset

        @Stability(Stable)
@Nullable
default BigqueryJobQueryDefaultDataset getDefaultDataset()
        default_dataset block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_job#default_dataset BigqueryJob#default_dataset}

      • getDestinationEncryptionConfiguration

        @Stability(Stable)
@Nullable
default BigqueryJobQueryDestinationEncryptionConfiguration getDestinationEncryptionConfiguration()
        destination_encryption_configuration block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_job#destination_encryption_configuration BigqueryJob#destination_encryption_configuration}

      • getDestinationTable

        @Stability(Stable)
@Nullable
default BigqueryJobQueryDestinationTable getDestinationTable()
        destination_table block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_job#destination_table BigqueryJob#destination_table}

      • getFlattenResults

        @Stability(Stable)
@Nullable
default Object getFlattenResults()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_job#flatten_results BigqueryJob#flatten_results}

      • getMaximumBillingTier

        @Stability(Stable)
@Nullable
default Number getMaximumBillingTier()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_job#maximum_billing_tier BigqueryJob#maximum_billing_tier}

      • getMaximumBytesBilled

        @Stability(Stable)
@Nullable
default String getMaximumBytesBilled()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_job#maximum_bytes_billed BigqueryJob#maximum_bytes_billed}

      • getParameterMode

        @Stability(Stable)
@Nullable
default 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_job#parameter_mode BigqueryJob#parameter_mode}

      • getPriority

        @Stability(Stable)
@Nullable
default String getPriority()
        Specifies a priority for the query. Default value: "INTERACTIVE" Possible values: ["INTERACTIVE", "BATCH"].

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_job#priority BigqueryJob#priority}

      • getSchemaUpdateOptions

        @Stability(Stable)
@Nullable
default 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_job#schema_update_options BigqueryJob#schema_update_options}

      • getScriptOptions

        @Stability(Stable)
@Nullable
default BigqueryJobQueryScriptOptions getScriptOptions()
        script_options block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_job#script_options BigqueryJob#script_options}

      • getUseLegacySql

        @Stability(Stable)
@Nullable
default Object 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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_job#use_legacy_sql BigqueryJob#use_legacy_sql}

      • getUseQueryCache

        @Stability(Stable)
@Nullable
default Object getUseQueryCache()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_job#use_query_cache BigqueryJob#use_query_cache}

      • getUserDefinedFunctionResources

        @Stability(Stable)
@Nullable
default Object getUserDefinedFunctionResources()
        user_defined_function_resources block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_job#user_defined_function_resources BigqueryJob#user_defined_function_resources}

      • getWriteDisposition

        @Stability(Stable)
@Nullable
default String getWriteDisposition()
        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. 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. Default value: "WRITE_EMPTY" Possible values: ["WRITE_TRUNCATE", "WRITE_APPEND", "WRITE_EMPTY"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_job#write_disposition BigqueryJob#write_disposition}