1. Packages
  2. Google Cloud Native
  3. API Docs
  4. bigquery
  5. bigquery/v2
  6. getJob

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.bigquery/v2.getJob

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Returns information about a specific job. Job information is available for a six month period after creation. Requires that you’re the person who ran the job, or have the Is Owner project role.

Using getJob

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getJob(args: GetJobArgs, opts?: InvokeOptions): Promise<GetJobResult>
function getJobOutput(args: GetJobOutputArgs, opts?: InvokeOptions): Output<GetJobResult>
Copy
def get_job(job_id: Optional[str] = None,
            location: Optional[str] = None,
            project: Optional[str] = None,
            opts: Optional[InvokeOptions] = None) -> GetJobResult
def get_job_output(job_id: Optional[pulumi.Input[str]] = None,
            location: Optional[pulumi.Input[str]] = None,
            project: Optional[pulumi.Input[str]] = None,
            opts: Optional[InvokeOptions] = None) -> Output[GetJobResult]
Copy
func LookupJob(ctx *Context, args *LookupJobArgs, opts ...InvokeOption) (*LookupJobResult, error)
func LookupJobOutput(ctx *Context, args *LookupJobOutputArgs, opts ...InvokeOption) LookupJobResultOutput
Copy

> Note: This function is named LookupJob in the Go SDK.

