Package com.pulumi.gcp.bigquery.inputs

Class JobQueryArgs

  • public final class JobQueryArgs
extends com.pulumi.resources.ResourceArgs

    • Method Detail

      • allowLargeResults

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> allowLargeResults()
        Returns:
        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.

      • createDisposition

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> createDisposition()
        Returns:
        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 is `CREATE_IF_NEEDED`. Possible values are: `CREATE_IF_NEEDED`, `CREATE_NEVER`.

      • defaultDataset

        public java.util.Optional<com.pulumi.core.Output<JobQueryDefaultDatasetArgs>> defaultDataset()
        Returns:
        Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names. Structure is documented below.

      • destinationEncryptionConfiguration

        public java.util.Optional<com.pulumi.core.Output<JobQueryDestinationEncryptionConfigurationArgs>> destinationEncryptionConfiguration()
        Returns:
        Custom encryption configuration (e.g., Cloud KMS keys) Structure is documented below.

      • destinationTable

        public java.util.Optional<com.pulumi.core.Output<JobQueryDestinationTableArgs>> destinationTable()
        Returns:
        Describes the table where the query results should be stored. This property must be set for large results that exceed the maximum response size. For queries that produce anonymous (cached) results, this field will be populated by BigQuery. Structure is documented below.

      • flattenResults

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> flattenResults()
        Returns:
        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.

      • maximumBillingTier

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> maximumBillingTier()
        Returns:
        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.

      • maximumBytesBilled

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> maximumBytesBilled()
        Returns:
        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.

      • parameterMode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> parameterMode()
        Returns:
        Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.

      • priority

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> priority()
        Returns:
        Specifies a priority for the query. Default value is `INTERACTIVE`. Possible values are: `INTERACTIVE`, `BATCH`.

      • query

        public com.pulumi.core.Output<java.lang.String> query()
        Returns:
        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 = ""`.

      • schemaUpdateOptions

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> schemaUpdateOptions()
        Returns:
        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.

      • scriptOptions

        public java.util.Optional<com.pulumi.core.Output<JobQueryScriptOptionsArgs>> scriptOptions()
        Returns:
        Options controlling the execution of scripts. Structure is documented below.

      • useLegacySql

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> useLegacySql()
        Returns:
        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.

      • useQueryCache

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> useQueryCache()
        Returns:
        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.

      • userDefinedFunctionResources

        public java.util.Optional<com.pulumi.core.Output<java.util.List<JobQueryUserDefinedFunctionResourceArgs>>> userDefinedFunctionResources()
        Returns:
        Describes user-defined function resources used in the query. Structure is documented below.

      • writeDisposition

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> writeDisposition()
        Returns:
        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 is `WRITE_EMPTY`. Possible values are: `WRITE_TRUNCATE`, `WRITE_APPEND`, `WRITE_EMPTY`.