public static class GetJob 
{
    public static Task<GetJobResult> InvokeAsync(GetJobArgs args, InvokeOptions? opts = null)
    public static Output<GetJobResult> Invoke(GetJobInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetJobResult> getJob(GetJobArgs args, InvokeOptions options)
public static Output<GetJobResult> getJob(GetJobArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: google-native:bigquery/v2:getJob
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

JobId This property is required. string
Location string
Project string
JobId This property is required. string
Location string
Project string
jobId This property is required. String
location String
project String
jobId This property is required. string
location string
project string
job_id This property is required. str
location str
project str
jobId This property is required. String
location String
project String

getJob Result

The following output properties are available:

Configuration Pulumi.GoogleNative.BigQuery.V2.Outputs.JobConfigurationResponse
[Required] Describes the job configuration.
Etag string
A hash of this resource.
JobCreationReason object
If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
JobReference Pulumi.GoogleNative.BigQuery.V2.Outputs.JobReferenceResponse
[Optional] Reference describing the unique-per-user name of the job.
Kind string
The type of the resource.
SelfLink string
A URL that can be used to access this resource again.
Statistics Pulumi.GoogleNative.BigQuery.V2.Outputs.JobStatisticsResponse
Information about the job, including starting time and ending time of the job.
Status Pulumi.GoogleNative.BigQuery.V2.Outputs.JobStatusResponse
The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
UserEmail string
Email address of the user who ran the job.
Configuration JobConfigurationResponse
[Required] Describes the job configuration.
Etag string
A hash of this resource.
JobCreationReason interface{}
If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
JobReference JobReferenceResponse
[Optional] Reference describing the unique-per-user name of the job.
Kind string
The type of the resource.
SelfLink string
A URL that can be used to access this resource again.
Statistics JobStatisticsResponse
Information about the job, including starting time and ending time of the job.
Status JobStatusResponse
The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
UserEmail string
Email address of the user who ran the job.
configuration JobConfigurationResponse
[Required] Describes the job configuration.
etag String
A hash of this resource.
jobCreationReason Object
If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
jobReference JobReferenceResponse
[Optional] Reference describing the unique-per-user name of the job.
kind String
The type of the resource.
selfLink String
A URL that can be used to access this resource again.
statistics JobStatisticsResponse
Information about the job, including starting time and ending time of the job.
status JobStatusResponse
The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
userEmail String
Email address of the user who ran the job.
configuration JobConfigurationResponse
[Required] Describes the job configuration.
etag string
A hash of this resource.
jobCreationReason any
If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
jobReference JobReferenceResponse
[Optional] Reference describing the unique-per-user name of the job.
kind string
The type of the resource.
selfLink string
A URL that can be used to access this resource again.
statistics JobStatisticsResponse
Information about the job, including starting time and ending time of the job.
status JobStatusResponse
The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
userEmail string
Email address of the user who ran the job.
configuration JobConfigurationResponse
[Required] Describes the job configuration.
etag str
A hash of this resource.
job_creation_reason Any
If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
job_reference JobReferenceResponse
[Optional] Reference describing the unique-per-user name of the job.
kind str
The type of the resource.
self_link str
A URL that can be used to access this resource again.
statistics JobStatisticsResponse
Information about the job, including starting time and ending time of the job.
status JobStatusResponse
The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
user_email str
Email address of the user who ran the job.
configuration Property Map
[Required] Describes the job configuration.
etag String
A hash of this resource.
jobCreationReason Any
If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
jobReference Property Map
[Optional] Reference describing the unique-per-user name of the job.
kind String
The type of the resource.
selfLink String
A URL that can be used to access this resource again.
statistics Property Map
Information about the job, including starting time and ending time of the job.
status Property Map
The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
userEmail String
Email address of the user who ran the job.

Supporting Types

BiEngineReasonResponse

Code This property is required. string
High-level BI Engine reason for partial or disabled acceleration.
Message This property is required. string
Free form human-readable reason for partial or disabled acceleration.
Code This property is required. string
High-level BI Engine reason for partial or disabled acceleration.
Message This property is required. string
Free form human-readable reason for partial or disabled acceleration.
code This property is required. String
High-level BI Engine reason for partial or disabled acceleration.
message This property is required. String
Free form human-readable reason for partial or disabled acceleration.
code This property is required. string
High-level BI Engine reason for partial or disabled acceleration.
message This property is required. string
Free form human-readable reason for partial or disabled acceleration.
code This property is required. str
High-level BI Engine reason for partial or disabled acceleration.
message This property is required. str
Free form human-readable reason for partial or disabled acceleration.
code This property is required. String
High-level BI Engine reason for partial or disabled acceleration.
message This property is required. String
Free form human-readable reason for partial or disabled acceleration.

BiEngineStatisticsResponse

AccelerationMode This property is required. string
Specifies which mode of BI Engine acceleration was performed (if any).
BiEngineMode This property is required. string
Specifies which mode of BI Engine acceleration was performed (if any).
BiEngineReasons This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.BiEngineReasonResponse>
In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.
AccelerationMode This property is required. string
Specifies which mode of BI Engine acceleration was performed (if any).
BiEngineMode This property is required. string
Specifies which mode of BI Engine acceleration was performed (if any).
BiEngineReasons This property is required. []BiEngineReasonResponse
In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.
accelerationMode This property is required. String
Specifies which mode of BI Engine acceleration was performed (if any).
biEngineMode This property is required. String
Specifies which mode of BI Engine acceleration was performed (if any).
biEngineReasons This property is required. List<BiEngineReasonResponse>
In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.
accelerationMode This property is required. string
Specifies which mode of BI Engine acceleration was performed (if any).
biEngineMode This property is required. string
Specifies which mode of BI Engine acceleration was performed (if any).
biEngineReasons This property is required. BiEngineReasonResponse[]
In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.
acceleration_mode This property is required. str
Specifies which mode of BI Engine acceleration was performed (if any).
bi_engine_mode This property is required. str
Specifies which mode of BI Engine acceleration was performed (if any).
bi_engine_reasons This property is required. Sequence[BiEngineReasonResponse]
In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.
accelerationMode This property is required. String
Specifies which mode of BI Engine acceleration was performed (if any).
biEngineMode This property is required. String
Specifies which mode of BI Engine acceleration was performed (if any).
biEngineReasons This property is required. List<Property Map>
In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.

BigQueryModelTrainingResponse

CurrentIteration This property is required. int
[Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
ExpectedTotalIterations This property is required. string
[Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
CurrentIteration This property is required. int
[Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
ExpectedTotalIterations This property is required. string
[Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
currentIteration This property is required. Integer
[Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
expectedTotalIterations This property is required. String
[Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
currentIteration This property is required. number
[Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
expectedTotalIterations This property is required. string
[Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
current_iteration This property is required. int
[Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
expected_total_iterations This property is required. str
[Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
currentIteration This property is required. Number
[Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
expectedTotalIterations This property is required. String
[Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.

ClusteringResponse

Fields This property is required. List<string>
[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
Fields This property is required. []string
[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
fields This property is required. List<String>
[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
fields This property is required. string[]
[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
fields This property is required. Sequence[str]
[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
fields This property is required. List<String>
[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.

ConnectionPropertyResponse

Key This property is required. string
[Required] Name of the connection property to set.
Value This property is required. string
[Required] Value of the connection property.
Key This property is required. string
[Required] Name of the connection property to set.
Value This property is required. string
[Required] Value of the connection property.
key This property is required. String
[Required] Name of the connection property to set.
value This property is required. String
[Required] Value of the connection property.
key This property is required. string
[Required] Name of the connection property to set.
value This property is required. string
[Required] Value of the connection property.
key This property is required. str
[Required] Name of the connection property to set.
value This property is required. str
[Required] Value of the connection property.
key This property is required. String
[Required] Name of the connection property to set.
value This property is required. String
[Required] Value of the connection property.

DataMaskingStatisticsResponse

DataMaskingApplied This property is required. bool
[Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where.
DataMaskingApplied This property is required. bool
[Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where.
dataMaskingApplied This property is required. Boolean
[Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where.
dataMaskingApplied This property is required. boolean
[Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where.
data_masking_applied This property is required. bool
[Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where.
dataMaskingApplied This property is required. Boolean
[Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where.

DatasetReferenceResponse

DatasetId This property is required. string
[Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
Project This property is required. string
[Optional] The ID of the project containing this dataset.
DatasetId This property is required. string
[Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
Project This property is required. string
[Optional] The ID of the project containing this dataset.
datasetId This property is required. String
[Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
project This property is required. String
[Optional] The ID of the project containing this dataset.
datasetId This property is required. string
[Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
project This property is required. string
[Optional] The ID of the project containing this dataset.
dataset_id This property is required. str
[Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
project This property is required. str
[Optional] The ID of the project containing this dataset.
datasetId This property is required. String
[Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
project This property is required. String
[Optional] The ID of the project containing this dataset.

DestinationTablePropertiesResponse

Description This property is required. string
[Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
ExpirationTime This property is required. string
[Internal] This field is for Google internal use only.
FriendlyName This property is required. string
[Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
Labels This property is required. Dictionary<string, string>
[Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
Description This property is required. string
[Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
ExpirationTime This property is required. string
[Internal] This field is for Google internal use only.
FriendlyName This property is required. string
[Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
Labels This property is required. map[string]string
[Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
description This property is required. String
[Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
expirationTime This property is required. String
[Internal] This field is for Google internal use only.
friendlyName This property is required. String
[Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
labels This property is required. Map<String,String>
[Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
description This property is required. string
[Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
expirationTime This property is required. string
[Internal] This field is for Google internal use only.
friendlyName This property is required. string
[Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
labels This property is required. {[key: string]: string}
[Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
description This property is required. str
[Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
expiration_time This property is required. str
[Internal] This field is for Google internal use only.
friendly_name This property is required. str
[Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
labels This property is required. Mapping[str, str]
[Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
description This property is required. String
[Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
expirationTime This property is required. String
[Internal] This field is for Google internal use only.
friendlyName This property is required. String
[Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
labels This property is required. Map<String>
[Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.

DmlStatisticsResponse

DeletedRowCount This property is required. string
Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
InsertedRowCount This property is required. string
Number of inserted Rows. Populated by DML INSERT and MERGE statements.
UpdatedRowCount This property is required. string
Number of updated Rows. Populated by DML UPDATE and MERGE statements.
DeletedRowCount This property is required. string
Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
InsertedRowCount This property is required. string
Number of inserted Rows. Populated by DML INSERT and MERGE statements.
UpdatedRowCount This property is required. string
Number of updated Rows. Populated by DML UPDATE and MERGE statements.
deletedRowCount This property is required. String
Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
insertedRowCount This property is required. String
Number of inserted Rows. Populated by DML INSERT and MERGE statements.
updatedRowCount This property is required. String
Number of updated Rows. Populated by DML UPDATE and MERGE statements.
deletedRowCount This property is required. string
Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
insertedRowCount This property is required. string
Number of inserted Rows. Populated by DML INSERT and MERGE statements.
updatedRowCount This property is required. string
Number of updated Rows. Populated by DML UPDATE and MERGE statements.
deleted_row_count This property is required. str
Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
inserted_row_count This property is required. str
Number of inserted Rows. Populated by DML INSERT and MERGE statements.
updated_row_count This property is required. str
Number of updated Rows. Populated by DML UPDATE and MERGE statements.
deletedRowCount This property is required. String
Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
insertedRowCount This property is required. String
Number of inserted Rows. Populated by DML INSERT and MERGE statements.
updatedRowCount This property is required. String
Number of updated Rows. Populated by DML UPDATE and MERGE statements.

EncryptionConfigurationResponse

KmsKeyName This property is required. string
Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
KmsKeyName This property is required. string
Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
kmsKeyName This property is required. String
Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
kmsKeyName This property is required. string
Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
kms_key_name This property is required. str
Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
kmsKeyName This property is required. String
Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.

ErrorProtoResponse

DebugInfo This property is required. string
Debugging information. This property is internal to Google and should not be used.
Location This property is required. string
Specifies where the error occurred, if present.
Message This property is required. string
A human-readable description of the error.
Reason This property is required. string
A short error code that summarizes the error.
DebugInfo This property is required. string
Debugging information. This property is internal to Google and should not be used.
Location This property is required. string
Specifies where the error occurred, if present.
Message This property is required. string
A human-readable description of the error.
Reason This property is required. string
A short error code that summarizes the error.
debugInfo This property is required. String
Debugging information. This property is internal to Google and should not be used.
location This property is required. String
Specifies where the error occurred, if present.
message This property is required. String
A human-readable description of the error.
reason This property is required. String
A short error code that summarizes the error.
debugInfo This property is required. string
Debugging information. This property is internal to Google and should not be used.
location This property is required. string
Specifies where the error occurred, if present.
message This property is required. string
A human-readable description of the error.
reason This property is required. string
A short error code that summarizes the error.
debug_info This property is required. str
Debugging information. This property is internal to Google and should not be used.
location This property is required. str
Specifies where the error occurred, if present.
message This property is required. str
A human-readable description of the error.
reason This property is required. str
A short error code that summarizes the error.
debugInfo This property is required. String
Debugging information. This property is internal to Google and should not be used.
location This property is required. String
Specifies where the error occurred, if present.
message This property is required. String
A human-readable description of the error.
reason This property is required. String
A short error code that summarizes the error.

ExplainQueryStageResponse

CompletedParallelInputs This property is required. string
Number of parallel input segments completed.
ComputeMsAvg This property is required. string
Milliseconds the average shard spent on CPU-bound tasks.
ComputeMsMax This property is required. string
Milliseconds the slowest shard spent on CPU-bound tasks.
ComputeRatioAvg This property is required. double
Relative amount of time the average shard spent on CPU-bound tasks.
ComputeRatioMax This property is required. double
Relative amount of time the slowest shard spent on CPU-bound tasks.
EndMs This property is required. string
Stage end time represented as milliseconds since epoch.
InputStages This property is required. List<string>
IDs for stages that are inputs to this stage.
Name This property is required. string
Human-readable name for stage.
ParallelInputs This property is required. string
Number of parallel input segments to be processed.
ReadMsAvg This property is required. string
Milliseconds the average shard spent reading input.
ReadMsMax This property is required. string
Milliseconds the slowest shard spent reading input.
ReadRatioAvg This property is required. double
Relative amount of time the average shard spent reading input.
ReadRatioMax This property is required. double
Relative amount of time the slowest shard spent reading input.
RecordsRead This property is required. string
Number of records read into the stage.
RecordsWritten This property is required. string
Number of records written by the stage.
ShuffleOutputBytes This property is required. string
Total number of bytes written to shuffle.
ShuffleOutputBytesSpilled This property is required. string
Total number of bytes written to shuffle and spilled to disk.
SlotMs This property is required. string
Slot-milliseconds used by the stage.
StartMs This property is required. string
Stage start time represented as milliseconds since epoch.
Status This property is required. string
Current status for the stage.
Steps This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.ExplainQueryStepResponse>
List of operations within the stage in dependency order (approximately chronological).
WaitMsAvg This property is required. string
Milliseconds the average shard spent waiting to be scheduled.
WaitMsMax This property is required. string
Milliseconds the slowest shard spent waiting to be scheduled.
WaitRatioAvg This property is required. double
Relative amount of time the average shard spent waiting to be scheduled.
WaitRatioMax This property is required. double
Relative amount of time the slowest shard spent waiting to be scheduled.
WriteMsAvg This property is required. string
Milliseconds the average shard spent on writing output.
WriteMsMax This property is required. string
Milliseconds the slowest shard spent on writing output.
WriteRatioAvg This property is required. double
Relative amount of time the average shard spent on writing output.
WriteRatioMax This property is required. double
Relative amount of time the slowest shard spent on writing output.
CompletedParallelInputs This property is required. string
Number of parallel input segments completed.
ComputeMsAvg This property is required. string
Milliseconds the average shard spent on CPU-bound tasks.
ComputeMsMax This property is required. string
Milliseconds the slowest shard spent on CPU-bound tasks.
ComputeRatioAvg This property is required. float64
Relative amount of time the average shard spent on CPU-bound tasks.
ComputeRatioMax This property is required. float64
Relative amount of time the slowest shard spent on CPU-bound tasks.
EndMs This property is required. string
Stage end time represented as milliseconds since epoch.
InputStages This property is required. []string
IDs for stages that are inputs to this stage.
Name This property is required. string
Human-readable name for stage.
ParallelInputs This property is required. string
Number of parallel input segments to be processed.
ReadMsAvg This property is required. string
Milliseconds the average shard spent reading input.
ReadMsMax This property is required. string
Milliseconds the slowest shard spent reading input.
ReadRatioAvg This property is required. float64
Relative amount of time the average shard spent reading input.
ReadRatioMax This property is required. float64
Relative amount of time the slowest shard spent reading input.
RecordsRead This property is required. string
Number of records read into the stage.
RecordsWritten This property is required. string
Number of records written by the stage.
ShuffleOutputBytes This property is required. string
Total number of bytes written to shuffle.
ShuffleOutputBytesSpilled This property is required. string
Total number of bytes written to shuffle and spilled to disk.
SlotMs This property is required. string
Slot-milliseconds used by the stage.
StartMs This property is required. string
Stage start time represented as milliseconds since epoch.
Status This property is required. string
Current status for the stage.
Steps This property is required. []ExplainQueryStepResponse
List of operations within the stage in dependency order (approximately chronological).
WaitMsAvg This property is required. string
Milliseconds the average shard spent waiting to be scheduled.
WaitMsMax This property is required. string
Milliseconds the slowest shard spent waiting to be scheduled.
WaitRatioAvg This property is required. float64
Relative amount of time the average shard spent waiting to be scheduled.
WaitRatioMax This property is required. float64
Relative amount of time the slowest shard spent waiting to be scheduled.
WriteMsAvg This property is required. string
Milliseconds the average shard spent on writing output.
WriteMsMax This property is required. string
Milliseconds the slowest shard spent on writing output.
WriteRatioAvg This property is required. float64
Relative amount of time the average shard spent on writing output.
WriteRatioMax This property is required. float64
Relative amount of time the slowest shard spent on writing output.
completedParallelInputs This property is required. String
Number of parallel input segments completed.
computeMsAvg This property is required. String
Milliseconds the average shard spent on CPU-bound tasks.
computeMsMax This property is required. String
Milliseconds the slowest shard spent on CPU-bound tasks.
computeRatioAvg This property is required. Double
Relative amount of time the average shard spent on CPU-bound tasks.
computeRatioMax This property is required. Double
Relative amount of time the slowest shard spent on CPU-bound tasks.
endMs This property is required. String
Stage end time represented as milliseconds since epoch.
inputStages This property is required. List<String>
IDs for stages that are inputs to this stage.
name This property is required. String
Human-readable name for stage.
parallelInputs This property is required. String
Number of parallel input segments to be processed.
readMsAvg This property is required. String
Milliseconds the average shard spent reading input.
readMsMax This property is required. String
Milliseconds the slowest shard spent reading input.
readRatioAvg This property is required. Double
Relative amount of time the average shard spent reading input.
readRatioMax This property is required. Double
Relative amount of time the slowest shard spent reading input.
recordsRead This property is required. String
Number of records read into the stage.
recordsWritten This property is required. String
Number of records written by the stage.
shuffleOutputBytes This property is required. String
Total number of bytes written to shuffle.
shuffleOutputBytesSpilled This property is required. String
Total number of bytes written to shuffle and spilled to disk.
slotMs This property is required. String
Slot-milliseconds used by the stage.
startMs This property is required. String
Stage start time represented as milliseconds since epoch.
status This property is required. String
Current status for the stage.
steps This property is required. List<ExplainQueryStepResponse>
List of operations within the stage in dependency order (approximately chronological).
waitMsAvg This property is required. String
Milliseconds the average shard spent waiting to be scheduled.
waitMsMax This property is required. String
Milliseconds the slowest shard spent waiting to be scheduled.
waitRatioAvg This property is required. Double
Relative amount of time the average shard spent waiting to be scheduled.
waitRatioMax This property is required. Double
Relative amount of time the slowest shard spent waiting to be scheduled.
writeMsAvg This property is required. String
Milliseconds the average shard spent on writing output.
writeMsMax This property is required. String
Milliseconds the slowest shard spent on writing output.
writeRatioAvg This property is required. Double
Relative amount of time the average shard spent on writing output.
writeRatioMax This property is required. Double
Relative amount of time the slowest shard spent on writing output.
completedParallelInputs This property is required. string
Number of parallel input segments completed.
computeMsAvg This property is required. string
Milliseconds the average shard spent on CPU-bound tasks.
computeMsMax This property is required. string
Milliseconds the slowest shard spent on CPU-bound tasks.
computeRatioAvg This property is required. number
Relative amount of time the average shard spent on CPU-bound tasks.
computeRatioMax This property is required. number
Relative amount of time the slowest shard spent on CPU-bound tasks.
endMs This property is required. string
Stage end time represented as milliseconds since epoch.
inputStages This property is required. string[]
IDs for stages that are inputs to this stage.
name This property is required. string
Human-readable name for stage.
parallelInputs This property is required. string
Number of parallel input segments to be processed.
readMsAvg This property is required. string
Milliseconds the average shard spent reading input.
readMsMax This property is required. string
Milliseconds the slowest shard spent reading input.
readRatioAvg This property is required. number
Relative amount of time the average shard spent reading input.
readRatioMax This property is required. number
Relative amount of time the slowest shard spent reading input.
recordsRead This property is required. string
Number of records read into the stage.
recordsWritten This property is required. string
Number of records written by the stage.
shuffleOutputBytes This property is required. string
Total number of bytes written to shuffle.
shuffleOutputBytesSpilled This property is required. string
Total number of bytes written to shuffle and spilled to disk.
slotMs This property is required. string
Slot-milliseconds used by the stage.
startMs This property is required. string
Stage start time represented as milliseconds since epoch.
status This property is required. string
Current status for the stage.
steps This property is required. ExplainQueryStepResponse[]
List of operations within the stage in dependency order (approximately chronological).
waitMsAvg This property is required. string
Milliseconds the average shard spent waiting to be scheduled.
waitMsMax This property is required. string
Milliseconds the slowest shard spent waiting to be scheduled.
waitRatioAvg This property is required. number
Relative amount of time the average shard spent waiting to be scheduled.
waitRatioMax This property is required. number
Relative amount of time the slowest shard spent waiting to be scheduled.
writeMsAvg This property is required. string
Milliseconds the average shard spent on writing output.
writeMsMax This property is required. string
Milliseconds the slowest shard spent on writing output.
writeRatioAvg This property is required. number
Relative amount of time the average shard spent on writing output.
writeRatioMax This property is required. number
Relative amount of time the slowest shard spent on writing output.
completed_parallel_inputs This property is required. str
Number of parallel input segments completed.
compute_ms_avg This property is required. str
Milliseconds the average shard spent on CPU-bound tasks.
compute_ms_max This property is required. str
Milliseconds the slowest shard spent on CPU-bound tasks.
compute_ratio_avg This property is required. float
Relative amount of time the average shard spent on CPU-bound tasks.
compute_ratio_max This property is required. float
Relative amount of time the slowest shard spent on CPU-bound tasks.
end_ms This property is required. str
Stage end time represented as milliseconds since epoch.
input_stages This property is required. Sequence[str]
IDs for stages that are inputs to this stage.
name This property is required. str
Human-readable name for stage.
parallel_inputs This property is required. str
Number of parallel input segments to be processed.
read_ms_avg This property is required. str
Milliseconds the average shard spent reading input.
read_ms_max This property is required. str
Milliseconds the slowest shard spent reading input.
read_ratio_avg This property is required. float
Relative amount of time the average shard spent reading input.
read_ratio_max This property is required. float
Relative amount of time the slowest shard spent reading input.
records_read This property is required. str
Number of records read into the stage.
records_written This property is required. str
Number of records written by the stage.
shuffle_output_bytes This property is required. str
Total number of bytes written to shuffle.
shuffle_output_bytes_spilled This property is required. str
Total number of bytes written to shuffle and spilled to disk.
slot_ms This property is required. str
Slot-milliseconds used by the stage.
start_ms This property is required. str
Stage start time represented as milliseconds since epoch.
status This property is required. str
Current status for the stage.
steps This property is required. Sequence[ExplainQueryStepResponse]
List of operations within the stage in dependency order (approximately chronological).
wait_ms_avg This property is required. str
Milliseconds the average shard spent waiting to be scheduled.
wait_ms_max This property is required. str
Milliseconds the slowest shard spent waiting to be scheduled.
wait_ratio_avg This property is required. float
Relative amount of time the average shard spent waiting to be scheduled.
wait_ratio_max This property is required. float
Relative amount of time the slowest shard spent waiting to be scheduled.
write_ms_avg This property is required. str
Milliseconds the average shard spent on writing output.
write_ms_max This property is required. str
Milliseconds the slowest shard spent on writing output.
write_ratio_avg This property is required. float
Relative amount of time the average shard spent on writing output.
write_ratio_max This property is required. float
Relative amount of time the slowest shard spent on writing output.
completedParallelInputs This property is required. String
Number of parallel input segments completed.
computeMsAvg This property is required. String
Milliseconds the average shard spent on CPU-bound tasks.
computeMsMax This property is required. String
Milliseconds the slowest shard spent on CPU-bound tasks.
computeRatioAvg This property is required. Number
Relative amount of time the average shard spent on CPU-bound tasks.
computeRatioMax This property is required. Number
Relative amount of time the slowest shard spent on CPU-bound tasks.
endMs This property is required. String
Stage end time represented as milliseconds since epoch.
inputStages This property is required. List<String>
IDs for stages that are inputs to this stage.
name This property is required. String
Human-readable name for stage.
parallelInputs This property is required. String
Number of parallel input segments to be processed.
readMsAvg This property is required. String
Milliseconds the average shard spent reading input.
readMsMax This property is required. String
Milliseconds the slowest shard spent reading input.
readRatioAvg This property is required. Number
Relative amount of time the average shard spent reading input.
readRatioMax This property is required. Number
Relative amount of time the slowest shard spent reading input.
recordsRead This property is required. String
Number of records read into the stage.
recordsWritten This property is required. String
Number of records written by the stage.
shuffleOutputBytes This property is required. String
Total number of bytes written to shuffle.
shuffleOutputBytesSpilled This property is required. String
Total number of bytes written to shuffle and spilled to disk.
slotMs This property is required. String
Slot-milliseconds used by the stage.
startMs This property is required. String
Stage start time represented as milliseconds since epoch.
status This property is required. String
Current status for the stage.
steps This property is required. List<Property Map>
List of operations within the stage in dependency order (approximately chronological).
waitMsAvg This property is required. String
Milliseconds the average shard spent waiting to be scheduled.
waitMsMax This property is required. String
Milliseconds the slowest shard spent waiting to be scheduled.
waitRatioAvg This property is required. Number
Relative amount of time the average shard spent waiting to be scheduled.
waitRatioMax This property is required. Number
Relative amount of time the slowest shard spent waiting to be scheduled.
writeMsAvg This property is required. String
Milliseconds the average shard spent on writing output.
writeMsMax This property is required. String
Milliseconds the slowest shard spent on writing output.
writeRatioAvg This property is required. Number
Relative amount of time the average shard spent on writing output.
writeRatioMax This property is required. Number
Relative amount of time the slowest shard spent on writing output.

ExplainQueryStepResponse

Kind This property is required. string
Machine-readable operation type.
Substeps This property is required. List<string>
Human-readable stage descriptions.
Kind This property is required. string
Machine-readable operation type.
Substeps This property is required. []string
Human-readable stage descriptions.
kind This property is required. String
Machine-readable operation type.
substeps This property is required. List<String>
Human-readable stage descriptions.
kind This property is required. string
Machine-readable operation type.
substeps This property is required. string[]
Human-readable stage descriptions.
kind This property is required. str
Machine-readable operation type.
substeps This property is required. Sequence[str]
Human-readable stage descriptions.
kind This property is required. String
Machine-readable operation type.
substeps This property is required. List<String>
Human-readable stage descriptions.

HivePartitioningOptionsResponse

Fields This property is required. List<string>
For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.
Mode This property is required. string
[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
RequirePartitionFilter This property is required. bool
[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
SourceUriPrefix This property is required. string
[Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
Fields This property is required. []string
For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.
Mode This property is required. string
[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
RequirePartitionFilter This property is required. bool
[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
SourceUriPrefix This property is required. string
[Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
fields This property is required. List<String>
For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.
mode This property is required. String
[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
requirePartitionFilter This property is required. Boolean
[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
sourceUriPrefix This property is required. String
[Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
fields This property is required. string[]
For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.
mode This property is required. string
[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
requirePartitionFilter This property is required. boolean
[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
sourceUriPrefix This property is required. string
[Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
fields This property is required. Sequence[str]
For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.
mode This property is required. str
[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
require_partition_filter This property is required. bool
[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
source_uri_prefix This property is required. str
[Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
fields This property is required. List<String>
For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.
mode This property is required. String
[Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
requirePartitionFilter This property is required. Boolean
[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
sourceUriPrefix This property is required. String
[Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

IndexUnusedReasonResponse

BaseTable This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.TableReferenceResponse
Specifies the base table involved in the reason that no search index was used.
Code This property is required. string
Specifies the high-level reason for the scenario when no search index was used.
IndexName This property is required. string
Specifies the name of the unused search index, if available.
Message This property is required. string
Free form human-readable reason for the scenario when no search index was used.
BaseTable This property is required. TableReferenceResponse
Specifies the base table involved in the reason that no search index was used.
Code This property is required. string
Specifies the high-level reason for the scenario when no search index was used.
IndexName This property is required. string
Specifies the name of the unused search index, if available.
Message This property is required. string
Free form human-readable reason for the scenario when no search index was used.
baseTable This property is required. TableReferenceResponse
Specifies the base table involved in the reason that no search index was used.
code This property is required. String
Specifies the high-level reason for the scenario when no search index was used.
indexName This property is required. String
Specifies the name of the unused search index, if available.
message This property is required. String
Free form human-readable reason for the scenario when no search index was used.
baseTable This property is required. TableReferenceResponse
Specifies the base table involved in the reason that no search index was used.
code This property is required. string
Specifies the high-level reason for the scenario when no search index was used.
indexName This property is required. string
Specifies the name of the unused search index, if available.
message This property is required. string
Free form human-readable reason for the scenario when no search index was used.
base_table This property is required. TableReferenceResponse
Specifies the base table involved in the reason that no search index was used.
code This property is required. str
Specifies the high-level reason for the scenario when no search index was used.
index_name This property is required. str
Specifies the name of the unused search index, if available.
message This property is required. str
Free form human-readable reason for the scenario when no search index was used.
baseTable This property is required. Property Map
Specifies the base table involved in the reason that no search index was used.
code This property is required. String
Specifies the high-level reason for the scenario when no search index was used.
indexName This property is required. String
Specifies the name of the unused search index, if available.
message This property is required. String
Free form human-readable reason for the scenario when no search index was used.

IterationResultResponse

DurationMs This property is required. string
Time taken to run the iteration in milliseconds.
EvalLoss This property is required. double
Loss computed on the eval data at the end of iteration.
Index This property is required. int
Index of the iteration, 0 based.
LearnRate This property is required. double
Learn rate used for this iteration.
TrainingLoss This property is required. double
Loss computed on the training data at the end of iteration.
DurationMs This property is required. string
Time taken to run the iteration in milliseconds.
EvalLoss This property is required. float64
Loss computed on the eval data at the end of iteration.
Index This property is required. int
Index of the iteration, 0 based.
LearnRate This property is required. float64
Learn rate used for this iteration.
TrainingLoss This property is required. float64
Loss computed on the training data at the end of iteration.
durationMs This property is required. String
Time taken to run the iteration in milliseconds.
evalLoss This property is required. Double
Loss computed on the eval data at the end of iteration.
index This property is required. Integer
Index of the iteration, 0 based.
learnRate This property is required. Double
Learn rate used for this iteration.
trainingLoss This property is required. Double
Loss computed on the training data at the end of iteration.
durationMs This property is required. string
Time taken to run the iteration in milliseconds.
evalLoss This property is required. number
Loss computed on the eval data at the end of iteration.
index This property is required. number
Index of the iteration, 0 based.
learnRate This property is required. number
Learn rate used for this iteration.
trainingLoss This property is required. number
Loss computed on the training data at the end of iteration.
duration_ms This property is required. str
Time taken to run the iteration in milliseconds.
eval_loss This property is required. float
Loss computed on the eval data at the end of iteration.
index This property is required. int
Index of the iteration, 0 based.
learn_rate This property is required. float
Learn rate used for this iteration.
training_loss This property is required. float
Loss computed on the training data at the end of iteration.
durationMs This property is required. String
Time taken to run the iteration in milliseconds.
evalLoss This property is required. Number
Loss computed on the eval data at the end of iteration.
index This property is required. Number
Index of the iteration, 0 based.
learnRate This property is required. Number
Learn rate used for this iteration.
trainingLoss This property is required. Number
Loss computed on the training data at the end of iteration.

JobConfigurationExtractResponse

Compression This property is required. string
[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
DestinationFormat This property is required. string
[Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
DestinationUri This property is required. string
[Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
DestinationUris This property is required. List<string>
[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
FieldDelimiter This property is required. string
[Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
PrintHeader This property is required. bool
[Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
SourceModel This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.ModelReferenceResponse
A reference to the model being exported.
SourceTable This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.TableReferenceResponse
A reference to the table being exported.
UseAvroLogicalTypes This property is required. bool
[Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
Compression This property is required. string
[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
DestinationFormat This property is required. string
[Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
DestinationUri This property is required. string
[Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
DestinationUris This property is required. []string
[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
FieldDelimiter This property is required. string
[Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
PrintHeader This property is required. bool
[Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
SourceModel This property is required. ModelReferenceResponse
A reference to the model being exported.
SourceTable This property is required. TableReferenceResponse
A reference to the table being exported.
UseAvroLogicalTypes This property is required. bool
[Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
compression This property is required. String
[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
destinationFormat This property is required. String
[Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
destinationUri This property is required. String
[Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
destinationUris This property is required. List<String>
[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
fieldDelimiter This property is required. String
[Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
printHeader This property is required. Boolean
[Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
sourceModel This property is required. ModelReferenceResponse
A reference to the model being exported.
sourceTable This property is required. TableReferenceResponse
A reference to the table being exported.
useAvroLogicalTypes This property is required. Boolean
[Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
compression This property is required. string
[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
destinationFormat This property is required. string
[Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
destinationUri This property is required. string
[Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
destinationUris This property is required. string[]
[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
fieldDelimiter This property is required. string
[Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
printHeader This property is required. boolean
[Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
sourceModel This property is required. ModelReferenceResponse
A reference to the model being exported.
sourceTable This property is required. TableReferenceResponse
A reference to the table being exported.
useAvroLogicalTypes This property is required. boolean
[Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
compression This property is required. str
[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
destination_format This property is required. str
[Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
destination_uri This property is required. str
[Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
destination_uris This property is required. Sequence[str]
[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
field_delimiter This property is required. str
[Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
print_header This property is required. bool
[Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
source_model This property is required. ModelReferenceResponse
A reference to the model being exported.
source_table This property is required. TableReferenceResponse
A reference to the table being exported.
use_avro_logical_types This property is required. bool
[Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
compression This property is required. String
[Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
destinationFormat This property is required. String
[Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
destinationUri This property is required. String
[Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
destinationUris This property is required. List<String>
[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
fieldDelimiter This property is required. String
[Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
printHeader This property is required. Boolean
[Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
sourceModel This property is required. Property Map
A reference to the model being exported.
sourceTable This property is required. Property Map
A reference to the table being exported.
useAvroLogicalTypes This property is required. Boolean
[Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.

JobConfigurationLoadResponse

AllowJaggedRows This property is required. bool
[Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
AllowQuotedNewlines This property is required. bool
Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
Autodetect This property is required. bool
[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
Clustering This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.ClusteringResponse
[Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
ConnectionProperties This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.ConnectionPropertyResponse>
Connection properties.
CreateDisposition This property is required. string
[Optional] 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. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
CreateSession This property is required. bool
If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
DecimalTargetTypes This property is required. List<string>
[Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
DestinationEncryptionConfiguration This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.EncryptionConfigurationResponse
Custom encryption configuration (e.g., Cloud KMS keys).
DestinationTable This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.TableReferenceResponse
[Required] The destination table to load the data into.
DestinationTableProperties This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.DestinationTablePropertiesResponse
[Beta] [Optional] Properties with which to create the destination table if it is new.
Encoding This property is required. string
[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
FieldDelimiter This property is required. string
[Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
FileSetSpecType This property is required. string
[Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
HivePartitioningOptions This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.HivePartitioningOptionsResponse
[Optional] Options to configure hive partitioning support.
IgnoreUnknownValues This property is required. bool
[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
JsonExtension This property is required. string
[Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
MaxBadRecords This property is required. int
[Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
NullMarker This property is required. string
[Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
ParquetOptions This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.ParquetOptionsResponse
[Optional] Options to configure parquet support.
PreserveAsciiControlCharacters This property is required. bool
[Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
ProjectionFields This property is required. List<string>
If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
Quote This property is required. string
[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
RangePartitioning This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.RangePartitioningResponse
[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
ReferenceFileSchemaUri This property is required. string
User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
Schema This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.TableSchemaResponse
[Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
SchemaInline This property is required. string
[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".

Deprecated: [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".

SchemaInlineFormat This property is required. string
[Deprecated] The format of the schemaInline property.

Deprecated: [Deprecated] The format of the schemaInline property.

SchemaUpdateOptions This property is required. List<string>
Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. 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.
SkipLeadingRows This property is required. int
[Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
SourceFormat This property is required. string
[Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
SourceUris This property is required. List<string>
[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
TimePartitioning This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.TimePartitioningResponse
Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
UseAvroLogicalTypes This property is required. bool
[Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
WriteDisposition This property is required. string
[Optional] 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. 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. The default value is WRITE_APPEND. 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.
AllowJaggedRows This property is required. bool
[Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
AllowQuotedNewlines This property is required. bool
Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
Autodetect This property is required. bool
[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
Clustering This property is required. ClusteringResponse
[Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
ConnectionProperties This property is required. []ConnectionPropertyResponse
Connection properties.
CreateDisposition This property is required. string
[Optional] 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. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
CreateSession This property is required. bool
If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
DecimalTargetTypes This property is required. []string
[Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
DestinationEncryptionConfiguration This property is required. EncryptionConfigurationResponse
Custom encryption configuration (e.g., Cloud KMS keys).
DestinationTable This property is required. TableReferenceResponse
[Required] The destination table to load the data into.
DestinationTableProperties This property is required. DestinationTablePropertiesResponse
[Beta] [Optional] Properties with which to create the destination table if it is new.
Encoding This property is required. string
[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
FieldDelimiter This property is required. string
[Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
FileSetSpecType This property is required. string
[Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
HivePartitioningOptions This property is required. HivePartitioningOptionsResponse
[Optional] Options to configure hive partitioning support.
IgnoreUnknownValues This property is required. bool
[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
JsonExtension This property is required. string
[Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
MaxBadRecords This property is required. int
[Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
NullMarker This property is required. string
[Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
ParquetOptions This property is required. ParquetOptionsResponse
[Optional] Options to configure parquet support.
PreserveAsciiControlCharacters This property is required. bool
[Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
ProjectionFields This property is required. []string
If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
Quote This property is required. string
[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
RangePartitioning This property is required. RangePartitioningResponse
[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
ReferenceFileSchemaUri This property is required. string
User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
Schema This property is required. TableSchemaResponse
[Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
SchemaInline This property is required. string
[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".

Deprecated: [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".

SchemaInlineFormat This property is required. string
[Deprecated] The format of the schemaInline property.

Deprecated: [Deprecated] The format of the schemaInline property.

SchemaUpdateOptions This property is required. []string
Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. 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.
SkipLeadingRows This property is required. int
[Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
SourceFormat This property is required. string
[Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
SourceUris This property is required. []string
[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
TimePartitioning This property is required. TimePartitioningResponse
Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
UseAvroLogicalTypes This property is required. bool
[Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
WriteDisposition This property is required. string
[Optional] 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. 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. The default value is WRITE_APPEND. 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.
allowJaggedRows This property is required. Boolean
[Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
allowQuotedNewlines This property is required. Boolean
Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
autodetect This property is required. Boolean
[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
clustering This property is required. ClusteringResponse
[Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
connectionProperties This property is required. List<ConnectionPropertyResponse>
Connection properties.
createDisposition This property is required. String
[Optional] 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. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
createSession This property is required. Boolean
If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
decimalTargetTypes This property is required. List<String>
[Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
destinationEncryptionConfiguration This property is required. EncryptionConfigurationResponse
Custom encryption configuration (e.g., Cloud KMS keys).
destinationTable This property is required. TableReferenceResponse
[Required] The destination table to load the data into.
destinationTableProperties This property is required. DestinationTablePropertiesResponse
[Beta] [Optional] Properties with which to create the destination table if it is new.
encoding This property is required. String
[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
fieldDelimiter This property is required. String
[Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
fileSetSpecType This property is required. String
[Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
hivePartitioningOptions This property is required. HivePartitioningOptionsResponse
[Optional] Options to configure hive partitioning support.
ignoreUnknownValues This property is required. Boolean
[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
jsonExtension This property is required. String
[Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
maxBadRecords This property is required. Integer
[Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
nullMarker This property is required. String
[Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
parquetOptions This property is required. ParquetOptionsResponse
[Optional] Options to configure parquet support.
preserveAsciiControlCharacters This property is required. Boolean
[Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
projectionFields This property is required. List<String>
If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
quote This property is required. String
[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
rangePartitioning This property is required. RangePartitioningResponse
[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
referenceFileSchemaUri This property is required. String
User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
schema This property is required. TableSchemaResponse
[Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
schemaInline This property is required. String
[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".

Deprecated: [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".

schemaInlineFormat This property is required. String
[Deprecated] The format of the schemaInline property.

Deprecated: [Deprecated] The format of the schemaInline property.

schemaUpdateOptions This property is required. List<String>
Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. 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.
skipLeadingRows This property is required. Integer
[Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
sourceFormat This property is required. String
[Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
sourceUris This property is required. List<String>
[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
timePartitioning This property is required. TimePartitioningResponse
Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
useAvroLogicalTypes This property is required. Boolean
[Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
writeDisposition This property is required. String
[Optional] 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. 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. The default value is WRITE_APPEND. 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.
allowJaggedRows This property is required. boolean
[Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
allowQuotedNewlines This property is required. boolean
Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
autodetect This property is required. boolean
[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
clustering This property is required. ClusteringResponse
[Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
connectionProperties This property is required. ConnectionPropertyResponse[]
Connection properties.
createDisposition This property is required. string
[Optional] 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. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
createSession This property is required. boolean
If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
decimalTargetTypes This property is required. string[]
[Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
destinationEncryptionConfiguration This property is required. EncryptionConfigurationResponse
Custom encryption configuration (e.g., Cloud KMS keys).
destinationTable This property is required. TableReferenceResponse
[Required] The destination table to load the data into.
destinationTableProperties This property is required. DestinationTablePropertiesResponse
[Beta] [Optional] Properties with which to create the destination table if it is new.
encoding This property is required. string
[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
fieldDelimiter This property is required. string
[Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
fileSetSpecType This property is required. string
[Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
hivePartitioningOptions This property is required. HivePartitioningOptionsResponse
[Optional] Options to configure hive partitioning support.
ignoreUnknownValues This property is required. boolean
[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
jsonExtension This property is required. string
[Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
maxBadRecords This property is required. number
[Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
nullMarker This property is required. string
[Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
parquetOptions This property is required. ParquetOptionsResponse
[Optional] Options to configure parquet support.
preserveAsciiControlCharacters This property is required. boolean
[Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
projectionFields This property is required. string[]
If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
quote This property is required. string
[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
rangePartitioning This property is required. RangePartitioningResponse
[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
referenceFileSchemaUri This property is required. string
User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
schema This property is required. TableSchemaResponse
[Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
schemaInline This property is required. string
[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".

Deprecated: [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".

schemaInlineFormat This property is required. string
[Deprecated] The format of the schemaInline property.

Deprecated: [Deprecated] The format of the schemaInline property.

schemaUpdateOptions This property is required. string[]
Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. 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.
skipLeadingRows This property is required. number
[Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
sourceFormat This property is required. string
[Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
sourceUris This property is required. string[]
[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
timePartitioning This property is required. TimePartitioningResponse
Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
useAvroLogicalTypes This property is required. boolean
[Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
writeDisposition This property is required. string
[Optional] 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. 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. The default value is WRITE_APPEND. 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.
allow_jagged_rows This property is required. bool
[Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
allow_quoted_newlines This property is required. bool
Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
autodetect This property is required. bool
[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
clustering This property is required. ClusteringResponse
[Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
connection_properties This property is required. Sequence[ConnectionPropertyResponse]
Connection properties.
create_disposition This property is required. str
[Optional] 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. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
create_session This property is required. bool
If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
decimal_target_types This property is required. Sequence[str]
[Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
destination_encryption_configuration This property is required. EncryptionConfigurationResponse
Custom encryption configuration (e.g., Cloud KMS keys).
destination_table This property is required. TableReferenceResponse
[Required] The destination table to load the data into.
destination_table_properties This property is required. DestinationTablePropertiesResponse
[Beta] [Optional] Properties with which to create the destination table if it is new.
encoding This property is required. str
[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
field_delimiter This property is required. str
[Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
file_set_spec_type This property is required. str
[Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
hive_partitioning_options This property is required. HivePartitioningOptionsResponse
[Optional] Options to configure hive partitioning support.
ignore_unknown_values This property is required. bool
[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
json_extension This property is required. str
[Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
max_bad_records This property is required. int
[Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
null_marker This property is required. str
[Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
parquet_options This property is required. ParquetOptionsResponse
[Optional] Options to configure parquet support.
preserve_ascii_control_characters This property is required. bool
[Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
projection_fields This property is required. Sequence[str]
If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
quote This property is required. str
[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
range_partitioning This property is required. RangePartitioningResponse
[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
reference_file_schema_uri This property is required. str
User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
schema This property is required. TableSchemaResponse
[Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
schema_inline This property is required. str
[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".

Deprecated: [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".

schema_inline_format This property is required. str
[Deprecated] The format of the schemaInline property.

Deprecated: [Deprecated] The format of the schemaInline property.

schema_update_options This property is required. Sequence[str]
Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. 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.
skip_leading_rows This property is required. int
[Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
source_format This property is required. str
[Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
source_uris This property is required. Sequence[str]
[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
time_partitioning This property is required. TimePartitioningResponse
Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
use_avro_logical_types This property is required. bool
[Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
write_disposition This property is required. str
[Optional] 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. 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. The default value is WRITE_APPEND. 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.
allowJaggedRows This property is required. Boolean
[Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
allowQuotedNewlines This property is required. Boolean
Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
autodetect This property is required. Boolean
[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
clustering This property is required. Property Map
[Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
connectionProperties This property is required. List<Property Map>
Connection properties.
createDisposition This property is required. String
[Optional] 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. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
createSession This property is required. Boolean
If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
decimalTargetTypes This property is required. List<String>
[Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
destinationEncryptionConfiguration This property is required. Property Map
Custom encryption configuration (e.g., Cloud KMS keys).
destinationTable This property is required. Property Map
[Required] The destination table to load the data into.
destinationTableProperties This property is required. Property Map
[Beta] [Optional] Properties with which to create the destination table if it is new.
encoding This property is required. String
[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
fieldDelimiter This property is required. String
[Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
fileSetSpecType This property is required. String
[Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
hivePartitioningOptions This property is required. Property Map
[Optional] Options to configure hive partitioning support.
ignoreUnknownValues This property is required. Boolean
[Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
jsonExtension This property is required. String
[Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
maxBadRecords This property is required. Number
[Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
nullMarker This property is required. String
[Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
parquetOptions This property is required. Property Map
[Optional] Options to configure parquet support.
preserveAsciiControlCharacters This property is required. Boolean
[Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
projectionFields This property is required. List<String>
If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
quote This property is required. String
[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
rangePartitioning This property is required. Property Map
[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
referenceFileSchemaUri This property is required. String
User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
schema This property is required. Property Map
[Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
schemaInline This property is required. String
[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".

Deprecated: [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".

schemaInlineFormat This property is required. String
[Deprecated] The format of the schemaInline property.

Deprecated: [Deprecated] The format of the schemaInline property.

schemaUpdateOptions This property is required. List<String>
Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. 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.
skipLeadingRows This property is required. Number
[Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
sourceFormat This property is required. String
[Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
sourceUris This property is required. List<String>
[Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
timePartitioning This property is required. Property Map
Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
useAvroLogicalTypes This property is required. Boolean
[Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
writeDisposition This property is required. String
[Optional] 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. 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. The default value is WRITE_APPEND. 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.

JobConfigurationQueryResponse

AllowLargeResults This property is required. bool
[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 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.
Clustering This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.ClusteringResponse
[Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
ConnectionProperties This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.ConnectionPropertyResponse>
Connection properties.
Continuous This property is required. bool
[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
CreateDisposition This property is required. string
[Optional] 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. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
CreateSession This property is required. bool
If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
DefaultDataset This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.DatasetReferenceResponse
[Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.
DestinationEncryptionConfiguration This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.EncryptionConfigurationResponse
Custom encryption configuration (e.g., Cloud KMS keys).
DestinationTable This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.TableReferenceResponse
[Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size.
FlattenResults This property is required. bool
[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 standard SQL queries, this flag is ignored and results are never flattened.
MaximumBillingTier This property is required. int
[Optional] 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 This property is required. string
[Optional] 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 This property is required. string
Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
PreserveNulls This property is required. bool
[Deprecated] This property is deprecated.

Deprecated: [Deprecated] This property is deprecated.

Priority This property is required. string
[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
Query This property is required. string
[Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
QueryParameters This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.QueryParameterResponse>
Query parameters for standard SQL queries.
RangePartitioning This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.RangePartitioningResponse
[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
SchemaUpdateOptions This property is required. List<string>
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.
TableDefinitions This property is required. Dictionary<string, string>
[Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
TimePartitioning This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.TimePartitioningResponse
Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
UseLegacySql This property is required. bool
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: 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.
UseQueryCache This property is required. bool
[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.
UserDefinedFunctionResources This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.UserDefinedFunctionResourceResponse>
Describes user-defined function resources used in the query.
WriteDisposition This property is required. string
[Optional] 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. The default value is WRITE_EMPTY. 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.
AllowLargeResults This property is required. bool
[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 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.
Clustering This property is required. ClusteringResponse
[Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
ConnectionProperties This property is required. []ConnectionPropertyResponse
Connection properties.
Continuous This property is required. bool
[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
CreateDisposition This property is required. string
[Optional] 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. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
CreateSession This property is required. bool
If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
DefaultDataset This property is required. DatasetReferenceResponse
[Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.
DestinationEncryptionConfiguration This property is required. EncryptionConfigurationResponse
Custom encryption configuration (e.g., Cloud KMS keys).
DestinationTable This property is required. TableReferenceResponse
[Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size.
FlattenResults This property is required. bool
[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 standard SQL queries, this flag is ignored and results are never flattened.
MaximumBillingTier This property is required. int
[Optional] 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 This property is required. string
[Optional] 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 This property is required. string
Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
PreserveNulls This property is required. bool
[Deprecated] This property is deprecated.

Deprecated: [Deprecated] This property is deprecated.

Priority This property is required. string
[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
Query This property is required. string
[Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
QueryParameters This property is required. []QueryParameterResponse
Query parameters for standard SQL queries.
RangePartitioning This property is required. RangePartitioningResponse
[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
SchemaUpdateOptions This property is required. []string
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.
TableDefinitions This property is required. map[string]string
[Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
TimePartitioning This property is required. TimePartitioningResponse
Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
UseLegacySql This property is required. bool
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: 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.
UseQueryCache This property is required. bool
[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.
UserDefinedFunctionResources This property is required. []UserDefinedFunctionResourceResponse
Describes user-defined function resources used in the query.
WriteDisposition This property is required. string
[Optional] 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. The default value is WRITE_EMPTY. 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.
allowLargeResults This property is required. 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 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.
clustering This property is required. ClusteringResponse
[Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
connectionProperties This property is required. List<ConnectionPropertyResponse>
Connection properties.
continuous This property is required. Boolean
[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
createDisposition This property is required. String
[Optional] 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. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
createSession This property is required. Boolean
If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
defaultDataset This property is required. DatasetReferenceResponse
[Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.
destinationEncryptionConfiguration This property is required. EncryptionConfigurationResponse
Custom encryption configuration (e.g., Cloud KMS keys).
destinationTable This property is required. TableReferenceResponse
[Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size.
flattenResults This property is required. 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 standard SQL queries, this flag is ignored and results are never flattened.
maximumBillingTier This property is required. Integer
[Optional] 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 This property is required. String
[Optional] 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 This property is required. String
Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
preserveNulls This property is required. Boolean
[Deprecated] This property is deprecated.

Deprecated: [Deprecated] This property is deprecated.

priority This property is required. String
[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
query This property is required. String
[Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
queryParameters This property is required. List<QueryParameterResponse>
Query parameters for standard SQL queries.
rangePartitioning This property is required. RangePartitioningResponse
[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
schemaUpdateOptions This property is required. List<String>
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.
tableDefinitions This property is required. Map<String,String>
[Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
timePartitioning This property is required. TimePartitioningResponse
Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
useLegacySql This property is required. Boolean
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: 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.
useQueryCache This property is required. 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.
userDefinedFunctionResources This property is required. List<UserDefinedFunctionResourceResponse>
Describes user-defined function resources used in the query.
writeDisposition This property is required. String
[Optional] 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. The default value is WRITE_EMPTY. 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.
allowLargeResults This property is required. 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 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.
clustering This property is required. ClusteringResponse
[Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
connectionProperties This property is required. ConnectionPropertyResponse[]
Connection properties.
continuous This property is required. boolean
[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
createDisposition This property is required. string
[Optional] 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. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
createSession This property is required. boolean
If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
defaultDataset This property is required. DatasetReferenceResponse
[Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.
destinationEncryptionConfiguration This property is required. EncryptionConfigurationResponse
Custom encryption configuration (e.g., Cloud KMS keys).
destinationTable This property is required. TableReferenceResponse
[Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size.
flattenResults This property is required. 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 standard SQL queries, this flag is ignored and results are never flattened.
maximumBillingTier This property is required. number
[Optional] 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 This property is required. string
[Optional] 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 This property is required. string
Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
preserveNulls This property is required. boolean
[Deprecated] This property is deprecated.

Deprecated: [Deprecated] This property is deprecated.

priority This property is required. string
[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
query This property is required. string
[Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
queryParameters This property is required. QueryParameterResponse[]
Query parameters for standard SQL queries.
rangePartitioning This property is required. RangePartitioningResponse
[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
schemaUpdateOptions This property is required. string[]
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.
tableDefinitions This property is required. {[key: string]: string}
[Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
timePartitioning This property is required. TimePartitioningResponse
Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
useLegacySql This property is required. boolean
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: 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.
useQueryCache This property is required. 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.
userDefinedFunctionResources This property is required. UserDefinedFunctionResourceResponse[]
Describes user-defined function resources used in the query.
writeDisposition This property is required. string
[Optional] 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. The default value is WRITE_EMPTY. 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.
allow_large_results This property is required. bool
[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 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.
clustering This property is required. ClusteringResponse
[Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
connection_properties This property is required. Sequence[ConnectionPropertyResponse]
Connection properties.
continuous This property is required. bool
[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
create_disposition This property is required. str
[Optional] 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. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
create_session This property is required. bool
If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
default_dataset This property is required. DatasetReferenceResponse
[Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.
destination_encryption_configuration This property is required. EncryptionConfigurationResponse
Custom encryption configuration (e.g., Cloud KMS keys).
destination_table This property is required. TableReferenceResponse
[Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size.
flatten_results This property is required. bool
[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 standard SQL queries, this flag is ignored and results are never flattened.
maximum_billing_tier This property is required. int
[Optional] 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.
maximum_bytes_billed This property is required. str
[Optional] 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.
parameter_mode This property is required. str
Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
preserve_nulls This property is required. bool
[Deprecated] This property is deprecated.

Deprecated: [Deprecated] This property is deprecated.

priority This property is required. str
[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
query This property is required. str
[Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
query_parameters This property is required. Sequence[QueryParameterResponse]
Query parameters for standard SQL queries.
range_partitioning This property is required. RangePartitioningResponse
[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
schema_update_options This property is required. Sequence[str]
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.
table_definitions This property is required. Mapping[str, str]
[Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
time_partitioning This property is required. TimePartitioningResponse
Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
use_legacy_sql This property is required. bool
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: 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.
use_query_cache This property is required. bool
[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.
user_defined_function_resources This property is required. Sequence[UserDefinedFunctionResourceResponse]
Describes user-defined function resources used in the query.
write_disposition This property is required. str
[Optional] 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. The default value is WRITE_EMPTY. 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.
allowLargeResults This property is required. 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 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.
clustering This property is required. Property Map
[Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
connectionProperties This property is required. List<Property Map>
Connection properties.
continuous This property is required. Boolean
[Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
createDisposition This property is required. String
[Optional] 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. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
createSession This property is required. Boolean
If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
defaultDataset This property is required. Property Map
[Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.
destinationEncryptionConfiguration This property is required. Property Map
Custom encryption configuration (e.g., Cloud KMS keys).
destinationTable This property is required. Property Map
[Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size.
flattenResults This property is required. 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 standard SQL queries, this flag is ignored and results are never flattened.
maximumBillingTier This property is required. Number
[Optional] 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 This property is required. String
[Optional] 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 This property is required. String
Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
preserveNulls This property is required. Boolean
[Deprecated] This property is deprecated.

Deprecated: [Deprecated] This property is deprecated.

priority This property is required. String
[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
query This property is required. String
[Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
queryParameters This property is required. List<Property Map>
Query parameters for standard SQL queries.
rangePartitioning This property is required. Property Map
[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
schemaUpdateOptions This property is required. List<String>
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.
tableDefinitions This property is required. Map<String>
[Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
timePartitioning This property is required. Property Map
Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
useLegacySql This property is required. Boolean
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: 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.
useQueryCache This property is required. 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.
userDefinedFunctionResources This property is required. List<Property Map>
Describes user-defined function resources used in the query.
writeDisposition This property is required. String
[Optional] 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. The default value is WRITE_EMPTY. 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.

JobConfigurationResponse

Copy This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.JobConfigurationTableCopyResponse
[Pick one] Copies a table.
DryRun This property is required. bool
[Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
Extract This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.JobConfigurationExtractResponse
[Pick one] Configures an extract job.
JobTimeoutMs This property is required. string
[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
JobType This property is required. string
The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
Labels This property is required. Dictionary<string, string>
The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
Load This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.JobConfigurationLoadResponse
[Pick one] Configures a load job.
Query This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.JobConfigurationQueryResponse
[Pick one] Configures a query job.
Copy This property is required. JobConfigurationTableCopyResponse
[Pick one] Copies a table.
DryRun This property is required. bool
[Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
Extract This property is required. JobConfigurationExtractResponse
[Pick one] Configures an extract job.
JobTimeoutMs This property is required. string
[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
JobType This property is required. string
The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
Labels This property is required. map[string]string
The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
Load This property is required. JobConfigurationLoadResponse
[Pick one] Configures a load job.
Query This property is required. JobConfigurationQueryResponse
[Pick one] Configures a query job.
copy This property is required. JobConfigurationTableCopyResponse
[Pick one] Copies a table.
dryRun This property is required. Boolean
[Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
extract This property is required. JobConfigurationExtractResponse
[Pick one] Configures an extract job.
jobTimeoutMs This property is required. String
[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
jobType This property is required. String
The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
labels This property is required. Map<String,String>
The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
load This property is required. JobConfigurationLoadResponse
[Pick one] Configures a load job.
query This property is required. JobConfigurationQueryResponse
[Pick one] Configures a query job.
copy This property is required. JobConfigurationTableCopyResponse
[Pick one] Copies a table.
dryRun This property is required. boolean
[Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
extract This property is required. JobConfigurationExtractResponse
[Pick one] Configures an extract job.
jobTimeoutMs This property is required. string
[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
jobType This property is required. string
The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
labels This property is required. {[key: string]: string}
The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
load This property is required. JobConfigurationLoadResponse
[Pick one] Configures a load job.
query This property is required. JobConfigurationQueryResponse
[Pick one] Configures a query job.
copy This property is required. JobConfigurationTableCopyResponse
[Pick one] Copies a table.
dry_run This property is required. bool
[Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
extract This property is required. JobConfigurationExtractResponse
[Pick one] Configures an extract job.
job_timeout_ms This property is required. str
[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
job_type This property is required. str
The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
labels This property is required. Mapping[str, str]
The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
load This property is required. JobConfigurationLoadResponse
[Pick one] Configures a load job.
query This property is required. JobConfigurationQueryResponse
[Pick one] Configures a query job.
copy This property is required. Property Map
[Pick one] Copies a table.
dryRun This property is required. Boolean
[Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
extract This property is required. Property Map
[Pick one] Configures an extract job.
jobTimeoutMs This property is required. String
[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
jobType This property is required. String
The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
labels This property is required. Map<String>
The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
load This property is required. Property Map
[Pick one] Configures a load job.
query This property is required. Property Map
[Pick one] Configures a query job.

JobConfigurationTableCopyResponse

CreateDisposition This property is required. string
[Optional] 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. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
DestinationEncryptionConfiguration This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.EncryptionConfigurationResponse
Custom encryption configuration (e.g., Cloud KMS keys).
DestinationExpirationTime This property is required. object
[Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
DestinationTable This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.TableReferenceResponse
[Required] The destination table
OperationType This property is required. string
[Optional] Supported operation types in table copy job.
SourceTable This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.TableReferenceResponse
[Pick one] Source table to copy.
SourceTables This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.TableReferenceResponse>
[Pick one] Source tables to copy.
WriteDisposition This property is required. string
[Optional] 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. 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. The default value is WRITE_EMPTY. 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.
CreateDisposition This property is required. string
[Optional] 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. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
DestinationEncryptionConfiguration This property is required. EncryptionConfigurationResponse
Custom encryption configuration (e.g., Cloud KMS keys).
DestinationExpirationTime This property is required. interface{}
[Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
DestinationTable This property is required. TableReferenceResponse
[Required] The destination table
OperationType This property is required. string
[Optional] Supported operation types in table copy job.
SourceTable This property is required. TableReferenceResponse
[Pick one] Source table to copy.
SourceTables This property is required. []TableReferenceResponse
[Pick one] Source tables to copy.
WriteDisposition This property is required. string
[Optional] 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. 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. The default value is WRITE_EMPTY. 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.
createDisposition This property is required. String
[Optional] 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. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
destinationEncryptionConfiguration This property is required. EncryptionConfigurationResponse
Custom encryption configuration (e.g., Cloud KMS keys).
destinationExpirationTime This property is required. Object
[Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
destinationTable This property is required. TableReferenceResponse
[Required] The destination table
operationType This property is required. String
[Optional] Supported operation types in table copy job.
sourceTable This property is required. TableReferenceResponse
[Pick one] Source table to copy.
sourceTables This property is required. List<TableReferenceResponse>
[Pick one] Source tables to copy.
writeDisposition This property is required. String
[Optional] 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. 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. The default value is WRITE_EMPTY. 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.
createDisposition This property is required. string
[Optional] 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. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
destinationEncryptionConfiguration This property is required. EncryptionConfigurationResponse
Custom encryption configuration (e.g., Cloud KMS keys).
destinationExpirationTime This property is required. any
[Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
destinationTable This property is required. TableReferenceResponse
[Required] The destination table
operationType This property is required. string
[Optional] Supported operation types in table copy job.
sourceTable This property is required. TableReferenceResponse
[Pick one] Source table to copy.
sourceTables This property is required. TableReferenceResponse[]
[Pick one] Source tables to copy.
writeDisposition This property is required. string
[Optional] 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. 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. The default value is WRITE_EMPTY. 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.
create_disposition This property is required. str
[Optional] 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. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
destination_encryption_configuration This property is required. EncryptionConfigurationResponse
Custom encryption configuration (e.g., Cloud KMS keys).
destination_expiration_time This property is required. Any
[Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
destination_table This property is required. TableReferenceResponse
[Required] The destination table
operation_type This property is required. str
[Optional] Supported operation types in table copy job.
source_table This property is required. TableReferenceResponse
[Pick one] Source table to copy.
source_tables This property is required. Sequence[TableReferenceResponse]
[Pick one] Source tables to copy.
write_disposition This property is required. str
[Optional] 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. 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. The default value is WRITE_EMPTY. 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.
createDisposition This property is required. String
[Optional] 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. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
destinationEncryptionConfiguration This property is required. Property Map
Custom encryption configuration (e.g., Cloud KMS keys).
destinationExpirationTime This property is required. Any
[Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
destinationTable This property is required. Property Map
[Required] The destination table
operationType This property is required. String
[Optional] Supported operation types in table copy job.
sourceTable This property is required. Property Map
[Pick one] Source table to copy.
sourceTables This property is required. List<Property Map>
[Pick one] Source tables to copy.
writeDisposition This property is required. String
[Optional] 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. 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. The default value is WRITE_EMPTY. 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.

JobReferenceResponse

JobId This property is required. string
[Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
Location This property is required. string
The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
Project This property is required. string
[Required] The ID of the project containing this job.
JobId This property is required. string
[Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
Location This property is required. string
The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
Project This property is required. string
[Required] The ID of the project containing this job.
jobId This property is required. String
[Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
location This property is required. String
The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
project This property is required. String
[Required] The ID of the project containing this job.
jobId This property is required. string
[Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
location This property is required. string
The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
project This property is required. string
[Required] The ID of the project containing this job.
job_id This property is required. str
[Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
location This property is required. str
The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
project This property is required. str
[Required] The ID of the project containing this job.
jobId This property is required. String
[Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
location This property is required. String
The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
project This property is required. String
[Required] The ID of the project containing this job.

JobStatistics2ReservationUsageItemResponse

Name This property is required. string
[Output only] Reservation name or "unreserved" for on-demand resources usage.
SlotMs This property is required. string
[Output only] Slot-milliseconds the job spent in the given reservation.
Name This property is required. string
[Output only] Reservation name or "unreserved" for on-demand resources usage.
SlotMs This property is required. string
[Output only] Slot-milliseconds the job spent in the given reservation.
name This property is required. String
[Output only] Reservation name or "unreserved" for on-demand resources usage.
slotMs This property is required. String
[Output only] Slot-milliseconds the job spent in the given reservation.
name This property is required. string
[Output only] Reservation name or "unreserved" for on-demand resources usage.
slotMs This property is required. string
[Output only] Slot-milliseconds the job spent in the given reservation.
name This property is required. str
[Output only] Reservation name or "unreserved" for on-demand resources usage.
slot_ms This property is required. str
[Output only] Slot-milliseconds the job spent in the given reservation.
name This property is required. String
[Output only] Reservation name or "unreserved" for on-demand resources usage.
slotMs This property is required. String
[Output only] Slot-milliseconds the job spent in the given reservation.

JobStatistics2Response

BiEngineStatistics This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.BiEngineStatisticsResponse
BI Engine specific Statistics. [Output only] BI Engine specific Statistics.
BillingTier This property is required. int
[Output only] Billing tier for the job.
CacheHit This property is required. bool
[Output only] Whether the query result was fetched from the query cache.
DdlAffectedRowAccessPolicyCount This property is required. string
[Output only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
DdlDestinationTable This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.TableReferenceResponse
[Output only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information.
DdlOperationPerformed This property is required. string
The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.
DdlTargetDataset This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.DatasetReferenceResponse
[Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP/UNDROP SCHEMA queries.
DdlTargetRoutine This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.RoutineReferenceResponse
The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
DdlTargetRowAccessPolicy This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.RowAccessPolicyReferenceResponse
[Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
DdlTargetTable This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.TableReferenceResponse
[Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
DmlStats This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.DmlStatisticsResponse
[Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.
EstimatedBytesProcessed This property is required. string
[Output only] The original estimate of bytes processed for the job.
MlStatistics This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.MlStatisticsResponse
[Output only] Statistics of a BigQuery ML training job.
ModelTraining This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.BigQueryModelTrainingResponse
[Output only, Beta] Information about create model query job progress.
ModelTrainingCurrentIteration This property is required. int
[Output only, Beta] Deprecated; do not use.

Deprecated: [Output only, Beta] Deprecated; do not use.

ModelTrainingExpectedTotalIteration This property is required. string
[Output only, Beta] Deprecated; do not use.

Deprecated: [Output only, Beta] Deprecated; do not use.

NumDmlAffectedRows This property is required. string
[Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
QueryPlan This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.ExplainQueryStageResponse>
[Output only] Describes execution plan for the query.
ReferencedRoutines This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.RoutineReferenceResponse>
[Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
ReferencedTables This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.TableReferenceResponse>
[Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
ReservationUsage This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.JobStatistics2ReservationUsageItemResponse>
[Output only] Job resource usage breakdown by reservation.
Schema This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.TableSchemaResponse
[Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
SearchStatistics This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.SearchStatisticsResponse
[Output only] Search query specific statistics.
SparkStatistics This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.SparkStatisticsResponse
[Output only] Statistics of a Spark procedure job.
StatementType This property is required. string
The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.
Timeline This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.QueryTimelineSampleResponse>
[Output only] [Beta] Describes a timeline of job execution.
TotalBytesBilled This property is required. string
[Output only] Total bytes billed for the job.
TotalBytesProcessed This property is required. string
[Output only] Total bytes processed for the job.
TotalBytesProcessedAccuracy This property is required. string
[Output only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
TotalPartitionsProcessed This property is required. string
[Output only] Total number of partitions processed from all partitioned tables referenced in the job.
TotalSlotMs This property is required. string
[Output only] Slot-milliseconds for the job.
TransferredBytes This property is required. string
Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
UndeclaredQueryParameters This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.QueryParameterResponse>
Standard SQL only: list of undeclared query parameters detected during a dry run validation.
BiEngineStatistics This property is required. BiEngineStatisticsResponse
BI Engine specific Statistics. [Output only] BI Engine specific Statistics.
BillingTier This property is required. int
[Output only] Billing tier for the job.
CacheHit This property is required. bool
[Output only] Whether the query result was fetched from the query cache.
DdlAffectedRowAccessPolicyCount This property is required. string
[Output only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
DdlDestinationTable This property is required. TableReferenceResponse
[Output only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information.
DdlOperationPerformed This property is required. string
The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.
DdlTargetDataset This property is required. DatasetReferenceResponse
[Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP/UNDROP SCHEMA queries.
DdlTargetRoutine This property is required. RoutineReferenceResponse
The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
DdlTargetRowAccessPolicy This property is required. RowAccessPolicyReferenceResponse
[Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
DdlTargetTable This property is required. TableReferenceResponse
[Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
DmlStats This property is required. DmlStatisticsResponse
[Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.
EstimatedBytesProcessed This property is required. string
[Output only] The original estimate of bytes processed for the job.
MlStatistics This property is required. MlStatisticsResponse
[Output only] Statistics of a BigQuery ML training job.
ModelTraining This property is required. BigQueryModelTrainingResponse
[Output only, Beta] Information about create model query job progress.
ModelTrainingCurrentIteration This property is required. int
[Output only, Beta] Deprecated; do not use.

Deprecated: [Output only, Beta] Deprecated; do not use.

ModelTrainingExpectedTotalIteration This property is required. string
[Output only, Beta] Deprecated; do not use.

Deprecated: [Output only, Beta] Deprecated; do not use.

NumDmlAffectedRows This property is required. string
[Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
QueryPlan This property is required. []ExplainQueryStageResponse
[Output only] Describes execution plan for the query.
ReferencedRoutines This property is required. []RoutineReferenceResponse
[Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
ReferencedTables This property is required. []TableReferenceResponse
[Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
ReservationUsage This property is required. []JobStatistics2ReservationUsageItemResponse
[Output only] Job resource usage breakdown by reservation.
Schema This property is required. TableSchemaResponse
[Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
SearchStatistics This property is required. SearchStatisticsResponse
[Output only] Search query specific statistics.
SparkStatistics This property is required. SparkStatisticsResponse
[Output only] Statistics of a Spark procedure job.
StatementType This property is required. string
The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.
Timeline This property is required. []QueryTimelineSampleResponse
[Output only] [Beta] Describes a timeline of job execution.
TotalBytesBilled This property is required. string
[Output only] Total bytes billed for the job.
TotalBytesProcessed This property is required. string
[Output only] Total bytes processed for the job.
TotalBytesProcessedAccuracy This property is required. string
[Output only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
TotalPartitionsProcessed This property is required. string
[Output only] Total number of partitions processed from all partitioned tables referenced in the job.
TotalSlotMs This property is required. string
[Output only] Slot-milliseconds for the job.
TransferredBytes This property is required. string
Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
UndeclaredQueryParameters This property is required. []QueryParameterResponse
Standard SQL only: list of undeclared query parameters detected during a dry run validation.
biEngineStatistics This property is required. BiEngineStatisticsResponse
BI Engine specific Statistics. [Output only] BI Engine specific Statistics.
billingTier This property is required. Integer
[Output only] Billing tier for the job.
cacheHit This property is required. Boolean
[Output only] Whether the query result was fetched from the query cache.
ddlAffectedRowAccessPolicyCount This property is required. String
[Output only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
ddlDestinationTable This property is required. TableReferenceResponse
[Output only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information.
ddlOperationPerformed This property is required. String
The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.
ddlTargetDataset This property is required. DatasetReferenceResponse
[Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP/UNDROP SCHEMA queries.
ddlTargetRoutine This property is required. RoutineReferenceResponse
The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
ddlTargetRowAccessPolicy This property is required. RowAccessPolicyReferenceResponse
[Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
ddlTargetTable This property is required. TableReferenceResponse
[Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
dmlStats This property is required. DmlStatisticsResponse
[Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.
estimatedBytesProcessed This property is required. String
[Output only] The original estimate of bytes processed for the job.
mlStatistics This property is required. MlStatisticsResponse
[Output only] Statistics of a BigQuery ML training job.
modelTraining This property is required. BigQueryModelTrainingResponse
[Output only, Beta] Information about create model query job progress.
modelTrainingCurrentIteration This property is required. Integer
[Output only, Beta] Deprecated; do not use.

Deprecated: [Output only, Beta] Deprecated; do not use.

modelTrainingExpectedTotalIteration This property is required. String
[Output only, Beta] Deprecated; do not use.

Deprecated: [Output only, Beta] Deprecated; do not use.

numDmlAffectedRows This property is required. String
[Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
queryPlan This property is required. List<ExplainQueryStageResponse>
[Output only] Describes execution plan for the query.
referencedRoutines This property is required. List<RoutineReferenceResponse>
[Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
referencedTables This property is required. List<TableReferenceResponse>
[Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
reservationUsage This property is required. List<JobStatistics2ReservationUsageItemResponse>
[Output only] Job resource usage breakdown by reservation.
schema This property is required. TableSchemaResponse
[Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
searchStatistics This property is required. SearchStatisticsResponse
[Output only] Search query specific statistics.
sparkStatistics This property is required. SparkStatisticsResponse
[Output only] Statistics of a Spark procedure job.
statementType This property is required. String
The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.
timeline This property is required. List<QueryTimelineSampleResponse>
[Output only] [Beta] Describes a timeline of job execution.
totalBytesBilled This property is required. String
[Output only] Total bytes billed for the job.
totalBytesProcessed This property is required. String
[Output only] Total bytes processed for the job.
totalBytesProcessedAccuracy This property is required. String
[Output only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
totalPartitionsProcessed This property is required. String
[Output only] Total number of partitions processed from all partitioned tables referenced in the job.
totalSlotMs This property is required. String
[Output only] Slot-milliseconds for the job.
transferredBytes This property is required. String
Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
undeclaredQueryParameters This property is required. List<QueryParameterResponse>
Standard SQL only: list of undeclared query parameters detected during a dry run validation.
biEngineStatistics This property is required. BiEngineStatisticsResponse
BI Engine specific Statistics. [Output only] BI Engine specific Statistics.
billingTier This property is required. number
[Output only] Billing tier for the job.
cacheHit This property is required. boolean
[Output only] Whether the query result was fetched from the query cache.
ddlAffectedRowAccessPolicyCount This property is required. string
[Output only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
ddlDestinationTable This property is required. TableReferenceResponse
[Output only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information.
ddlOperationPerformed This property is required. string
The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.
ddlTargetDataset This property is required. DatasetReferenceResponse
[Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP/UNDROP SCHEMA queries.
ddlTargetRoutine This property is required. RoutineReferenceResponse
The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
ddlTargetRowAccessPolicy This property is required. RowAccessPolicyReferenceResponse
[Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
ddlTargetTable This property is required. TableReferenceResponse
[Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
dmlStats This property is required. DmlStatisticsResponse
[Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.
estimatedBytesProcessed This property is required. string
[Output only] The original estimate of bytes processed for the job.
mlStatistics This property is required. MlStatisticsResponse
[Output only] Statistics of a BigQuery ML training job.
modelTraining This property is required. BigQueryModelTrainingResponse
[Output only, Beta] Information about create model query job progress.
modelTrainingCurrentIteration This property is required. number
[Output only, Beta] Deprecated; do not use.

Deprecated: [Output only, Beta] Deprecated; do not use.

modelTrainingExpectedTotalIteration This property is required. string
[Output only, Beta] Deprecated; do not use.

Deprecated: [Output only, Beta] Deprecated; do not use.

numDmlAffectedRows This property is required. string
[Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
queryPlan This property is required. ExplainQueryStageResponse[]
[Output only] Describes execution plan for the query.
referencedRoutines This property is required. RoutineReferenceResponse[]
[Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
referencedTables This property is required. TableReferenceResponse[]
[Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
reservationUsage This property is required. JobStatistics2ReservationUsageItemResponse[]
[Output only] Job resource usage breakdown by reservation.
schema This property is required. TableSchemaResponse
[Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
searchStatistics This property is required. SearchStatisticsResponse
[Output only] Search query specific statistics.
sparkStatistics This property is required. SparkStatisticsResponse
[Output only] Statistics of a Spark procedure job.
statementType This property is required. string
The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.
timeline This property is required. QueryTimelineSampleResponse[]
[Output only] [Beta] Describes a timeline of job execution.
totalBytesBilled This property is required. string
[Output only] Total bytes billed for the job.
totalBytesProcessed This property is required. string
[Output only] Total bytes processed for the job.
totalBytesProcessedAccuracy This property is required. string
[Output only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
totalPartitionsProcessed This property is required. string
[Output only] Total number of partitions processed from all partitioned tables referenced in the job.
totalSlotMs This property is required. string
[Output only] Slot-milliseconds for the job.
transferredBytes This property is required. string
Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
undeclaredQueryParameters This property is required. QueryParameterResponse[]
Standard SQL only: list of undeclared query parameters detected during a dry run validation.
bi_engine_statistics This property is required. BiEngineStatisticsResponse
BI Engine specific Statistics. [Output only] BI Engine specific Statistics.
billing_tier This property is required. int
[Output only] Billing tier for the job.
cache_hit This property is required. bool
[Output only] Whether the query result was fetched from the query cache.
ddl_affected_row_access_policy_count This property is required. str
[Output only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
ddl_destination_table This property is required. TableReferenceResponse
[Output only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information.
ddl_operation_performed This property is required. str
The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.
ddl_target_dataset This property is required. DatasetReferenceResponse
[Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP/UNDROP SCHEMA queries.
ddl_target_routine This property is required. RoutineReferenceResponse
The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
ddl_target_row_access_policy This property is required. RowAccessPolicyReferenceResponse
[Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
ddl_target_table This property is required. TableReferenceResponse
[Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
dml_stats This property is required. DmlStatisticsResponse
[Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.
estimated_bytes_processed This property is required. str
[Output only] The original estimate of bytes processed for the job.
ml_statistics This property is required. MlStatisticsResponse
[Output only] Statistics of a BigQuery ML training job.
model_training This property is required. BigQueryModelTrainingResponse
[Output only, Beta] Information about create model query job progress.
model_training_current_iteration This property is required. int
[Output only, Beta] Deprecated; do not use.

Deprecated: [Output only, Beta] Deprecated; do not use.

model_training_expected_total_iteration This property is required. str
[Output only, Beta] Deprecated; do not use.

Deprecated: [Output only, Beta] Deprecated; do not use.

num_dml_affected_rows This property is required. str
[Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
query_plan This property is required. Sequence[ExplainQueryStageResponse]
[Output only] Describes execution plan for the query.
referenced_routines This property is required. Sequence[RoutineReferenceResponse]
[Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
referenced_tables This property is required. Sequence[TableReferenceResponse]
[Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
reservation_usage This property is required. Sequence[JobStatistics2ReservationUsageItemResponse]
[Output only] Job resource usage breakdown by reservation.
schema This property is required. TableSchemaResponse
[Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
search_statistics This property is required. SearchStatisticsResponse
[Output only] Search query specific statistics.
spark_statistics This property is required. SparkStatisticsResponse
[Output only] Statistics of a Spark procedure job.
statement_type This property is required. str
The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.
timeline This property is required. Sequence[QueryTimelineSampleResponse]
[Output only] [Beta] Describes a timeline of job execution.
total_bytes_billed This property is required. str
[Output only] Total bytes billed for the job.
total_bytes_processed This property is required. str
[Output only] Total bytes processed for the job.
total_bytes_processed_accuracy This property is required. str
[Output only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
total_partitions_processed This property is required. str
[Output only] Total number of partitions processed from all partitioned tables referenced in the job.
total_slot_ms This property is required. str
[Output only] Slot-milliseconds for the job.
transferred_bytes This property is required. str
Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
undeclared_query_parameters This property is required. Sequence[QueryParameterResponse]
Standard SQL only: list of undeclared query parameters detected during a dry run validation.
biEngineStatistics This property is required. Property Map
BI Engine specific Statistics. [Output only] BI Engine specific Statistics.
billingTier This property is required. Number
[Output only] Billing tier for the job.
cacheHit This property is required. Boolean
[Output only] Whether the query result was fetched from the query cache.
ddlAffectedRowAccessPolicyCount This property is required. String
[Output only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
ddlDestinationTable This property is required. Property Map
[Output only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information.
ddlOperationPerformed This property is required. String
The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.
ddlTargetDataset This property is required. Property Map
[Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP/UNDROP SCHEMA queries.
ddlTargetRoutine This property is required. Property Map
The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
ddlTargetRowAccessPolicy This property is required. Property Map
[Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
ddlTargetTable This property is required. Property Map
[Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
dmlStats This property is required. Property Map
[Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.
estimatedBytesProcessed This property is required. String
[Output only] The original estimate of bytes processed for the job.
mlStatistics This property is required. Property Map
[Output only] Statistics of a BigQuery ML training job.
modelTraining This property is required. Property Map
[Output only, Beta] Information about create model query job progress.
modelTrainingCurrentIteration This property is required. Number
[Output only, Beta] Deprecated; do not use.

Deprecated: [Output only, Beta] Deprecated; do not use.

modelTrainingExpectedTotalIteration This property is required. String
[Output only, Beta] Deprecated; do not use.

Deprecated: [Output only, Beta] Deprecated; do not use.

numDmlAffectedRows This property is required. String
[Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
queryPlan This property is required. List<Property Map>
[Output only] Describes execution plan for the query.
referencedRoutines This property is required. List<Property Map>
[Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
referencedTables This property is required. List<Property Map>
[Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
reservationUsage This property is required. List<Property Map>
[Output only] Job resource usage breakdown by reservation.
schema This property is required. Property Map
[Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
searchStatistics This property is required. Property Map
[Output only] Search query specific statistics.
sparkStatistics This property is required. Property Map
[Output only] Statistics of a Spark procedure job.
statementType This property is required. String
The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.
timeline This property is required. List<Property Map>
[Output only] [Beta] Describes a timeline of job execution.
totalBytesBilled This property is required. String
[Output only] Total bytes billed for the job.
totalBytesProcessed This property is required. String
[Output only] Total bytes processed for the job.
totalBytesProcessedAccuracy This property is required. String
[Output only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
totalPartitionsProcessed This property is required. String
[Output only] Total number of partitions processed from all partitioned tables referenced in the job.
totalSlotMs This property is required. String
[Output only] Slot-milliseconds for the job.
transferredBytes This property is required. String
Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
undeclaredQueryParameters This property is required. List<Property Map>
Standard SQL only: list of undeclared query parameters detected during a dry run validation.

JobStatistics3Response

BadRecords This property is required. string
The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
InputFileBytes This property is required. string
Number of bytes of source data in a load job.
InputFiles This property is required. string
Number of source files in a load job.
OutputBytes This property is required. string
Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
OutputRows This property is required. string
Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
BadRecords This property is required. string
The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
InputFileBytes This property is required. string
Number of bytes of source data in a load job.
InputFiles This property is required. string
Number of source files in a load job.
OutputBytes This property is required. string
Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
OutputRows This property is required. string
Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
badRecords This property is required. String
The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
inputFileBytes This property is required. String
Number of bytes of source data in a load job.
inputFiles This property is required. String
Number of source files in a load job.
outputBytes This property is required. String
Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
outputRows This property is required. String
Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
badRecords This property is required. string
The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
inputFileBytes This property is required. string
Number of bytes of source data in a load job.
inputFiles This property is required. string
Number of source files in a load job.
outputBytes This property is required. string
Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
outputRows This property is required. string
Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
bad_records This property is required. str
The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
input_file_bytes This property is required. str
Number of bytes of source data in a load job.
input_files This property is required. str
Number of source files in a load job.
output_bytes This property is required. str
Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
output_rows This property is required. str
Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
badRecords This property is required. String
The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
inputFileBytes This property is required. String
Number of bytes of source data in a load job.
inputFiles This property is required. String
Number of source files in a load job.
outputBytes This property is required. String
Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
outputRows This property is required. String
Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.

JobStatistics4Response

DestinationUriFileCounts This property is required. List<string>
Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
InputBytes This property is required. string
Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.
DestinationUriFileCounts This property is required. []string
Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
InputBytes This property is required. string
Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.
destinationUriFileCounts This property is required. List<String>
Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
inputBytes This property is required. String
Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.
destinationUriFileCounts This property is required. string[]
Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
inputBytes This property is required. string
Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.
destination_uri_file_counts This property is required. Sequence[str]
Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
input_bytes This property is required. str
Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.
destinationUriFileCounts This property is required. List<String>
Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
inputBytes This property is required. String
Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.

JobStatistics5Response

CopiedLogicalBytes This property is required. string
Number of logical bytes copied to the destination table.
CopiedRows This property is required. string
Number of rows copied to the destination table.
CopiedLogicalBytes This property is required. string
Number of logical bytes copied to the destination table.
CopiedRows This property is required. string
Number of rows copied to the destination table.
copiedLogicalBytes This property is required. String
Number of logical bytes copied to the destination table.
copiedRows This property is required. String
Number of rows copied to the destination table.
copiedLogicalBytes This property is required. string
Number of logical bytes copied to the destination table.
copiedRows This property is required. string
Number of rows copied to the destination table.
copied_logical_bytes This property is required. str
Number of logical bytes copied to the destination table.
copied_rows This property is required. str
Number of rows copied to the destination table.
copiedLogicalBytes This property is required. String
Number of logical bytes copied to the destination table.
copiedRows This property is required. String
Number of rows copied to the destination table.

JobStatisticsReservationUsageItemResponse

Name This property is required. string
Reservation name or "unreserved" for on-demand resources usage.
SlotMs This property is required. string
Slot-milliseconds the job spent in the given reservation.
Name This property is required. string
Reservation name or "unreserved" for on-demand resources usage.
SlotMs This property is required. string
Slot-milliseconds the job spent in the given reservation.
name This property is required. String
Reservation name or "unreserved" for on-demand resources usage.
slotMs This property is required. String
Slot-milliseconds the job spent in the given reservation.
name This property is required. string
Reservation name or "unreserved" for on-demand resources usage.
slotMs This property is required. string
Slot-milliseconds the job spent in the given reservation.
name This property is required. str
Reservation name or "unreserved" for on-demand resources usage.
slot_ms This property is required. str
Slot-milliseconds the job spent in the given reservation.
name This property is required. String
Reservation name or "unreserved" for on-demand resources usage.
slotMs This property is required. String
Slot-milliseconds the job spent in the given reservation.

JobStatisticsResponse

CompletionRatio This property is required. double
[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
Copy This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.JobStatistics5Response
Statistics for a copy job.
CreationTime This property is required. string
Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
DataMaskingStatistics This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.DataMaskingStatisticsResponse
Statistics for data masking. Present only for query and extract jobs.
EndTime This property is required. string
End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
Extract This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.JobStatistics4Response
Statistics for an extract job.
Load This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.JobStatistics3Response
Statistics for a load job.
NumChildJobs This property is required. string
Number of child jobs executed.
ParentJobId This property is required. string
If this is a child job, the id of the parent.
Query This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.JobStatistics2Response
Statistics for a query job.
QuotaDeferments This property is required. List<string>
Quotas which delayed this job's start time.
ReservationId This property is required. string
Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
ReservationUsage This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.JobStatisticsReservationUsageItemResponse>
Job resource usage breakdown by reservation.
RowLevelSecurityStatistics This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.RowLevelSecurityStatisticsResponse
[Preview] Statistics for row-level security. Present only for query and extract jobs.
ScriptStatistics This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.ScriptStatisticsResponse
Statistics for a child job of a script.
SessionInfo This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.SessionInfoResponse
[Preview] Information of the session if this job is part of one.
StartTime This property is required. string
Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
TotalBytesProcessed This property is required. string
[Deprecated] Use the bytes processed in the query statistics instead.

Deprecated: [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.

TotalSlotMs This property is required. string
Slot-milliseconds for the job.
TransactionInfo This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.TransactionInfoResponse
[Alpha] Information of the multi-statement transaction if this job is part of one.
CompletionRatio This property is required. float64
[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
Copy This property is required. JobStatistics5Response
Statistics for a copy job.
CreationTime This property is required. string
Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
DataMaskingStatistics This property is required. DataMaskingStatisticsResponse
Statistics for data masking. Present only for query and extract jobs.
EndTime This property is required. string
End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
Extract This property is required. JobStatistics4Response
Statistics for an extract job.
Load This property is required. JobStatistics3Response
Statistics for a load job.
NumChildJobs This property is required. string
Number of child jobs executed.
ParentJobId This property is required. string
If this is a child job, the id of the parent.
Query This property is required. JobStatistics2Response
Statistics for a query job.
QuotaDeferments This property is required. []string
Quotas which delayed this job's start time.
ReservationId This property is required. string
Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
ReservationUsage This property is required. []JobStatisticsReservationUsageItemResponse
Job resource usage breakdown by reservation.
RowLevelSecurityStatistics This property is required. RowLevelSecurityStatisticsResponse
[Preview] Statistics for row-level security. Present only for query and extract jobs.
ScriptStatistics This property is required. ScriptStatisticsResponse
Statistics for a child job of a script.
SessionInfo This property is required. SessionInfoResponse
[Preview] Information of the session if this job is part of one.
StartTime This property is required. string
Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
TotalBytesProcessed This property is required. string
[Deprecated] Use the bytes processed in the query statistics instead.

Deprecated: [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.

TotalSlotMs This property is required. string
Slot-milliseconds for the job.
TransactionInfo This property is required. TransactionInfoResponse
[Alpha] Information of the multi-statement transaction if this job is part of one.
completionRatio This property is required. Double
[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
copy This property is required. JobStatistics5Response
Statistics for a copy job.
creationTime This property is required. String
Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
dataMaskingStatistics This property is required. DataMaskingStatisticsResponse
Statistics for data masking. Present only for query and extract jobs.
endTime This property is required. String
End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
extract This property is required. JobStatistics4Response
Statistics for an extract job.
load This property is required. JobStatistics3Response
Statistics for a load job.
numChildJobs This property is required. String
Number of child jobs executed.
parentJobId This property is required. String
If this is a child job, the id of the parent.
query This property is required. JobStatistics2Response
Statistics for a query job.
quotaDeferments This property is required. List<String>
Quotas which delayed this job's start time.
reservationId This property is required. String
Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
reservationUsage This property is required. List<JobStatisticsReservationUsageItemResponse>
Job resource usage breakdown by reservation.
rowLevelSecurityStatistics This property is required. RowLevelSecurityStatisticsResponse
[Preview] Statistics for row-level security. Present only for query and extract jobs.
scriptStatistics This property is required. ScriptStatisticsResponse
Statistics for a child job of a script.
sessionInfo This property is required. SessionInfoResponse
[Preview] Information of the session if this job is part of one.
startTime This property is required. String
Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
totalBytesProcessed This property is required. String
[Deprecated] Use the bytes processed in the query statistics instead.

Deprecated: [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.

totalSlotMs This property is required. String
Slot-milliseconds for the job.
transactionInfo This property is required. TransactionInfoResponse
[Alpha] Information of the multi-statement transaction if this job is part of one.
completionRatio This property is required. number
[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
copy This property is required. JobStatistics5Response
Statistics for a copy job.
creationTime This property is required. string
Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
dataMaskingStatistics This property is required. DataMaskingStatisticsResponse
Statistics for data masking. Present only for query and extract jobs.
endTime This property is required. string
End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
extract This property is required. JobStatistics4Response
Statistics for an extract job.
load This property is required. JobStatistics3Response
Statistics for a load job.
numChildJobs This property is required. string
Number of child jobs executed.
parentJobId This property is required. string
If this is a child job, the id of the parent.
query This property is required. JobStatistics2Response
Statistics for a query job.
quotaDeferments This property is required. string[]
Quotas which delayed this job's start time.
reservationId This property is required. string
Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
reservationUsage This property is required. JobStatisticsReservationUsageItemResponse[]
Job resource usage breakdown by reservation.
rowLevelSecurityStatistics This property is required. RowLevelSecurityStatisticsResponse
[Preview] Statistics for row-level security. Present only for query and extract jobs.
scriptStatistics This property is required. ScriptStatisticsResponse
Statistics for a child job of a script.
sessionInfo This property is required. SessionInfoResponse
[Preview] Information of the session if this job is part of one.
startTime This property is required. string
Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
totalBytesProcessed This property is required. string
[Deprecated] Use the bytes processed in the query statistics instead.

Deprecated: [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.

totalSlotMs This property is required. string
Slot-milliseconds for the job.
transactionInfo This property is required. TransactionInfoResponse
[Alpha] Information of the multi-statement transaction if this job is part of one.
completion_ratio This property is required. float
[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
copy This property is required. JobStatistics5Response
Statistics for a copy job.
creation_time This property is required. str
Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
data_masking_statistics This property is required. DataMaskingStatisticsResponse
Statistics for data masking. Present only for query and extract jobs.
end_time This property is required. str
End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
extract This property is required. JobStatistics4Response
Statistics for an extract job.
load This property is required. JobStatistics3Response
Statistics for a load job.
num_child_jobs This property is required. str
Number of child jobs executed.
parent_job_id This property is required. str
If this is a child job, the id of the parent.
query This property is required. JobStatistics2Response
Statistics for a query job.
quota_deferments This property is required. Sequence[str]
Quotas which delayed this job's start time.
reservation_id This property is required. str
Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
reservation_usage This property is required. Sequence[JobStatisticsReservationUsageItemResponse]
Job resource usage breakdown by reservation.
row_level_security_statistics This property is required. RowLevelSecurityStatisticsResponse
[Preview] Statistics for row-level security. Present only for query and extract jobs.
script_statistics This property is required. ScriptStatisticsResponse
Statistics for a child job of a script.
session_info This property is required. SessionInfoResponse
[Preview] Information of the session if this job is part of one.
start_time This property is required. str
Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
total_bytes_processed This property is required. str
[Deprecated] Use the bytes processed in the query statistics instead.

Deprecated: [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.

total_slot_ms This property is required. str
Slot-milliseconds for the job.
transaction_info This property is required. TransactionInfoResponse
[Alpha] Information of the multi-statement transaction if this job is part of one.
completionRatio This property is required. Number
[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
copy This property is required. Property Map
Statistics for a copy job.
creationTime This property is required. String
Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
dataMaskingStatistics This property is required. Property Map
Statistics for data masking. Present only for query and extract jobs.
endTime This property is required. String
End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
extract This property is required. Property Map
Statistics for an extract job.
load This property is required. Property Map
Statistics for a load job.
numChildJobs This property is required. String
Number of child jobs executed.
parentJobId This property is required. String
If this is a child job, the id of the parent.
query This property is required. Property Map
Statistics for a query job.
quotaDeferments This property is required. List<String>
Quotas which delayed this job's start time.
reservationId This property is required. String
Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
reservationUsage This property is required. List<Property Map>
Job resource usage breakdown by reservation.
rowLevelSecurityStatistics This property is required. Property Map
[Preview] Statistics for row-level security. Present only for query and extract jobs.
scriptStatistics This property is required. Property Map
Statistics for a child job of a script.
sessionInfo This property is required. Property Map
[Preview] Information of the session if this job is part of one.
startTime This property is required. String
Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
totalBytesProcessed This property is required. String
[Deprecated] Use the bytes processed in the query statistics instead.

Deprecated: [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.

totalSlotMs This property is required. String
Slot-milliseconds for the job.
transactionInfo This property is required. Property Map
[Alpha] Information of the multi-statement transaction if this job is part of one.

JobStatusResponse

ErrorResult This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.ErrorProtoResponse
Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
Errors This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.ErrorProtoResponse>
The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
State This property is required. string
Running state of the job.
ErrorResult This property is required. ErrorProtoResponse
Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
Errors This property is required. []ErrorProtoResponse
The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
State This property is required. string
Running state of the job.
errorResult This property is required. ErrorProtoResponse
Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
errors This property is required. List<ErrorProtoResponse>
The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
state This property is required. String
Running state of the job.
errorResult This property is required. ErrorProtoResponse
Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
errors This property is required. ErrorProtoResponse[]
The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
state This property is required. string
Running state of the job.
error_result This property is required. ErrorProtoResponse
Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
errors This property is required. Sequence[ErrorProtoResponse]
The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
state This property is required. str
Running state of the job.
errorResult This property is required. Property Map
Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
errors This property is required. List<Property Map>
The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
state This property is required. String
Running state of the job.

MlStatisticsResponse

IterationResults This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.IterationResultResponse>
Results for all completed iterations.
MaxIterations This property is required. string
Maximum number of iterations specified as max_iterations in the 'CREATE MODEL' query. The actual number of iterations may be less than this number due to early stop.
IterationResults This property is required. []IterationResultResponse
Results for all completed iterations.
MaxIterations This property is required. string
Maximum number of iterations specified as max_iterations in the 'CREATE MODEL' query. The actual number of iterations may be less than this number due to early stop.
iterationResults This property is required. List<IterationResultResponse>
Results for all completed iterations.
maxIterations This property is required. String
Maximum number of iterations specified as max_iterations in the 'CREATE MODEL' query. The actual number of iterations may be less than this number due to early stop.
iterationResults This property is required. IterationResultResponse[]
Results for all completed iterations.
maxIterations This property is required. string
Maximum number of iterations specified as max_iterations in the 'CREATE MODEL' query. The actual number of iterations may be less than this number due to early stop.
iteration_results This property is required. Sequence[IterationResultResponse]
Results for all completed iterations.
max_iterations This property is required. str
Maximum number of iterations specified as max_iterations in the 'CREATE MODEL' query. The actual number of iterations may be less than this number due to early stop.
iterationResults This property is required. List<Property Map>
Results for all completed iterations.
maxIterations This property is required. String
Maximum number of iterations specified as max_iterations in the 'CREATE MODEL' query. The actual number of iterations may be less than this number due to early stop.

ModelReferenceResponse

DatasetId This property is required. string
The ID of the dataset containing this model.
ModelId This property is required. string
The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
Project This property is required. string
The ID of the project containing this model.
DatasetId This property is required. string
The ID of the dataset containing this model.
ModelId This property is required. string
The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
Project This property is required. string
The ID of the project containing this model.
datasetId This property is required. String
The ID of the dataset containing this model.
modelId This property is required. String
The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
project This property is required. String
The ID of the project containing this model.
datasetId This property is required. string
The ID of the dataset containing this model.
modelId This property is required. string
The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
project This property is required. string
The ID of the project containing this model.
dataset_id This property is required. str
The ID of the dataset containing this model.
model_id This property is required. str
The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
project This property is required. str
The ID of the project containing this model.
datasetId This property is required. String
The ID of the dataset containing this model.
modelId This property is required. String
The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
project This property is required. String
The ID of the project containing this model.

ParquetOptionsResponse

EnableListInference This property is required. bool
[Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.
EnumAsString This property is required. bool
[Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
EnableListInference This property is required. bool
[Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.
EnumAsString This property is required. bool
[Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
enableListInference This property is required. Boolean
[Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.
enumAsString This property is required. Boolean
[Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
enableListInference This property is required. boolean
[Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.
enumAsString This property is required. boolean
[Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
enable_list_inference This property is required. bool
[Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.
enum_as_string This property is required. bool
[Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
enableListInference This property is required. Boolean
[Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.
enumAsString This property is required. Boolean
[Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.

QueryParameterResponse

Name This property is required. string
[Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
ParameterType This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.QueryParameterTypeResponse
[Required] The type of this parameter.
ParameterValue This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.QueryParameterValueResponse
[Required] The value of this parameter.
Name This property is required. string
[Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
ParameterType This property is required. QueryParameterTypeResponse
[Required] The type of this parameter.
ParameterValue This property is required. QueryParameterValueResponse
[Required] The value of this parameter.
name This property is required. String
[Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
parameterType This property is required. QueryParameterTypeResponse
[Required] The type of this parameter.
parameterValue This property is required. QueryParameterValueResponse
[Required] The value of this parameter.
name This property is required. string
[Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
parameterType This property is required. QueryParameterTypeResponse
[Required] The type of this parameter.
parameterValue This property is required. QueryParameterValueResponse
[Required] The value of this parameter.
name This property is required. str
[Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
parameter_type This property is required. QueryParameterTypeResponse
[Required] The type of this parameter.
parameter_value This property is required. QueryParameterValueResponse
[Required] The value of this parameter.
name This property is required. String
[Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
parameterType This property is required. Property Map
[Required] The type of this parameter.
parameterValue This property is required. Property Map
[Required] The value of this parameter.

QueryParameterTypeResponse

StructTypes This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.QueryParameterTypeStructTypesItemResponse>
[Optional] The types of the fields of this struct, in order, if this is a struct.
Type This property is required. string
[Required] The top level type of this field.
ArrayType Pulumi.GoogleNative.BigQuery.V2.Inputs.QueryParameterTypeResponse
[Optional] The type of the array's elements, if this is an array.
StructTypes This property is required. []QueryParameterTypeStructTypesItemResponse
[Optional] The types of the fields of this struct, in order, if this is a struct.
Type This property is required. string
[Required] The top level type of this field.
ArrayType QueryParameterTypeResponse
[Optional] The type of the array's elements, if this is an array.
structTypes This property is required. List<QueryParameterTypeStructTypesItemResponse>
[Optional] The types of the fields of this struct, in order, if this is a struct.
type This property is required. String
[Required] The top level type of this field.
arrayType QueryParameterTypeResponse
[Optional] The type of the array's elements, if this is an array.
structTypes This property is required. QueryParameterTypeStructTypesItemResponse[]
[Optional] The types of the fields of this struct, in order, if this is a struct.
type This property is required. string
[Required] The top level type of this field.
arrayType QueryParameterTypeResponse
[Optional] The type of the array's elements, if this is an array.
struct_types This property is required. Sequence[QueryParameterTypeStructTypesItemResponse]
[Optional] The types of the fields of this struct, in order, if this is a struct.
type This property is required. str
[Required] The top level type of this field.
array_type QueryParameterTypeResponse
[Optional] The type of the array's elements, if this is an array.
structTypes This property is required. List<Property Map>
[Optional] The types of the fields of this struct, in order, if this is a struct.
type This property is required. String
[Required] The top level type of this field.
arrayType Property Map
[Optional] The type of the array's elements, if this is an array.

QueryParameterTypeStructTypesItemResponse

Description This property is required. string
[Optional] Human-oriented description of the field.
Name This property is required. string
[Optional] The name of this field.
Type This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.QueryParameterTypeResponse
[Required] The type of this field.
Description This property is required. string
[Optional] Human-oriented description of the field.
Name This property is required. string
[Optional] The name of this field.
Type This property is required. QueryParameterTypeResponse
[Required] The type of this field.
description This property is required. String
[Optional] Human-oriented description of the field.
name This property is required. String
[Optional] The name of this field.
type This property is required. QueryParameterTypeResponse
[Required] The type of this field.
description This property is required. string
[Optional] Human-oriented description of the field.
name This property is required. string
[Optional] The name of this field.
type This property is required. QueryParameterTypeResponse
[Required] The type of this field.
description This property is required. str
[Optional] Human-oriented description of the field.
name This property is required. str
[Optional] The name of this field.
type This property is required. QueryParameterTypeResponse
[Required] The type of this field.
description This property is required. String
[Optional] Human-oriented description of the field.
name This property is required. String
[Optional] The name of this field.
type This property is required. Property Map
[Required] The type of this field.

QueryParameterValueResponse

ArrayValues This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.QueryParameterValueResponse>
[Optional] The array values, if this is an array type.
StructValues This property is required. Dictionary<string, string>
[Optional] The struct field values, in order of the struct type's declaration.
Value This property is required. string
[Optional] The value of this value, if a simple scalar type.
ArrayValues This property is required. []QueryParameterValueResponse
[Optional] The array values, if this is an array type.
StructValues This property is required. map[string]string
[Optional] The struct field values, in order of the struct type's declaration.
Value This property is required. string
[Optional] The value of this value, if a simple scalar type.
arrayValues This property is required. List<QueryParameterValueResponse>
[Optional] The array values, if this is an array type.
structValues This property is required. Map<String,String>
[Optional] The struct field values, in order of the struct type's declaration.
value This property is required. String
[Optional] The value of this value, if a simple scalar type.
arrayValues This property is required. QueryParameterValueResponse[]
[Optional] The array values, if this is an array type.
structValues This property is required. {[key: string]: string}
[Optional] The struct field values, in order of the struct type's declaration.
value This property is required. string
[Optional] The value of this value, if a simple scalar type.
array_values This property is required. Sequence[QueryParameterValueResponse]
[Optional] The array values, if this is an array type.
struct_values This property is required. Mapping[str, str]
[Optional] The struct field values, in order of the struct type's declaration.
value This property is required. str
[Optional] The value of this value, if a simple scalar type.
arrayValues This property is required. List<Property Map>
[Optional] The array values, if this is an array type.
structValues This property is required. Map<String>
[Optional] The struct field values, in order of the struct type's declaration.
value This property is required. String
[Optional] The value of this value, if a simple scalar type.

QueryTimelineSampleResponse

ActiveUnits This property is required. string
Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
CompletedUnits This property is required. string
Total parallel units of work completed by this query.
ElapsedMs This property is required. string
Milliseconds elapsed since the start of query execution.
EstimatedRunnableUnits This property is required. string
Units of work that can be scheduled immediately. Providing additional slots for these units of work will speed up the query, provided no other query in the reservation needs additional slots.
PendingUnits This property is required. string
Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
TotalSlotMs This property is required. string
Cumulative slot-ms consumed by the query.
ActiveUnits This property is required. string
Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
CompletedUnits This property is required. string
Total parallel units of work completed by this query.
ElapsedMs This property is required. string
Milliseconds elapsed since the start of query execution.
EstimatedRunnableUnits This property is required. string
Units of work that can be scheduled immediately. Providing additional slots for these units of work will speed up the query, provided no other query in the reservation needs additional slots.
PendingUnits This property is required. string
Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
TotalSlotMs This property is required. string
Cumulative slot-ms consumed by the query.
activeUnits This property is required. String
Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
completedUnits This property is required. String
Total parallel units of work completed by this query.
elapsedMs This property is required. String
Milliseconds elapsed since the start of query execution.
estimatedRunnableUnits This property is required. String
Units of work that can be scheduled immediately. Providing additional slots for these units of work will speed up the query, provided no other query in the reservation needs additional slots.
pendingUnits This property is required. String
Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
totalSlotMs This property is required. String
Cumulative slot-ms consumed by the query.
activeUnits This property is required. string
Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
completedUnits This property is required. string
Total parallel units of work completed by this query.
elapsedMs This property is required. string
Milliseconds elapsed since the start of query execution.
estimatedRunnableUnits This property is required. string
Units of work that can be scheduled immediately. Providing additional slots for these units of work will speed up the query, provided no other query in the reservation needs additional slots.
pendingUnits This property is required. string
Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
totalSlotMs This property is required. string
Cumulative slot-ms consumed by the query.
active_units This property is required. str
Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
completed_units This property is required. str
Total parallel units of work completed by this query.
elapsed_ms This property is required. str
Milliseconds elapsed since the start of query execution.
estimated_runnable_units This property is required. str
Units of work that can be scheduled immediately. Providing additional slots for these units of work will speed up the query, provided no other query in the reservation needs additional slots.
pending_units This property is required. str
Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
total_slot_ms This property is required. str
Cumulative slot-ms consumed by the query.
activeUnits This property is required. String
Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
completedUnits This property is required. String
Total parallel units of work completed by this query.
elapsedMs This property is required. String
Milliseconds elapsed since the start of query execution.
estimatedRunnableUnits This property is required. String
Units of work that can be scheduled immediately. Providing additional slots for these units of work will speed up the query, provided no other query in the reservation needs additional slots.
pendingUnits This property is required. String
Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
totalSlotMs This property is required. String
Cumulative slot-ms consumed by the query.

RangePartitioningRangeResponse

End This property is required. string
[TrustedTester] [Required] The end of range partitioning, exclusive.
Interval This property is required. string
[TrustedTester] [Required] The width of each interval.
Start This property is required. string
[TrustedTester] [Required] The start of range partitioning, inclusive.
End This property is required. string
[TrustedTester] [Required] The end of range partitioning, exclusive.
Interval This property is required. string
[TrustedTester] [Required] The width of each interval.
Start This property is required. string
[TrustedTester] [Required] The start of range partitioning, inclusive.
end This property is required. String
[TrustedTester] [Required] The end of range partitioning, exclusive.
interval This property is required. String
[TrustedTester] [Required] The width of each interval.
start This property is required. String
[TrustedTester] [Required] The start of range partitioning, inclusive.
end This property is required. string
[TrustedTester] [Required] The end of range partitioning, exclusive.
interval This property is required. string
[TrustedTester] [Required] The width of each interval.
start This property is required. string
[TrustedTester] [Required] The start of range partitioning, inclusive.
end This property is required. str
[TrustedTester] [Required] The end of range partitioning, exclusive.
interval This property is required. str
[TrustedTester] [Required] The width of each interval.
start This property is required. str
[TrustedTester] [Required] The start of range partitioning, inclusive.
end This property is required. String
[TrustedTester] [Required] The end of range partitioning, exclusive.
interval This property is required. String
[TrustedTester] [Required] The width of each interval.
start This property is required. String
[TrustedTester] [Required] The start of range partitioning, inclusive.

RangePartitioningResponse

Field This property is required. string
[TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
Range This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.RangePartitioningRangeResponse
[TrustedTester] [Required] Defines the ranges for range partitioning.
Field This property is required. string
[TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
Range This property is required. RangePartitioningRangeResponse
[TrustedTester] [Required] Defines the ranges for range partitioning.
field This property is required. String
[TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
range This property is required. RangePartitioningRangeResponse
[TrustedTester] [Required] Defines the ranges for range partitioning.
field This property is required. string
[TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
range This property is required. RangePartitioningRangeResponse
[TrustedTester] [Required] Defines the ranges for range partitioning.
field This property is required. str
[TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
range This property is required. RangePartitioningRangeResponse
[TrustedTester] [Required] Defines the ranges for range partitioning.
field This property is required. String
[TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
range This property is required. Property Map
[TrustedTester] [Required] Defines the ranges for range partitioning.

RoutineReferenceResponse

DatasetId This property is required. string
The ID of the dataset containing this routine.
Project This property is required. string
The ID of the project containing this routine.
RoutineId This property is required. string
The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
DatasetId This property is required. string
The ID of the dataset containing this routine.
Project This property is required. string
The ID of the project containing this routine.
RoutineId This property is required. string
The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
datasetId This property is required. String
The ID of the dataset containing this routine.
project This property is required. String
The ID of the project containing this routine.
routineId This property is required. String
The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
datasetId This property is required. string
The ID of the dataset containing this routine.
project This property is required. string
The ID of the project containing this routine.
routineId This property is required. string
The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
dataset_id This property is required. str
The ID of the dataset containing this routine.
project This property is required. str
The ID of the project containing this routine.
routine_id This property is required. str
The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
datasetId This property is required. String
The ID of the dataset containing this routine.
project This property is required. String
The ID of the project containing this routine.
routineId This property is required. String
The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.

RowAccessPolicyReferenceResponse

DatasetId This property is required. string
The ID of the dataset containing this row access policy.
PolicyId This property is required. string
The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
Project This property is required. string
The ID of the project containing this row access policy.
TableId This property is required. string
The ID of the table containing this row access policy.
DatasetId This property is required. string
The ID of the dataset containing this row access policy.
PolicyId This property is required. string
The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
Project This property is required. string
The ID of the project containing this row access policy.
TableId This property is required. string
The ID of the table containing this row access policy.
datasetId This property is required. String
The ID of the dataset containing this row access policy.
policyId This property is required. String
The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
project This property is required. String
The ID of the project containing this row access policy.
tableId This property is required. String
The ID of the table containing this row access policy.
datasetId This property is required. string
The ID of the dataset containing this row access policy.
policyId This property is required. string
The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
project This property is required. string
The ID of the project containing this row access policy.
tableId This property is required. string
The ID of the table containing this row access policy.
dataset_id This property is required. str
The ID of the dataset containing this row access policy.
policy_id This property is required. str
The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
project This property is required. str
The ID of the project containing this row access policy.
table_id This property is required. str
The ID of the table containing this row access policy.
datasetId This property is required. String
The ID of the dataset containing this row access policy.
policyId This property is required. String
The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
project This property is required. String
The ID of the project containing this row access policy.
tableId This property is required. String
The ID of the table containing this row access policy.

RowLevelSecurityStatisticsResponse

RowLevelSecurityApplied This property is required. bool
[Preview] Whether any accessed data was protected by row access policies.
RowLevelSecurityApplied This property is required. bool
[Preview] Whether any accessed data was protected by row access policies.
rowLevelSecurityApplied This property is required. Boolean
[Preview] Whether any accessed data was protected by row access policies.
rowLevelSecurityApplied This property is required. boolean
[Preview] Whether any accessed data was protected by row access policies.
row_level_security_applied This property is required. bool
[Preview] Whether any accessed data was protected by row access policies.
rowLevelSecurityApplied This property is required. Boolean
[Preview] Whether any accessed data was protected by row access policies.

ScriptStackFrameResponse

EndColumn This property is required. int
One-based end column.
EndLine This property is required. int
One-based end line.
ProcedureId This property is required. string
Name of the active procedure, empty if in a top-level script.
StartColumn This property is required. int
One-based start column.
StartLine This property is required. int
One-based start line.
Text This property is required. string
Text of the current statement/expression.
EndColumn This property is required. int
One-based end column.
EndLine This property is required. int
One-based end line.
ProcedureId This property is required. string
Name of the active procedure, empty if in a top-level script.
StartColumn This property is required. int
One-based start column.
StartLine This property is required. int
One-based start line.
Text This property is required. string
Text of the current statement/expression.
endColumn This property is required. Integer
One-based end column.
endLine This property is required. Integer
One-based end line.
procedureId This property is required. String
Name of the active procedure, empty if in a top-level script.
startColumn This property is required. Integer
One-based start column.
startLine This property is required. Integer
One-based start line.
text This property is required. String
Text of the current statement/expression.
endColumn This property is required. number
One-based end column.
endLine This property is required. number
One-based end line.
procedureId This property is required. string
Name of the active procedure, empty if in a top-level script.
startColumn This property is required. number
One-based start column.
startLine This property is required. number
One-based start line.
text This property is required. string
Text of the current statement/expression.
end_column This property is required. int
One-based end column.
end_line This property is required. int
One-based end line.
procedure_id This property is required. str
Name of the active procedure, empty if in a top-level script.
start_column This property is required. int
One-based start column.
start_line This property is required. int
One-based start line.
text This property is required. str
Text of the current statement/expression.
endColumn This property is required. Number
One-based end column.
endLine This property is required. Number
One-based end line.
procedureId This property is required. String
Name of the active procedure, empty if in a top-level script.
startColumn This property is required. Number
One-based start column.
startLine This property is required. Number
One-based start line.
text This property is required. String
Text of the current statement/expression.

ScriptStatisticsResponse

EvaluationKind This property is required. string
Whether this child job was a statement or expression.
StackFrames This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.ScriptStackFrameResponse>
Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.
EvaluationKind This property is required. string
Whether this child job was a statement or expression.
StackFrames This property is required. []ScriptStackFrameResponse
Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.
evaluationKind This property is required. String
Whether this child job was a statement or expression.
stackFrames This property is required. List<ScriptStackFrameResponse>
Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.
evaluationKind This property is required. string
Whether this child job was a statement or expression.
stackFrames This property is required. ScriptStackFrameResponse[]
Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.
evaluation_kind This property is required. str
Whether this child job was a statement or expression.
stack_frames This property is required. Sequence[ScriptStackFrameResponse]
Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.
evaluationKind This property is required. String
Whether this child job was a statement or expression.
stackFrames This property is required. List<Property Map>
Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.

SearchStatisticsResponse

IndexUnusedReasons This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.IndexUnusedReasonResponse>
When index_usage_mode is UNUSED or PARTIALLY_USED, this field explains why index was not used in all or part of the search query. If index_usage_mode is FULLLY_USED, this field is not populated.
IndexUsageMode This property is required. string
Specifies index usage mode for the query.
IndexUnusedReasons This property is required. []IndexUnusedReasonResponse
When index_usage_mode is UNUSED or PARTIALLY_USED, this field explains why index was not used in all or part of the search query. If index_usage_mode is FULLLY_USED, this field is not populated.
IndexUsageMode This property is required. string
Specifies index usage mode for the query.
indexUnusedReasons This property is required. List<IndexUnusedReasonResponse>
When index_usage_mode is UNUSED or PARTIALLY_USED, this field explains why index was not used in all or part of the search query. If index_usage_mode is FULLLY_USED, this field is not populated.
indexUsageMode This property is required. String
Specifies index usage mode for the query.
indexUnusedReasons This property is required. IndexUnusedReasonResponse[]
When index_usage_mode is UNUSED or PARTIALLY_USED, this field explains why index was not used in all or part of the search query. If index_usage_mode is FULLLY_USED, this field is not populated.
indexUsageMode This property is required. string
Specifies index usage mode for the query.
index_unused_reasons This property is required. Sequence[IndexUnusedReasonResponse]
When index_usage_mode is UNUSED or PARTIALLY_USED, this field explains why index was not used in all or part of the search query. If index_usage_mode is FULLLY_USED, this field is not populated.
index_usage_mode This property is required. str
Specifies index usage mode for the query.
indexUnusedReasons This property is required. List<Property Map>
When index_usage_mode is UNUSED or PARTIALLY_USED, this field explains why index was not used in all or part of the search query. If index_usage_mode is FULLLY_USED, this field is not populated.
indexUsageMode This property is required. String
Specifies index usage mode for the query.

SessionInfoResponse

SessionId This property is required. string
// [Preview] Id of the session.
SessionId This property is required. string
// [Preview] Id of the session.
sessionId This property is required. String
// [Preview] Id of the session.
sessionId This property is required. string
// [Preview] Id of the session.
session_id This property is required. str
// [Preview] Id of the session.
sessionId This property is required. String
// [Preview] Id of the session.

SparkLoggingInfoResponse

Project This property is required. string
Project ID used for logging
ResourceType This property is required. string
Resource type used for logging
Project This property is required. string
Project ID used for logging
ResourceType This property is required. string
Resource type used for logging
project This property is required. String
Project ID used for logging
resourceType This property is required. String
Resource type used for logging
project This property is required. string
Project ID used for logging
resourceType This property is required. string
Resource type used for logging
project This property is required. str
Project ID used for logging
resource_type This property is required. str
Resource type used for logging
project This property is required. String
Project ID used for logging
resourceType This property is required. String
Resource type used for logging

SparkStatisticsResponse

Endpoints This property is required. Dictionary<string, string>
Endpoints generated for the Spark job.
LoggingInfo This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.SparkLoggingInfoResponse
Logging info is used to generate a link to Cloud Logging.
SparkJobId This property is required. string
Spark job id if a Spark job is created successfully.
SparkJobLocation This property is required. string
Location where the Spark job is executed.
Endpoints This property is required. map[string]string
Endpoints generated for the Spark job.
LoggingInfo This property is required. SparkLoggingInfoResponse
Logging info is used to generate a link to Cloud Logging.
SparkJobId This property is required. string
Spark job id if a Spark job is created successfully.
SparkJobLocation This property is required. string
Location where the Spark job is executed.
endpoints This property is required. Map<String,String>
Endpoints generated for the Spark job.
loggingInfo This property is required. SparkLoggingInfoResponse
Logging info is used to generate a link to Cloud Logging.
sparkJobId This property is required. String
Spark job id if a Spark job is created successfully.
sparkJobLocation This property is required. String
Location where the Spark job is executed.
endpoints This property is required. {[key: string]: string}
Endpoints generated for the Spark job.
loggingInfo This property is required. SparkLoggingInfoResponse
Logging info is used to generate a link to Cloud Logging.
sparkJobId This property is required. string
Spark job id if a Spark job is created successfully.
sparkJobLocation This property is required. string
Location where the Spark job is executed.
endpoints This property is required. Mapping[str, str]
Endpoints generated for the Spark job.
logging_info This property is required. SparkLoggingInfoResponse
Logging info is used to generate a link to Cloud Logging.
spark_job_id This property is required. str
Spark job id if a Spark job is created successfully.
spark_job_location This property is required. str
Location where the Spark job is executed.
endpoints This property is required. Map<String>
Endpoints generated for the Spark job.
loggingInfo This property is required. Property Map
Logging info is used to generate a link to Cloud Logging.
sparkJobId This property is required. String
Spark job id if a Spark job is created successfully.
sparkJobLocation This property is required. String
Location where the Spark job is executed.

TableFieldSchemaCategoriesResponse

Names This property is required. List<string>
A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.
Names This property is required. []string
A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.
names This property is required. List<String>
A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.
names This property is required. string[]
A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.
names This property is required. Sequence[str]
A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.
names This property is required. List<String>
A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

TableFieldSchemaPolicyTagsResponse

Names This property is required. List<string>
A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.
Names This property is required. []string
A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.
names This property is required. List<String>
A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.
names This property is required. string[]
A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.
names This property is required. Sequence[str]
A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.
names This property is required. List<String>
A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

TableFieldSchemaRangeElementTypeResponse

Type This property is required. string
The field element type of a RANGE
Type This property is required. string
The field element type of a RANGE
type This property is required. String
The field element type of a RANGE
type This property is required. string
The field element type of a RANGE
type This property is required. str
The field element type of a RANGE
type This property is required. String
The field element type of a RANGE

TableFieldSchemaResponse

Categories This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.TableFieldSchemaCategoriesResponse
[Optional] The categories attached to this field, used for field-level access control.
Collation This property is required. string
Optional. Collation specification of the field. It only can be set on string type field.
DefaultValueExpression This property is required. string
Optional. A SQL expression to specify the default value for this field. It can only be set for top level fields (columns). You can use struct or array expression to specify default value for the entire struct or array. The valid SQL expressions are: - Literals for all data types, including STRUCT and ARRAY. - Following functions: - CURRENT_TIMESTAMP - CURRENT_TIME - CURRENT_DATE - CURRENT_DATETIME - GENERATE_UUID - RAND - SESSION_USER - ST_GEOGPOINT - Struct or array composed with the above allowed functions, for example, [CURRENT_DATE(), DATE '2020-01-01']
Description This property is required. string
[Optional] The field description. The maximum length is 1,024 characters.
Fields This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.TableFieldSchemaResponse>
[Optional] Describes the nested schema fields if the type property is set to RECORD.
MaxLength This property is required. string
[Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES".
Mode This property is required. string
[Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
Name This property is required. string
[Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
PolicyTags This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.TableFieldSchemaPolicyTagsResponse
Precision This property is required. string
[Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid.
RangeElementType This property is required. Pulumi.GoogleNative.BigQuery.V2.Inputs.TableFieldSchemaRangeElementTypeResponse
Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP
RoundingMode This property is required. string
Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields.
Scale This property is required. string
[Optional] See documentation for precision.
Type This property is required. string
[Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
Categories This property is required. TableFieldSchemaCategoriesResponse
[Optional] The categories attached to this field, used for field-level access control.
Collation This property is required. string
Optional. Collation specification of the field. It only can be set on string type field.
DefaultValueExpression This property is required. string
Optional. A SQL expression to specify the default value for this field. It can only be set for top level fields (columns). You can use struct or array expression to specify default value for the entire struct or array. The valid SQL expressions are: - Literals for all data types, including STRUCT and ARRAY. - Following functions: - CURRENT_TIMESTAMP - CURRENT_TIME - CURRENT_DATE - CURRENT_DATETIME - GENERATE_UUID - RAND - SESSION_USER - ST_GEOGPOINT - Struct or array composed with the above allowed functions, for example, [CURRENT_DATE(), DATE '2020-01-01']
Description This property is required. string
[Optional] The field description. The maximum length is 1,024 characters.
Fields This property is required. []TableFieldSchemaResponse
[Optional] Describes the nested schema fields if the type property is set to RECORD.
MaxLength This property is required. string
[Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES".
Mode This property is required. string
[Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
Name This property is required. string
[Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
PolicyTags This property is required. TableFieldSchemaPolicyTagsResponse
Precision This property is required. string
[Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid.
RangeElementType This property is required. TableFieldSchemaRangeElementTypeResponse
Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP
RoundingMode This property is required. string
Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields.
Scale This property is required. string
[Optional] See documentation for precision.
Type This property is required. string
[Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
categories This property is required. TableFieldSchemaCategoriesResponse
[Optional] The categories attached to this field, used for field-level access control.
collation This property is required. String
Optional. Collation specification of the field. It only can be set on string type field.
defaultValueExpression This property is required. String
Optional. A SQL expression to specify the default value for this field. It can only be set for top level fields (columns). You can use struct or array expression to specify default value for the entire struct or array. The valid SQL expressions are: - Literals for all data types, including STRUCT and ARRAY. - Following functions: - CURRENT_TIMESTAMP - CURRENT_TIME - CURRENT_DATE - CURRENT_DATETIME - GENERATE_UUID - RAND - SESSION_USER - ST_GEOGPOINT - Struct or array composed with the above allowed functions, for example, [CURRENT_DATE(), DATE '2020-01-01']
description This property is required. String
[Optional] The field description. The maximum length is 1,024 characters.
fields This property is required. List<TableFieldSchemaResponse>
[Optional] Describes the nested schema fields if the type property is set to RECORD.
maxLength This property is required. String
[Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES".
mode This property is required. String
[Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
name This property is required. String
[Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
policyTags This property is required. TableFieldSchemaPolicyTagsResponse
precision This property is required. String
[Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid.
rangeElementType This property is required. TableFieldSchemaRangeElementTypeResponse
Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP
roundingMode This property is required. String
Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields.
scale This property is required. String
[Optional] See documentation for precision.
type This property is required. String
[Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
categories This property is required. TableFieldSchemaCategoriesResponse
[Optional] The categories attached to this field, used for field-level access control.
collation This property is required. string
Optional. Collation specification of the field. It only can be set on string type field.
defaultValueExpression This property is required. string
Optional. A SQL expression to specify the default value for this field. It can only be set for top level fields (columns). You can use struct or array expression to specify default value for the entire struct or array. The valid SQL expressions are: - Literals for all data types, including STRUCT and ARRAY. - Following functions: - CURRENT_TIMESTAMP - CURRENT_TIME - CURRENT_DATE - CURRENT_DATETIME - GENERATE_UUID - RAND - SESSION_USER - ST_GEOGPOINT - Struct or array composed with the above allowed functions, for example, [CURRENT_DATE(), DATE '2020-01-01']
description This property is required. string
[Optional] The field description. The maximum length is 1,024 characters.
fields This property is required. TableFieldSchemaResponse[]
[Optional] Describes the nested schema fields if the type property is set to RECORD.
maxLength This property is required. string
[Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES".
mode This property is required. string
[Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
name This property is required. string
[Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
policyTags This property is required. TableFieldSchemaPolicyTagsResponse
precision This property is required. string
[Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid.
rangeElementType This property is required. TableFieldSchemaRangeElementTypeResponse
Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP
roundingMode This property is required. string
Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields.
scale This property is required. string
[Optional] See documentation for precision.
type This property is required. string
[Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
categories This property is required. TableFieldSchemaCategoriesResponse
[Optional] The categories attached to this field, used for field-level access control.
collation This property is required. str
Optional. Collation specification of the field. It only can be set on string type field.
default_value_expression This property is required. str
Optional. A SQL expression to specify the default value for this field. It can only be set for top level fields (columns). You can use struct or array expression to specify default value for the entire struct or array. The valid SQL expressions are: - Literals for all data types, including STRUCT and ARRAY. - Following functions: - CURRENT_TIMESTAMP - CURRENT_TIME - CURRENT_DATE - CURRENT_DATETIME - GENERATE_UUID - RAND - SESSION_USER - ST_GEOGPOINT - Struct or array composed with the above allowed functions, for example, [CURRENT_DATE(), DATE '2020-01-01']
description This property is required. str
[Optional] The field description. The maximum length is 1,024 characters.
fields This property is required. Sequence[TableFieldSchemaResponse]
[Optional] Describes the nested schema fields if the type property is set to RECORD.
max_length This property is required. str
[Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES".
mode This property is required. str
[Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
name This property is required. str
[Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
policy_tags This property is required. TableFieldSchemaPolicyTagsResponse
precision This property is required. str
[Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid.
range_element_type This property is required. TableFieldSchemaRangeElementTypeResponse
Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP
rounding_mode This property is required. str
Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields.
scale This property is required. str
[Optional] See documentation for precision.
type This property is required. str
[Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
categories This property is required. Property Map
[Optional] The categories attached to this field, used for field-level access control.
collation This property is required. String
Optional. Collation specification of the field. It only can be set on string type field.
defaultValueExpression This property is required. String
Optional. A SQL expression to specify the default value for this field. It can only be set for top level fields (columns). You can use struct or array expression to specify default value for the entire struct or array. The valid SQL expressions are: - Literals for all data types, including STRUCT and ARRAY. - Following functions: - CURRENT_TIMESTAMP - CURRENT_TIME - CURRENT_DATE - CURRENT_DATETIME - GENERATE_UUID - RAND - SESSION_USER - ST_GEOGPOINT - Struct or array composed with the above allowed functions, for example, [CURRENT_DATE(), DATE '2020-01-01']
description This property is required. String
[Optional] The field description. The maximum length is 1,024 characters.
fields This property is required. List<Property Map>
[Optional] Describes the nested schema fields if the type property is set to RECORD.
maxLength This property is required. String
[Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES".
mode This property is required. String
[Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
name This property is required. String
[Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
policyTags This property is required. Property Map
precision This property is required. String
[Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid.
rangeElementType This property is required. Property Map
Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP
roundingMode This property is required. String
Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields.
scale This property is required. String
[Optional] See documentation for precision.
type This property is required. String
[Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

TableReferenceResponse

DatasetId This property is required. string
[Required] The ID of the dataset containing this table.
Project This property is required. string
[Required] The ID of the project containing this table.
TableId This property is required. string
[Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
DatasetId This property is required. string
[Required] The ID of the dataset containing this table.
Project This property is required. string
[Required] The ID of the project containing this table.
TableId This property is required. string
[Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
datasetId This property is required. String
[Required] The ID of the dataset containing this table.
project This property is required. String
[Required] The ID of the project containing this table.
tableId This property is required. String
[Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
datasetId This property is required. string
[Required] The ID of the dataset containing this table.
project This property is required. string
[Required] The ID of the project containing this table.
tableId This property is required. string
[Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
dataset_id This property is required. str
[Required] The ID of the dataset containing this table.
project This property is required. str
[Required] The ID of the project containing this table.
table_id This property is required. str
[Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
datasetId This property is required. String
[Required] The ID of the dataset containing this table.
project This property is required. String
[Required] The ID of the project containing this table.
tableId This property is required. String
[Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

TableSchemaResponse

Fields This property is required. List<Pulumi.GoogleNative.BigQuery.V2.Inputs.TableFieldSchemaResponse>
Describes the fields in a table.
Fields This property is required. []TableFieldSchemaResponse
Describes the fields in a table.
fields This property is required. List<TableFieldSchemaResponse>
Describes the fields in a table.
fields This property is required. TableFieldSchemaResponse[]
Describes the fields in a table.
fields This property is required. Sequence[TableFieldSchemaResponse]
Describes the fields in a table.
fields This property is required. List<Property Map>
Describes the fields in a table.

TimePartitioningResponse

ExpirationMs This property is required. string
[Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
Field This property is required. string
[Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
RequirePartitionFilter This property is required. bool
Type This property is required. string
[Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
ExpirationMs This property is required. string
[Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
Field This property is required. string
[Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
RequirePartitionFilter This property is required. bool
Type This property is required. string
[Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
expirationMs This property is required. String
[Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
field This property is required. String
[Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
requirePartitionFilter This property is required. Boolean
type This property is required. String
[Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
expirationMs This property is required. string
[Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
field This property is required. string
[Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
requirePartitionFilter This property is required. boolean
type This property is required. string
[Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
expiration_ms This property is required. str
[Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
field This property is required. str
[Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
require_partition_filter This property is required. bool
type This property is required. str
[Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
expirationMs This property is required. String
[Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
field This property is required. String
[Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
requirePartitionFilter This property is required. Boolean
type This property is required. String
[Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.

TransactionInfoResponse

TransactionId This property is required. string
// [Alpha] Id of the transaction.
TransactionId This property is required. string
// [Alpha] Id of the transaction.
transactionId This property is required. String
// [Alpha] Id of the transaction.
transactionId This property is required. string
// [Alpha] Id of the transaction.
transaction_id This property is required. str
// [Alpha] Id of the transaction.
transactionId This property is required. String
// [Alpha] Id of the transaction.

UserDefinedFunctionResourceResponse

InlineCode This property is required. string
[Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
ResourceUri This property is required. string
[Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
InlineCode This property is required. string
[Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
ResourceUri This property is required. string
[Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
inlineCode This property is required. String
[Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
resourceUri This property is required. String
[Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
inlineCode This property is required. string
[Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
resourceUri This property is required. string
[Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
inline_code This property is required. str
[Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
resource_uri This property is required. str
[Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
inlineCode This property is required. String
[Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
resourceUri This property is required. String
[Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi