Google Native

v0.27.0 published on Friday, Oct 21, 2022 by Pulumi

getJob

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>
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]
func LookupJob(ctx *Context, args *LookupJobArgs, opts ...InvokeOption) (*LookupJobResult, error)
func LookupJobOutput(ctx *Context, args *LookupJobOutputArgs, opts ...InvokeOption) LookupJobResultOutput

> 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)
}
public static CompletableFuture<GetJobResult> getJob(GetJobArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: google-native:bigquery/v2:getJob
  arguments:
    # arguments dictionary

The following arguments are supported:

JobId string
Location string
Project string
JobId string
Location string
Project string
jobId String
location String
project String
jobId string
location string
project string
jobId 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.

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.

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.

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.

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_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.

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 string

High-level BI Engine reason for partial or disabled acceleration.

Message string

Free form human-readable reason for partial or disabled acceleration.

Code string

High-level BI Engine reason for partial or disabled acceleration.

Message string

Free form human-readable reason for partial or disabled acceleration.

code String

High-level BI Engine reason for partial or disabled acceleration.

message String

Free form human-readable reason for partial or disabled acceleration.

code string

High-level BI Engine reason for partial or disabled acceleration.

message string

Free form human-readable reason for partial or disabled acceleration.

code str

High-level BI Engine reason for partial or disabled acceleration.

message str

Free form human-readable reason for partial or disabled acceleration.

code String

High-level BI Engine reason for partial or disabled acceleration.

message String

Free form human-readable reason for partial or disabled acceleration.

BiEngineStatisticsResponse

BiEngineMode string

Specifies which mode of BI Engine acceleration was performed (if any).

BiEngineReasons 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.

BiEngineMode string

Specifies which mode of BI Engine acceleration was performed (if any).

BiEngineReasons []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.

biEngineMode String

Specifies which mode of BI Engine acceleration was performed (if any).

biEngineReasons 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.

biEngineMode string

Specifies which mode of BI Engine acceleration was performed (if any).

biEngineReasons 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.

bi_engine_mode str

Specifies which mode of BI Engine acceleration was performed (if any).

bi_engine_reasons 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.

biEngineMode String

Specifies which mode of BI Engine acceleration was performed (if any).

biEngineReasons 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 int

[Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.

ExpectedTotalIterations 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 int

[Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.

ExpectedTotalIterations 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 Integer

[Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.

expectedTotalIterations 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 number

[Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.

expectedTotalIterations 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 int

[Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.

expected_total_iterations 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 Number

[Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.

expectedTotalIterations 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 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 []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 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 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 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 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 string

[Required] Name of the connection property to set.

Value string

[Required] Value of the connection property.

Key string

[Required] Name of the connection property to set.

Value string

[Required] Value of the connection property.

key String

[Required] Name of the connection property to set.

value String

[Required] Value of the connection property.

key string

[Required] Name of the connection property to set.

value string

[Required] Value of the connection property.

key str

[Required] Name of the connection property to set.

value str

[Required] Value of the connection property.

key String

[Required] Name of the connection property to set.

value String

[Required] Value of the connection property.

DataMaskingStatisticsResponse

DataMaskingApplied 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 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 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 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 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 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 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 string

[Optional] The ID of the project containing this dataset.

DatasetId 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 string

[Optional] The ID of the project containing this dataset.

datasetId 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 String

[Optional] The ID of the project containing this dataset.

datasetId 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 string

[Optional] The ID of the project containing this dataset.

dataset_id 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 str

[Optional] The ID of the project containing this dataset.

datasetId 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 String

[Optional] The ID of the project containing this dataset.

DestinationTablePropertiesResponse

Description 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 string

[Internal] This field is for Google internal use only.

FriendlyName 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 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 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 string

[Internal] This field is for Google internal use only.

FriendlyName 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 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 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 String

[Internal] This field is for Google internal use only.

friendlyName 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 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 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 string

[Internal] This field is for Google internal use only.

friendlyName 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 {[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 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 str

[Internal] This field is for Google internal use only.

friendly_name 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 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 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 String

[Internal] This field is for Google internal use only.

friendlyName 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 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 string

Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.

InsertedRowCount string

Number of inserted Rows. Populated by DML INSERT and MERGE statements.

UpdatedRowCount string

Number of updated Rows. Populated by DML UPDATE and MERGE statements.

DeletedRowCount string

Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.

InsertedRowCount string

Number of inserted Rows. Populated by DML INSERT and MERGE statements.

UpdatedRowCount string

Number of updated Rows. Populated by DML UPDATE and MERGE statements.

deletedRowCount String

Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.

insertedRowCount String

Number of inserted Rows. Populated by DML INSERT and MERGE statements.

updatedRowCount String

Number of updated Rows. Populated by DML UPDATE and MERGE statements.

deletedRowCount string

Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.

insertedRowCount string

Number of inserted Rows. Populated by DML INSERT and MERGE statements.

updatedRowCount string

Number of updated Rows. Populated by DML UPDATE and MERGE statements.

deleted_row_count str

Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.

inserted_row_count str

Number of inserted Rows. Populated by DML INSERT and MERGE statements.

updated_row_count str

Number of updated Rows. Populated by DML UPDATE and MERGE statements.

deletedRowCount String

Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.

insertedRowCount String

Number of inserted Rows. Populated by DML INSERT and MERGE statements.

updatedRowCount String

Number of updated Rows. Populated by DML UPDATE and MERGE statements.

EncryptionConfigurationResponse

KmsKeyName 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 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 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 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 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 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 string

Debugging information. This property is internal to Google and should not be used.

Location string

Specifies where the error occurred, if present.

Message string

A human-readable description of the error.

Reason string

A short error code that summarizes the error.

DebugInfo string

Debugging information. This property is internal to Google and should not be used.

Location string

Specifies where the error occurred, if present.

Message string

A human-readable description of the error.

Reason string

A short error code that summarizes the error.

debugInfo String

Debugging information. This property is internal to Google and should not be used.

location String

Specifies where the error occurred, if present.

message String

A human-readable description of the error.

reason String

A short error code that summarizes the error.

debugInfo string

Debugging information. This property is internal to Google and should not be used.

location string

Specifies where the error occurred, if present.

message string

A human-readable description of the error.

reason string

A short error code that summarizes the error.

debug_info str

Debugging information. This property is internal to Google and should not be used.

location str

Specifies where the error occurred, if present.

message str

A human-readable description of the error.

reason str

A short error code that summarizes the error.

debugInfo String

Debugging information. This property is internal to Google and should not be used.

location String

Specifies where the error occurred, if present.

message String

A human-readable description of the error.

reason String

A short error code that summarizes the error.

ExplainQueryStageResponse

CompletedParallelInputs string

Number of parallel input segments completed.

ComputeMsAvg string

Milliseconds the average shard spent on CPU-bound tasks.

ComputeMsMax string

Milliseconds the slowest shard spent on CPU-bound tasks.

ComputeRatioAvg double

Relative amount of time the average shard spent on CPU-bound tasks.

ComputeRatioMax double

Relative amount of time the slowest shard spent on CPU-bound tasks.

EndMs string

Stage end time represented as milliseconds since epoch.

InputStages List<string>

IDs for stages that are inputs to this stage.

Name string

Human-readable name for stage.

ParallelInputs string

Number of parallel input segments to be processed.

ReadMsAvg string

Milliseconds the average shard spent reading input.

ReadMsMax string

Milliseconds the slowest shard spent reading input.

ReadRatioAvg double

Relative amount of time the average shard spent reading input.

ReadRatioMax double

Relative amount of time the slowest shard spent reading input.

RecordsRead string

Number of records read into the stage.

RecordsWritten string

Number of records written by the stage.

ShuffleOutputBytes string

Total number of bytes written to shuffle.

ShuffleOutputBytesSpilled string

Total number of bytes written to shuffle and spilled to disk.

SlotMs string

Slot-milliseconds used by the stage.

StartMs string

Stage start time represented as milliseconds since epoch.

Status string

Current status for the stage.

Steps List<Pulumi.GoogleNative.BigQuery.V2.Inputs.ExplainQueryStepResponse>

List of operations within the stage in dependency order (approximately chronological).

WaitMsAvg string

Milliseconds the average shard spent waiting to be scheduled.

WaitMsMax string

Milliseconds the slowest shard spent waiting to be scheduled.

WaitRatioAvg double

Relative amount of time the average shard spent waiting to be scheduled.

WaitRatioMax double

Relative amount of time the slowest shard spent waiting to be scheduled.

WriteMsAvg string

Milliseconds the average shard spent on writing output.

WriteMsMax string

Milliseconds the slowest shard spent on writing output.

WriteRatioAvg double

Relative amount of time the average shard spent on writing output.

WriteRatioMax double

Relative amount of time the slowest shard spent on writing output.

CompletedParallelInputs string

Number of parallel input segments completed.

ComputeMsAvg string

Milliseconds the average shard spent on CPU-bound tasks.

ComputeMsMax string

Milliseconds the slowest shard spent on CPU-bound tasks.

ComputeRatioAvg float64

Relative amount of time the average shard spent on CPU-bound tasks.

ComputeRatioMax float64

Relative amount of time the slowest shard spent on CPU-bound tasks.

EndMs string

Stage end time represented as milliseconds since epoch.

InputStages []string

IDs for stages that are inputs to this stage.

Name string

Human-readable name for stage.

ParallelInputs string

Number of parallel input segments to be processed.

ReadMsAvg string

Milliseconds the average shard spent reading input.

ReadMsMax string

Milliseconds the slowest shard spent reading input.

ReadRatioAvg float64

Relative amount of time the average shard spent reading input.

ReadRatioMax float64

Relative amount of time the slowest shard spent reading input.

RecordsRead string

Number of records read into the stage.

RecordsWritten string

Number of records written by the stage.

ShuffleOutputBytes string

Total number of bytes written to shuffle.

ShuffleOutputBytesSpilled string

Total number of bytes written to shuffle and spilled to disk.

SlotMs string

Slot-milliseconds used by the stage.

StartMs string

Stage start time represented as milliseconds since epoch.

Status string

Current status for the stage.

Steps []ExplainQueryStepResponse

List of operations within the stage in dependency order (approximately chronological).

WaitMsAvg string

Milliseconds the average shard spent waiting to be scheduled.

WaitMsMax string

Milliseconds the slowest shard spent waiting to be scheduled.

WaitRatioAvg float64

Relative amount of time the average shard spent waiting to be scheduled.

WaitRatioMax float64

Relative amount of time the slowest shard spent waiting to be scheduled.

WriteMsAvg string

Milliseconds the average shard spent on writing output.

WriteMsMax string

Milliseconds the slowest shard spent on writing output.

WriteRatioAvg float64

Relative amount of time the average shard spent on writing output.

WriteRatioMax float64

Relative amount of time the slowest shard spent on writing output.

completedParallelInputs String

Number of parallel input segments completed.

computeMsAvg String

Milliseconds the average shard spent on CPU-bound tasks.

computeMsMax String

Milliseconds the slowest shard spent on CPU-bound tasks.

computeRatioAvg Double

Relative amount of time the average shard spent on CPU-bound tasks.

computeRatioMax Double

Relative amount of time the slowest shard spent on CPU-bound tasks.

endMs String

Stage end time represented as milliseconds since epoch.

inputStages List<String>

IDs for stages that are inputs to this stage.

name String

Human-readable name for stage.

parallelInputs String

Number of parallel input segments to be processed.

readMsAvg String

Milliseconds the average shard spent reading input.

readMsMax String

Milliseconds the slowest shard spent reading input.

readRatioAvg Double

Relative amount of time the average shard spent reading input.

readRatioMax Double

Relative amount of time the slowest shard spent reading input.

recordsRead String

Number of records read into the stage.

recordsWritten String

Number of records written by the stage.

shuffleOutputBytes String

Total number of bytes written to shuffle.

shuffleOutputBytesSpilled String

Total number of bytes written to shuffle and spilled to disk.

slotMs String

Slot-milliseconds used by the stage.

startMs String

Stage start time represented as milliseconds since epoch.

status String

Current status for the stage.

steps List<ExplainQueryStepResponse>

List of operations within the stage in dependency order (approximately chronological).

waitMsAvg String

Milliseconds the average shard spent waiting to be scheduled.

waitMsMax String

Milliseconds the slowest shard spent waiting to be scheduled.

waitRatioAvg Double

Relative amount of time the average shard spent waiting to be scheduled.

waitRatioMax Double

Relative amount of time the slowest shard spent waiting to be scheduled.

writeMsAvg String

Milliseconds the average shard spent on writing output.

writeMsMax String

Milliseconds the slowest shard spent on writing output.

writeRatioAvg Double

Relative amount of time the average shard spent on writing output.

writeRatioMax Double

Relative amount of time the slowest shard spent on writing output.

completedParallelInputs string

Number of parallel input segments completed.

computeMsAvg string

Milliseconds the average shard spent on CPU-bound tasks.

computeMsMax string

Milliseconds the slowest shard spent on CPU-bound tasks.

computeRatioAvg number

Relative amount of time the average shard spent on CPU-bound tasks.

computeRatioMax number

Relative amount of time the slowest shard spent on CPU-bound tasks.

endMs string

Stage end time represented as milliseconds since epoch.

inputStages string[]

IDs for stages that are inputs to this stage.

name string

Human-readable name for stage.

parallelInputs string

Number of parallel input segments to be processed.

readMsAvg string

Milliseconds the average shard spent reading input.

readMsMax string

Milliseconds the slowest shard spent reading input.

readRatioAvg number

Relative amount of time the average shard spent reading input.

readRatioMax number

Relative amount of time the slowest shard spent reading input.

recordsRead string

Number of records read into the stage.

recordsWritten string

Number of records written by the stage.

shuffleOutputBytes string

Total number of bytes written to shuffle.

shuffleOutputBytesSpilled string

Total number of bytes written to shuffle and spilled to disk.

slotMs string

Slot-milliseconds used by the stage.

startMs string

Stage start time represented as milliseconds since epoch.

status string

Current status for the stage.

steps ExplainQueryStepResponse[]

List of operations within the stage in dependency order (approximately chronological).

waitMsAvg string

Milliseconds the average shard spent waiting to be scheduled.

waitMsMax string

Milliseconds the slowest shard spent waiting to be scheduled.

waitRatioAvg number

Relative amount of time the average shard spent waiting to be scheduled.

waitRatioMax number

Relative amount of time the slowest shard spent waiting to be scheduled.

writeMsAvg string

Milliseconds the average shard spent on writing output.

writeMsMax string

Milliseconds the slowest shard spent on writing output.

writeRatioAvg number

Relative amount of time the average shard spent on writing output.

writeRatioMax number

Relative amount of time the slowest shard spent on writing output.

completed_parallel_inputs str

Number of parallel input segments completed.

compute_ms_avg str

Milliseconds the average shard spent on CPU-bound tasks.

compute_ms_max str

Milliseconds the slowest shard spent on CPU-bound tasks.

compute_ratio_avg float

Relative amount of time the average shard spent on CPU-bound tasks.

compute_ratio_max float

Relative amount of time the slowest shard spent on CPU-bound tasks.

end_ms str

Stage end time represented as milliseconds since epoch.

input_stages Sequence[str]

IDs for stages that are inputs to this stage.

name str

Human-readable name for stage.

parallel_inputs str

Number of parallel input segments to be processed.

read_ms_avg str

Milliseconds the average shard spent reading input.

read_ms_max str

Milliseconds the slowest shard spent reading input.

read_ratio_avg float

Relative amount of time the average shard spent reading input.

read_ratio_max float

Relative amount of time the slowest shard spent reading input.

records_read str

Number of records read into the stage.

records_written str

Number of records written by the stage.

shuffle_output_bytes str

Total number of bytes written to shuffle.

shuffle_output_bytes_spilled str

Total number of bytes written to shuffle and spilled to disk.

slot_ms str

Slot-milliseconds used by the stage.

start_ms str

Stage start time represented as milliseconds since epoch.

status str

Current status for the stage.

steps Sequence[ExplainQueryStepResponse]

List of operations within the stage in dependency order (approximately chronological).

wait_ms_avg str

Milliseconds the average shard spent waiting to be scheduled.

wait_ms_max str

Milliseconds the slowest shard spent waiting to be scheduled.

wait_ratio_avg float

Relative amount of time the average shard spent waiting to be scheduled.

wait_ratio_max float

Relative amount of time the slowest shard spent waiting to be scheduled.

write_ms_avg str

Milliseconds the average shard spent on writing output.

write_ms_max str

Milliseconds the slowest shard spent on writing output.

write_ratio_avg float

Relative amount of time the average shard spent on writing output.

write_ratio_max float

Relative amount of time the slowest shard spent on writing output.

completedParallelInputs String

Number of parallel input segments completed.

computeMsAvg String

Milliseconds the average shard spent on CPU-bound tasks.

computeMsMax String

Milliseconds the slowest shard spent on CPU-bound tasks.

computeRatioAvg Number

Relative amount of time the average shard spent on CPU-bound tasks.

computeRatioMax Number

Relative amount of time the slowest shard spent on CPU-bound tasks.

endMs String

Stage end time represented as milliseconds since epoch.

inputStages List<String>

IDs for stages that are inputs to this stage.

name String

Human-readable name for stage.

parallelInputs String

Number of parallel input segments to be processed.

readMsAvg String

Milliseconds the average shard spent reading input.

readMsMax String

Milliseconds the slowest shard spent reading input.

readRatioAvg Number

Relative amount of time the average shard spent reading input.

readRatioMax Number

Relative amount of time the slowest shard spent reading input.

recordsRead String

Number of records read into the stage.

recordsWritten String

Number of records written by the stage.

shuffleOutputBytes String

Total number of bytes written to shuffle.

shuffleOutputBytesSpilled String

Total number of bytes written to shuffle and spilled to disk.

slotMs String

Slot-milliseconds used by the stage.

startMs String

Stage start time represented as milliseconds since epoch.

status String

Current status for the stage.

steps List<Property Map>

List of operations within the stage in dependency order (approximately chronological).

waitMsAvg String

Milliseconds the average shard spent waiting to be scheduled.

waitMsMax String

Milliseconds the slowest shard spent waiting to be scheduled.

waitRatioAvg Number

Relative amount of time the average shard spent waiting to be scheduled.

waitRatioMax Number

Relative amount of time the slowest shard spent waiting to be scheduled.

writeMsAvg String

Milliseconds the average shard spent on writing output.

writeMsMax String

Milliseconds the slowest shard spent on writing output.

writeRatioAvg Number

Relative amount of time the average shard spent on writing output.

writeRatioMax Number

Relative amount of time the slowest shard spent on writing output.

ExplainQueryStepResponse

Kind string

Machine-readable operation type.

Substeps List<string>

Human-readable stage descriptions.

Kind string

Machine-readable operation type.

Substeps []string

Human-readable stage descriptions.

kind String

Machine-readable operation type.

substeps List<String>

Human-readable stage descriptions.

kind string

Machine-readable operation type.

substeps string[]

Human-readable stage descriptions.

kind str

Machine-readable operation type.

substeps Sequence[str]

Human-readable stage descriptions.

kind String

Machine-readable operation type.

substeps List<String>

Human-readable stage descriptions.

HivePartitioningOptionsResponse

Mode 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 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 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).

Mode 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 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 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).

mode 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 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 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).

mode 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 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 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).

mode 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 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 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).

mode 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 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 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 Pulumi.GoogleNative.BigQuery.V2.Inputs.TableReferenceResponse

Specifies the base table involved in the reason that no search index was used.

Code string

Specifies the high-level reason for the scenario when no search index was used.

IndexName string

Specifies the name of the unused search index, if available.

Message string

Free form human-readable reason for the scenario when no search index was used.

BaseTable TableReferenceResponse

Specifies the base table involved in the reason that no search index was used.

Code string

Specifies the high-level reason for the scenario when no search index was used.

IndexName string

Specifies the name of the unused search index, if available.

Message string

Free form human-readable reason for the scenario when no search index was used.

baseTable TableReferenceResponse

Specifies the base table involved in the reason that no search index was used.

code String

Specifies the high-level reason for the scenario when no search index was used.

indexName String

Specifies the name of the unused search index, if available.

message String

Free form human-readable reason for the scenario when no search index was used.

baseTable TableReferenceResponse

Specifies the base table involved in the reason that no search index was used.

code string

Specifies the high-level reason for the scenario when no search index was used.

indexName string

Specifies the name of the unused search index, if available.

message string

Free form human-readable reason for the scenario when no search index was used.

base_table TableReferenceResponse

Specifies the base table involved in the reason that no search index was used.

code str

Specifies the high-level reason for the scenario when no search index was used.

index_name str

Specifies the name of the unused search index, if available.

message str

Free form human-readable reason for the scenario when no search index was used.

baseTable Property Map

Specifies the base table involved in the reason that no search index was used.

code String

Specifies the high-level reason for the scenario when no search index was used.

indexName String

Specifies the name of the unused search index, if available.

message String

Free form human-readable reason for the scenario when no search index was used.

IterationResultResponse

DurationMs string

Time taken to run the iteration in milliseconds.

EvalLoss double

Loss computed on the eval data at the end of iteration.

Index int

Index of the iteration, 0 based.

LearnRate double

Learn rate used for this iteration.

TrainingLoss double

Loss computed on the training data at the end of iteration.

DurationMs string

Time taken to run the iteration in milliseconds.

EvalLoss float64

Loss computed on the eval data at the end of iteration.

Index int

Index of the iteration, 0 based.

LearnRate float64

Learn rate used for this iteration.

TrainingLoss float64

Loss computed on the training data at the end of iteration.

durationMs String

Time taken to run the iteration in milliseconds.

evalLoss Double

Loss computed on the eval data at the end of iteration.

index Integer

Index of the iteration, 0 based.

learnRate Double

Learn rate used for this iteration.

trainingLoss Double

Loss computed on the training data at the end of iteration.

durationMs string

Time taken to run the iteration in milliseconds.

evalLoss number

Loss computed on the eval data at the end of iteration.

index number

Index of the iteration, 0 based.

learnRate number

Learn rate used for this iteration.

trainingLoss number

Loss computed on the training data at the end of iteration.

duration_ms str

Time taken to run the iteration in milliseconds.

eval_loss float

Loss computed on the eval data at the end of iteration.

index int

Index of the iteration, 0 based.

learn_rate float

Learn rate used for this iteration.

training_loss float

Loss computed on the training data at the end of iteration.

durationMs String

Time taken to run the iteration in milliseconds.

evalLoss Number

Loss computed on the eval data at the end of iteration.

index Number

Index of the iteration, 0 based.

learnRate Number

Learn rate used for this iteration.

trainingLoss Number

Loss computed on the training data at the end of iteration.

JobConfigurationExtractResponse

Compression 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 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 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 List<string>

[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.

FieldDelimiter string

[Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.

PrintHeader bool

[Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.

SourceModel Pulumi.GoogleNative.BigQuery.V2.Inputs.ModelReferenceResponse

A reference to the model being exported.

SourceTable Pulumi.GoogleNative.BigQuery.V2.Inputs.TableReferenceResponse

A reference to the table being exported.

UseAvroLogicalTypes 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 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 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 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 []string

[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.

FieldDelimiter string

[Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.

PrintHeader bool

[Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.

SourceModel ModelReferenceResponse

A reference to the model being exported.

SourceTable TableReferenceResponse

A reference to the table being exported.

UseAvroLogicalTypes 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 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 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 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 List<String>

[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.

fieldDelimiter String

[Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.

printHeader Boolean

[Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.

sourceModel ModelReferenceResponse

A reference to the model being exported.

sourceTable TableReferenceResponse

A reference to the table being exported.

useAvroLogicalTypes 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 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 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 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 string[]

[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.

fieldDelimiter string

[Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.

printHeader boolean

[Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.

sourceModel ModelReferenceResponse

A reference to the model being exported.

sourceTable TableReferenceResponse

A reference to the table being exported.

useAvroLogicalTypes 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 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 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 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 Sequence[str]

[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.

field_delimiter str

[Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.

print_header bool

[Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.

source_model ModelReferenceResponse

A reference to the model being exported.

source_table TableReferenceResponse

A reference to the table being exported.

use_avro_logical_types 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 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 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 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 List<String>

[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.

fieldDelimiter String

[Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.

printHeader Boolean

[Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.

sourceModel Property Map

A reference to the model being exported.

sourceTable Property Map

A reference to the table being exported.

useAvroLogicalTypes 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 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 bool

Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

Autodetect bool

[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.

Clustering 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 List<Pulumi.GoogleNative.BigQuery.V2.Inputs.ConnectionPropertyResponse>

Connection properties.

CreateDisposition 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 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 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 Pulumi.GoogleNative.BigQuery.V2.Inputs.EncryptionConfigurationResponse

Custom encryption configuration (e.g., Cloud KMS keys).

DestinationTable Pulumi.GoogleNative.BigQuery.V2.Inputs.TableReferenceResponse

[Required] The destination table to load the data into.

DestinationTableProperties Pulumi.GoogleNative.BigQuery.V2.Inputs.DestinationTablePropertiesResponse

[Beta] [Optional] Properties with which to create the destination table if it is new.

Encoding 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 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 (',').

HivePartitioningOptions Pulumi.GoogleNative.BigQuery.V2.Inputs.HivePartitioningOptionsResponse

[Optional] Options to configure hive partitioning support.

IgnoreUnknownValues 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 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 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 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 Pulumi.GoogleNative.BigQuery.V2.Inputs.ParquetOptionsResponse

[Optional] Options to configure parquet support.

PreserveAsciiControlCharacters 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 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 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 Pulumi.GoogleNative.BigQuery.V2.Inputs.RangePartitioningResponse

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

ReferenceFileSchemaUri string

User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.

Schema 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 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 string

[Deprecated] The format of the schemaInline property.

Deprecated:

[Deprecated] The format of the schemaInline property.

SchemaUpdateOptions 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 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 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 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 Pulumi.GoogleNative.BigQuery.V2.Inputs.TimePartitioningResponse

Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

UseAvroLogicalTypes 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 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 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 bool

Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

Autodetect bool

[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.

Clustering 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 []ConnectionPropertyResponse

Connection properties.

CreateDisposition 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 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 []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 EncryptionConfigurationResponse

Custom encryption configuration (e.g., Cloud KMS keys).

DestinationTable TableReferenceResponse

[Required] The destination table to load the data into.

DestinationTableProperties DestinationTablePropertiesResponse

[Beta] [Optional] Properties with which to create the destination table if it is new.

Encoding 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 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 (',').

HivePartitioningOptions HivePartitioningOptionsResponse

[Optional] Options to configure hive partitioning support.

IgnoreUnknownValues 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 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 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 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 ParquetOptionsResponse

[Optional] Options to configure parquet support.

PreserveAsciiControlCharacters 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 []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 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 RangePartitioningResponse

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

ReferenceFileSchemaUri string

User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.

Schema 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 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 string

[Deprecated] The format of the schemaInline property.

Deprecated:

[Deprecated] The format of the schemaInline property.

SchemaUpdateOptions []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 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 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 []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 TimePartitioningResponse

Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

UseAvroLogicalTypes 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 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 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 Boolean

Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

autodetect Boolean

[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.

clustering 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 List<ConnectionPropertyResponse>

Connection properties.

createDisposition 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 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 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 EncryptionConfigurationResponse

Custom encryption configuration (e.g., Cloud KMS keys).

destinationTable TableReferenceResponse

[Required] The destination table to load the data into.

destinationTableProperties DestinationTablePropertiesResponse

[Beta] [Optional] Properties with which to create the destination table if it is new.

encoding 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 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 (',').

hivePartitioningOptions HivePartitioningOptionsResponse

[Optional] Options to configure hive partitioning support.

ignoreUnknownValues 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 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 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 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 ParquetOptionsResponse

[Optional] Options to configure parquet support.

preserveAsciiControlCharacters 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 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 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 RangePartitioningResponse

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

referenceFileSchemaUri String

User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.

schema 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 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 String

[Deprecated] The format of the schemaInline property.

Deprecated:

[Deprecated] The format of the schemaInline property.

schemaUpdateOptions 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 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 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 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 TimePartitioningResponse

Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

useAvroLogicalTypes 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 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 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 boolean

Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

autodetect boolean

[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.

clustering 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 ConnectionPropertyResponse[]

Connection properties.

createDisposition 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 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 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 EncryptionConfigurationResponse

Custom encryption configuration (e.g., Cloud KMS keys).

destinationTable TableReferenceResponse

[Required] The destination table to load the data into.

destinationTableProperties DestinationTablePropertiesResponse

[Beta] [Optional] Properties with which to create the destination table if it is new.

encoding 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 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 (',').

hivePartitioningOptions HivePartitioningOptionsResponse

[Optional] Options to configure hive partitioning support.

ignoreUnknownValues 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 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 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 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 ParquetOptionsResponse

[Optional] Options to configure parquet support.

preserveAsciiControlCharacters 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 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 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 RangePartitioningResponse

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

referenceFileSchemaUri string

User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.

schema 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 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 string

[Deprecated] The format of the schemaInline property.

Deprecated:

[Deprecated] The format of the schemaInline property.

schemaUpdateOptions 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 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 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 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 TimePartitioningResponse

Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

useAvroLogicalTypes 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 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 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 bool

Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

autodetect bool

[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.

clustering 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 Sequence[ConnectionPropertyResponse]

Connection properties.

create_disposition 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 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 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 EncryptionConfigurationResponse

Custom encryption configuration (e.g., Cloud KMS keys).

destination_table TableReferenceResponse

[Required] The destination table to load the data into.

destination_table_properties DestinationTablePropertiesResponse

[Beta] [Optional] Properties with which to create the destination table if it is new.

encoding 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 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 (',').

hive_partitioning_options HivePartitioningOptionsResponse

[Optional] Options to configure hive partitioning support.

ignore_unknown_values 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 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 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 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 ParquetOptionsResponse

[Optional] Options to configure parquet support.

preserve_ascii_control_characters 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 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 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 RangePartitioningResponse

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

reference_file_schema_uri str

User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.

schema 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 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 str

[Deprecated] The format of the schemaInline property.

Deprecated:

[Deprecated] The format of the schemaInline property.

schema_update_options 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 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 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 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 TimePartitioningResponse

Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

use_avro_logical_types 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 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 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 Boolean

Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

autodetect Boolean

[Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.

clustering 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 List<Property Map>

Connection properties.

createDisposition 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 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 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 Property Map

Custom encryption configuration (e.g., Cloud KMS keys).

destinationTable Property Map

[Required] The destination table to load the data into.

destinationTableProperties Property Map

[Beta] [Optional] Properties with which to create the destination table if it is new.

encoding 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 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 (',').

hivePartitioningOptions Property Map

[Optional] Options to configure hive partitioning support.

ignoreUnknownValues 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 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 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 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 Property Map

[Optional] Options to configure parquet support.

preserveAsciiControlCharacters 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 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 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 Property Map

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

referenceFileSchemaUri String

User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.

schema 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 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 String

[Deprecated] The format of the schemaInline property.

Deprecated:

[Deprecated] The format of the schemaInline property.

schemaUpdateOptions 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 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 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 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 Property Map

Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

useAvroLogicalTypes 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 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 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 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 List<Pulumi.GoogleNative.BigQuery.V2.Inputs.ConnectionPropertyResponse>

Connection properties.

CreateDisposition 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 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 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 Pulumi.GoogleNative.BigQuery.V2.Inputs.EncryptionConfigurationResponse

Custom encryption configuration (e.g., Cloud KMS keys).

DestinationTable 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 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 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 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 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 bool

[Deprecated] This property is deprecated.

Deprecated:

[Deprecated] This property is deprecated.

Priority string

[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.

Query 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 List<Pulumi.GoogleNative.BigQuery.V2.Inputs.QueryParameterResponse>

Query parameters for standard SQL queries.

RangePartitioning Pulumi.GoogleNative.BigQuery.V2.Inputs.RangePartitioningResponse

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

SchemaUpdateOptions 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 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 Pulumi.GoogleNative.BigQuery.V2.Inputs.TimePartitioningResponse

Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

UseLegacySql 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 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 List<Pulumi.GoogleNative.BigQuery.V2.Inputs.UserDefinedFunctionResourceResponse>

Describes user-defined function resources used in the query.

WriteDisposition 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 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 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 []ConnectionPropertyResponse

Connection properties.

CreateDisposition 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 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 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 EncryptionConfigurationResponse

Custom encryption configuration (e.g., Cloud KMS keys).

DestinationTable 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 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 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 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 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 bool

[Deprecated] This property is deprecated.

Deprecated:

[Deprecated] This property is deprecated.

Priority string

[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.

Query 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 []QueryParameterResponse

Query parameters for standard SQL queries.

RangePartitioning RangePartitioningResponse

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

SchemaUpdateOptions []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 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 TimePartitioningResponse

Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

UseLegacySql 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 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 []UserDefinedFunctionResourceResponse

Describes user-defined function resources used in the query.

WriteDisposition 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 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 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 List<ConnectionPropertyResponse>

Connection properties.

createDisposition 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 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 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 EncryptionConfigurationResponse

Custom encryption configuration (e.g., Cloud KMS keys).

destinationTable 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 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 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 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 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 Boolean

[Deprecated] This property is deprecated.

Deprecated:

[Deprecated] This property is deprecated.

priority String

[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.

query 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 List<QueryParameterResponse>

Query parameters for standard SQL queries.

rangePartitioning RangePartitioningResponse

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

schemaUpdateOptions 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 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 TimePartitioningResponse

Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

useLegacySql 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 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 List<UserDefinedFunctionResourceResponse>

Describes user-defined function resources used in the query.

writeDisposition 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 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 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 ConnectionPropertyResponse[]

Connection properties.

createDisposition 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 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 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 EncryptionConfigurationResponse

Custom encryption configuration (e.g., Cloud KMS keys).

destinationTable 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 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 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 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 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 boolean

[Deprecated] This property is deprecated.

Deprecated:

[Deprecated] This property is deprecated.

priority string

[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.

query 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 QueryParameterResponse[]

Query parameters for standard SQL queries.

rangePartitioning RangePartitioningResponse

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

schemaUpdateOptions 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 {[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 TimePartitioningResponse

Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

useLegacySql 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 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 UserDefinedFunctionResourceResponse[]

Describes user-defined function resources used in the query.

writeDisposition 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 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 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 Sequence[ConnectionPropertyResponse]

Connection properties.

create_disposition 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 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 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 EncryptionConfigurationResponse

Custom encryption configuration (e.g., Cloud KMS keys).

destination_table 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 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 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 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 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 bool

[Deprecated] This property is deprecated.

Deprecated:

[Deprecated] This property is deprecated.

priority str

[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.

query 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 Sequence[QueryParameterResponse]

Query parameters for standard SQL queries.

range_partitioning RangePartitioningResponse

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

schema_update_options 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 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 TimePartitioningResponse

Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

use_legacy_sql 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 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 Sequence[UserDefinedFunctionResourceResponse]

Describes user-defined function resources used in the query.

write_disposition 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 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 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 List<Property Map>

Connection properties.

createDisposition 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 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 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 Property Map

Custom encryption configuration (e.g., Cloud KMS keys).

destinationTable 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 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 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 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 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 Boolean

[Deprecated] This property is deprecated.

Deprecated:

[Deprecated] This property is deprecated.

priority String

[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.

query 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 List<Property Map>

Query parameters for standard SQL queries.

rangePartitioning Property Map

[TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

schemaUpdateOptions 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 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 Property Map

Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

useLegacySql 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 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 List<Property Map>

Describes user-defined function resources used in the query.

writeDisposition 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 Pulumi.GoogleNative.BigQuery.V2.Inputs.JobConfigurationTableCopyResponse

[Pick one] Copies a table.

DryRun 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 Pulumi.GoogleNative.BigQuery.V2.Inputs.JobConfigurationExtractResponse

[Pick one] Configures an extract job.

JobTimeoutMs string

[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.

JobType string

The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.

Labels 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 Pulumi.GoogleNative.BigQuery.V2.Inputs.JobConfigurationLoadResponse

[Pick one] Configures a load job.

Query Pulumi.GoogleNative.BigQuery.V2.Inputs.JobConfigurationQueryResponse

[Pick one] Configures a query job.

Copy JobConfigurationTableCopyResponse

[Pick one] Copies a table.

DryRun 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 JobConfigurationExtractResponse

[Pick one] Configures an extract job.

JobTimeoutMs string

[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.

JobType string

The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.

Labels 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 JobConfigurationLoadResponse

[Pick one] Configures a load job.

Query JobConfigurationQueryResponse

[Pick one] Configures a query job.

copy JobConfigurationTableCopyResponse

[Pick one] Copies a table.

dryRun 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 JobConfigurationExtractResponse

[Pick one] Configures an extract job.

jobTimeoutMs String

[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.

jobType String

The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.

labels 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 JobConfigurationLoadResponse

[Pick one] Configures a load job.

query JobConfigurationQueryResponse

[Pick one] Configures a query job.

copy JobConfigurationTableCopyResponse

[Pick one] Copies a table.

dryRun 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 JobConfigurationExtractResponse

[Pick one] Configures an extract job.

jobTimeoutMs string

[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.

jobType string

The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.

labels {[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 JobConfigurationLoadResponse

[Pick one] Configures a load job.

query JobConfigurationQueryResponse

[Pick one] Configures a query job.

copy JobConfigurationTableCopyResponse

[Pick one] Copies a table.

dry_run 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 JobConfigurationExtractResponse

[Pick one] Configures an extract job.

job_timeout_ms str

[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.

job_type str

The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.

labels 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 JobConfigurationLoadResponse

[Pick one] Configures a load job.

query JobConfigurationQueryResponse

[Pick one] Configures a query job.

copy Property Map

[Pick one] Copies a table.

dryRun 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 Property Map

[Pick one] Configures an extract job.

jobTimeoutMs String

[Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.

jobType String

The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.

labels 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 Property Map

[Pick one] Configures a load job.

query Property Map

[Pick one] Configures a query job.

JobConfigurationTableCopyResponse

CreateDisposition 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 Pulumi.GoogleNative.BigQuery.V2.Inputs.EncryptionConfigurationResponse

Custom encryption configuration (e.g., Cloud KMS keys).

DestinationExpirationTime object

[Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.

DestinationTable Pulumi.GoogleNative.BigQuery.V2.Inputs.TableReferenceResponse

[Required] The destination table

OperationType string

[Optional] Supported operation types in table copy job.

SourceTable Pulumi.GoogleNative.BigQuery.V2.Inputs.TableReferenceResponse

[Pick one] Source table to copy.

SourceTables List<Pulumi.GoogleNative.BigQuery.V2.Inputs.TableReferenceResponse>

[Pick one] Source tables to copy.

WriteDisposition 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 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 EncryptionConfigurationResponse

Custom encryption configuration (e.g., Cloud KMS keys).

DestinationExpirationTime interface{}

[Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.

DestinationTable TableReferenceResponse

[Required] The destination table

OperationType string

[Optional] Supported operation types in table copy job.

SourceTable TableReferenceResponse

[Pick one] Source table to copy.

SourceTables []TableReferenceResponse

[Pick one] Source tables to copy.

WriteDisposition 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 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 EncryptionConfigurationResponse

Custom encryption configuration (e.g., Cloud KMS keys).

destinationExpirationTime Object

[Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.

destinationTable TableReferenceResponse

[Required] The destination table

operationType String

[Optional] Supported operation types in table copy job.

sourceTable TableReferenceResponse

[Pick one] Source table to copy.

sourceTables List<TableReferenceResponse>

[Pick one] Source tables to copy.

writeDisposition 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 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 EncryptionConfigurationResponse

Custom encryption configuration (e.g., Cloud KMS keys).

destinationExpirationTime any

[Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.

destinationTable TableReferenceResponse

[Required] The destination table

operationType string

[Optional] Supported operation types in table copy job.

sourceTable TableReferenceResponse

[Pick one] Source table to copy.

sourceTables TableReferenceResponse[]

[Pick one] Source tables to copy.

writeDisposition 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 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 EncryptionConfigurationResponse

Custom encryption configuration (e.g., Cloud KMS keys).

destination_expiration_time Any

[Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.

destination_table TableReferenceResponse

[Required] The destination table

operation_type str

[Optional] Supported operation types in table copy job.

source_table TableReferenceResponse

[Pick one] Source table to copy.

source_tables Sequence[TableReferenceResponse]

[Pick one] Source tables to copy.

write_disposition 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 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 Property Map

Custom encryption configuration (e.g., Cloud KMS keys).

destinationExpirationTime Any

[Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.

destinationTable Property Map

[Required] The destination table

operationType String

[Optional] Supported operation types in table copy job.

sourceTable Property Map

[Pick one] Source table to copy.

sourceTables List<Property Map>

[Pick one] Source tables to copy.

writeDisposition 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 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 string

The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

Project string

[Required] The ID of the project containing this job.

JobId 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 string

The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

Project string

[Required] The ID of the project containing this job.

jobId 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 String

The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

project String

[Required] The ID of the project containing this job.

jobId 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 string

The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

project string

[Required] The ID of the project containing this job.

job_id 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 str

The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

project str

[Required] The ID of the project containing this job.

jobId 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 String

The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

project String

[Required] The ID of the project containing this job.

JobStatistics2ReservationUsageItemResponse

Name string

[Output only] Reservation name or "unreserved" for on-demand resources usage.

SlotMs string

[Output only] Slot-milliseconds the job spent in the given reservation.

Name string

[Output only] Reservation name or "unreserved" for on-demand resources usage.

SlotMs string

[Output only] Slot-milliseconds the job spent in the given reservation.

name String

[Output only] Reservation name or "unreserved" for on-demand resources usage.

slotMs String

[Output only] Slot-milliseconds the job spent in the given reservation.

name string

[Output only] Reservation name or "unreserved" for on-demand resources usage.

slotMs string

[Output only] Slot-milliseconds the job spent in the given reservation.

name str

[Output only] Reservation name or "unreserved" for on-demand resources usage.

slot_ms str

[Output only] Slot-milliseconds the job spent in the given reservation.

name String

[Output only] Reservation name or "unreserved" for on-demand resources usage.

slotMs String

[Output only] Slot-milliseconds the job spent in the given reservation.

JobStatistics2Response

BiEngineStatistics Pulumi.GoogleNative.BigQuery.V2.Inputs.BiEngineStatisticsResponse

BI Engine specific Statistics. [Output only] BI Engine specific Statistics.

BillingTier int

[Output only] Billing tier for the job.

CacheHit bool

[Output only] Whether the query result was fetched from the query cache.

DdlAffectedRowAccessPolicyCount 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 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 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 Pulumi.GoogleNative.BigQuery.V2.Inputs.DatasetReferenceResponse

[Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA queries.

DdlTargetRoutine Pulumi.GoogleNative.BigQuery.V2.Inputs.RoutineReferenceResponse

The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.

DdlTargetRowAccessPolicy 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 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 Pulumi.GoogleNative.BigQuery.V2.Inputs.DmlStatisticsResponse

[Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.

EstimatedBytesProcessed string

[Output only] The original estimate of bytes processed for the job.

MlStatistics Pulumi.GoogleNative.BigQuery.V2.Inputs.MlStatisticsResponse

[Output only] Statistics of a BigQuery ML training job.

ModelTraining Pulumi.GoogleNative.BigQuery.V2.Inputs.BigQueryModelTrainingResponse

[Output only, Beta] Information about create model query job progress.

ModelTrainingCurrentIteration int

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

Deprecated:

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

ModelTrainingExpectedTotalIteration string

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

Deprecated:

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

NumDmlAffectedRows string

[Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.

QueryPlan List<Pulumi.GoogleNative.BigQuery.V2.Inputs.ExplainQueryStageResponse>

[Output only] Describes execution plan for the query.

ReferencedRoutines List<Pulumi.GoogleNative.BigQuery.V2.Inputs.RoutineReferenceResponse>

[Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.

ReferencedTables 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 List<Pulumi.GoogleNative.BigQuery.V2.Inputs.JobStatistics2ReservationUsageItemResponse>

[Output only] Job resource usage breakdown by reservation.

Schema 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 Pulumi.GoogleNative.BigQuery.V2.Inputs.SearchStatisticsResponse

[Output only] Search query specific statistics.

SparkStatistics Pulumi.GoogleNative.BigQuery.V2.Inputs.SparkStatisticsResponse

[Output only] Statistics of a Spark procedure job.

StatementType 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 List<Pulumi.GoogleNative.BigQuery.V2.Inputs.QueryTimelineSampleResponse>

[Output only] [Beta] Describes a timeline of job execution.

TotalBytesBilled string

[Output only] Total bytes billed for the job.

TotalBytesProcessed string

[Output only] Total bytes processed for the job.

TotalBytesProcessedAccuracy 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 string

[Output only] Total number of partitions processed from all partitioned tables referenced in the job.

TotalSlotMs string

[Output only] Slot-milliseconds for the job.

TransferredBytes string

Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).

UndeclaredQueryParameters List<Pulumi.GoogleNative.BigQuery.V2.Inputs.QueryParameterResponse>

Standard SQL only: list of undeclared query parameters detected during a dry run validation.

BiEngineStatistics BiEngineStatisticsResponse

BI Engine specific Statistics. [Output only] BI Engine specific Statistics.

BillingTier int

[Output only] Billing tier for the job.

CacheHit bool

[Output only] Whether the query result was fetched from the query cache.

DdlAffectedRowAccessPolicyCount 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 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 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 DatasetReferenceResponse

[Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA queries.

DdlTargetRoutine RoutineReferenceResponse

The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.

DdlTargetRowAccessPolicy RowAccessPolicyReferenceResponse

[Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.

DdlTargetTable TableReferenceResponse

[Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.

DmlStats DmlStatisticsResponse

[Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.

EstimatedBytesProcessed string

[Output only] The original estimate of bytes processed for the job.

MlStatistics MlStatisticsResponse

[Output only] Statistics of a BigQuery ML training job.

ModelTraining BigQueryModelTrainingResponse

[Output only, Beta] Information about create model query job progress.

ModelTrainingCurrentIteration int

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

Deprecated:

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

ModelTrainingExpectedTotalIteration string

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

Deprecated:

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

NumDmlAffectedRows string

[Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.

QueryPlan []ExplainQueryStageResponse

[Output only] Describes execution plan for the query.

ReferencedRoutines []RoutineReferenceResponse

[Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.

ReferencedTables []TableReferenceResponse

[Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.

ReservationUsage []JobStatistics2ReservationUsageItemResponse

[Output only] Job resource usage breakdown by reservation.

Schema TableSchemaResponse

[Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.

SearchStatistics SearchStatisticsResponse

[Output only] Search query specific statistics.

SparkStatistics SparkStatisticsResponse

[Output only] Statistics of a Spark procedure job.

StatementType 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 []QueryTimelineSampleResponse

[Output only] [Beta] Describes a timeline of job execution.

TotalBytesBilled string

[Output only] Total bytes billed for the job.

TotalBytesProcessed string

[Output only] Total bytes processed for the job.

TotalBytesProcessedAccuracy 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 string

[Output only] Total number of partitions processed from all partitioned tables referenced in the job.

TotalSlotMs string

[Output only] Slot-milliseconds for the job.

TransferredBytes string

Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).

UndeclaredQueryParameters []QueryParameterResponse

Standard SQL only: list of undeclared query parameters detected during a dry run validation.

biEngineStatistics BiEngineStatisticsResponse

BI Engine specific Statistics. [Output only] BI Engine specific Statistics.

billingTier Integer

[Output only] Billing tier for the job.

cacheHit Boolean

[Output only] Whether the query result was fetched from the query cache.

ddlAffectedRowAccessPolicyCount 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 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 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 DatasetReferenceResponse

[Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA queries.

ddlTargetRoutine RoutineReferenceResponse

The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.

ddlTargetRowAccessPolicy RowAccessPolicyReferenceResponse

[Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.

ddlTargetTable TableReferenceResponse

[Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.

dmlStats DmlStatisticsResponse

[Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.

estimatedBytesProcessed String

[Output only] The original estimate of bytes processed for the job.

mlStatistics MlStatisticsResponse

[Output only] Statistics of a BigQuery ML training job.

modelTraining BigQueryModelTrainingResponse

[Output only, Beta] Information about create model query job progress.

modelTrainingCurrentIteration Integer

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

Deprecated:

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

modelTrainingExpectedTotalIteration String

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

Deprecated:

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

numDmlAffectedRows String

[Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.

queryPlan List<ExplainQueryStageResponse>

[Output only] Describes execution plan for the query.

referencedRoutines List<RoutineReferenceResponse>

[Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.

referencedTables List<TableReferenceResponse>

[Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.

reservationUsage List<JobStatistics2ReservationUsageItemResponse>

[Output only] Job resource usage breakdown by reservation.

schema TableSchemaResponse

[Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.

searchStatistics SearchStatisticsResponse

[Output only] Search query specific statistics.

sparkStatistics SparkStatisticsResponse

[Output only] Statistics of a Spark procedure job.

statementType 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 List<QueryTimelineSampleResponse>

[Output only] [Beta] Describes a timeline of job execution.

totalBytesBilled String

[Output only] Total bytes billed for the job.

totalBytesProcessed String

[Output only] Total bytes processed for the job.

totalBytesProcessedAccuracy 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 String

[Output only] Total number of partitions processed from all partitioned tables referenced in the job.

totalSlotMs String

[Output only] Slot-milliseconds for the job.

transferredBytes String

Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).

undeclaredQueryParameters List<QueryParameterResponse>

Standard SQL only: list of undeclared query parameters detected during a dry run validation.

biEngineStatistics BiEngineStatisticsResponse

BI Engine specific Statistics. [Output only] BI Engine specific Statistics.

billingTier number

[Output only] Billing tier for the job.

cacheHit boolean

[Output only] Whether the query result was fetched from the query cache.

ddlAffectedRowAccessPolicyCount 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 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 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 DatasetReferenceResponse

[Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA queries.

ddlTargetRoutine RoutineReferenceResponse

The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.

ddlTargetRowAccessPolicy RowAccessPolicyReferenceResponse

[Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.

ddlTargetTable TableReferenceResponse

[Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.

dmlStats DmlStatisticsResponse

[Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.

estimatedBytesProcessed string

[Output only] The original estimate of bytes processed for the job.

mlStatistics MlStatisticsResponse

[Output only] Statistics of a BigQuery ML training job.

modelTraining BigQueryModelTrainingResponse

[Output only, Beta] Information about create model query job progress.

modelTrainingCurrentIteration number

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

Deprecated:

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

modelTrainingExpectedTotalIteration string

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

Deprecated:

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

numDmlAffectedRows string

[Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.

queryPlan ExplainQueryStageResponse[]

[Output only] Describes execution plan for the query.

referencedRoutines RoutineReferenceResponse[]

[Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.

referencedTables TableReferenceResponse[]

[Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.

reservationUsage JobStatistics2ReservationUsageItemResponse[]

[Output only] Job resource usage breakdown by reservation.

schema TableSchemaResponse

[Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.

searchStatistics SearchStatisticsResponse

[Output only] Search query specific statistics.

sparkStatistics SparkStatisticsResponse

[Output only] Statistics of a Spark procedure job.

statementType 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 QueryTimelineSampleResponse[]

[Output only] [Beta] Describes a timeline of job execution.

totalBytesBilled string

[Output only] Total bytes billed for the job.

totalBytesProcessed string

[Output only] Total bytes processed for the job.

totalBytesProcessedAccuracy 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 string

[Output only] Total number of partitions processed from all partitioned tables referenced in the job.

totalSlotMs string

[Output only] Slot-milliseconds for the job.

transferredBytes string

Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).

undeclaredQueryParameters QueryParameterResponse[]

Standard SQL only: list of undeclared query parameters detected during a dry run validation.

bi_engine_statistics BiEngineStatisticsResponse

BI Engine specific Statistics. [Output only] BI Engine specific Statistics.

billing_tier int

[Output only] Billing tier for the job.

cache_hit bool

[Output only] Whether the query result was fetched from the query cache.

ddl_affected_row_access_policy_count 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 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 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 DatasetReferenceResponse

[Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA queries.

ddl_target_routine RoutineReferenceResponse

The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.

ddl_target_row_access_policy RowAccessPolicyReferenceResponse

[Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.

ddl_target_table TableReferenceResponse

[Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.

dml_stats DmlStatisticsResponse

[Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.

estimated_bytes_processed str

[Output only] The original estimate of bytes processed for the job.

ml_statistics MlStatisticsResponse

[Output only] Statistics of a BigQuery ML training job.

model_training BigQueryModelTrainingResponse

[Output only, Beta] Information about create model query job progress.

model_training_current_iteration int

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

Deprecated:

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

model_training_expected_total_iteration str

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

Deprecated:

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

num_dml_affected_rows str

[Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.

query_plan Sequence[ExplainQueryStageResponse]

[Output only] Describes execution plan for the query.

referenced_routines Sequence[RoutineReferenceResponse]

[Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.

referenced_tables Sequence[TableReferenceResponse]

[Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.

reservation_usage Sequence[JobStatistics2ReservationUsageItemResponse]

[Output only] Job resource usage breakdown by reservation.

schema TableSchemaResponse

[Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.

search_statistics SearchStatisticsResponse

[Output only] Search query specific statistics.

spark_statistics SparkStatisticsResponse

[Output only] Statistics of a Spark procedure job.

statement_type 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 Sequence[QueryTimelineSampleResponse]

[Output only] [Beta] Describes a timeline of job execution.

total_bytes_billed str

[Output only] Total bytes billed for the job.

total_bytes_processed str

[Output only] Total bytes processed for the job.

total_bytes_processed_accuracy 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 str

[Output only] Total number of partitions processed from all partitioned tables referenced in the job.

total_slot_ms str

[Output only] Slot-milliseconds for the job.

transferred_bytes str

Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).

undeclared_query_parameters Sequence[QueryParameterResponse]

Standard SQL only: list of undeclared query parameters detected during a dry run validation.

biEngineStatistics Property Map

BI Engine specific Statistics. [Output only] BI Engine specific Statistics.

billingTier Number

[Output only] Billing tier for the job.

cacheHit Boolean

[Output only] Whether the query result was fetched from the query cache.

ddlAffectedRowAccessPolicyCount 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 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 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 Property Map

[Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP SCHEMA queries.

ddlTargetRoutine Property Map

The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.

ddlTargetRowAccessPolicy Property Map

[Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.

ddlTargetTable Property Map

[Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.

dmlStats Property Map

[Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.

estimatedBytesProcessed String

[Output only] The original estimate of bytes processed for the job.

mlStatistics Property Map

[Output only] Statistics of a BigQuery ML training job.

modelTraining Property Map

[Output only, Beta] Information about create model query job progress.

modelTrainingCurrentIteration Number

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

Deprecated:

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

modelTrainingExpectedTotalIteration String

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

Deprecated:

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

numDmlAffectedRows String

[Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.

queryPlan List<Property Map>

[Output only] Describes execution plan for the query.

referencedRoutines List<Property Map>

[Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.

referencedTables List<Property Map>

[Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.

reservationUsage List<Property Map>

[Output only] Job resource usage breakdown by reservation.

schema Property Map

[Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.

searchStatistics Property Map

[Output only] Search query specific statistics.

sparkStatistics Property Map

[Output only] Statistics of a Spark procedure job.

statementType 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 List<Property Map>

[Output only] [Beta] Describes a timeline of job execution.

totalBytesBilled String

[Output only] Total bytes billed for the job.

totalBytesProcessed String

[Output only] Total bytes processed for the job.

totalBytesProcessedAccuracy 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 String

[Output only] Total number of partitions processed from all partitioned tables referenced in the job.

totalSlotMs String

[Output only] Slot-milliseconds for the job.

transferredBytes String

Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).

undeclaredQueryParameters List<Property Map>

Standard SQL only: list of undeclared query parameters detected during a dry run validation.

JobStatistics3Response

BadRecords 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 string

Number of bytes of source data in a load job.

InputFiles string

Number of source files in a load job.

OutputBytes string

Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.

OutputRows 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 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 string

Number of bytes of source data in a load job.

InputFiles string

Number of source files in a load job.

OutputBytes string

Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.

OutputRows 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 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 String

Number of bytes of source data in a load job.

inputFiles String

Number of source files in a load job.

outputBytes String

Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.

outputRows 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 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 string

Number of bytes of source data in a load job.

inputFiles string

Number of source files in a load job.

outputBytes string

Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.

outputRows 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 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 str

Number of bytes of source data in a load job.

input_files str

Number of source files in a load job.

output_bytes 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 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 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 String

Number of bytes of source data in a load job.

inputFiles String

Number of source files in a load job.

outputBytes String

Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.

outputRows 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 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 string

Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.

DestinationUriFileCounts []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 string

Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.

destinationUriFileCounts 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 String

Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.

destinationUriFileCounts 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 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 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 str

Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.

destinationUriFileCounts 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 String

Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.

JobStatistics5Response

CopiedLogicalBytes string

Number of logical bytes copied to the destination table.

CopiedRows string

Number of rows copied to the destination table.

CopiedLogicalBytes string

Number of logical bytes copied to the destination table.

CopiedRows string

Number of rows copied to the destination table.

copiedLogicalBytes String

Number of logical bytes copied to the destination table.

copiedRows String

Number of rows copied to the destination table.

copiedLogicalBytes string

Number of logical bytes copied to the destination table.

copiedRows string

Number of rows copied to the destination table.

copied_logical_bytes str

Number of logical bytes copied to the destination table.

copied_rows str

Number of rows copied to the destination table.

copiedLogicalBytes String

Number of logical bytes copied to the destination table.

copiedRows String

Number of rows copied to the destination table.

JobStatisticsReservationUsageItemResponse

Name string

Reservation name or "unreserved" for on-demand resources usage.

SlotMs string

Slot-milliseconds the job spent in the given reservation.

Name string

Reservation name or "unreserved" for on-demand resources usage.

SlotMs string

Slot-milliseconds the job spent in the given reservation.

name String

Reservation name or "unreserved" for on-demand resources usage.

slotMs String

Slot-milliseconds the job spent in the given reservation.

name string

Reservation name or "unreserved" for on-demand resources usage.

slotMs string

Slot-milliseconds the job spent in the given reservation.

name str

Reservation name or "unreserved" for on-demand resources usage.

slot_ms str

Slot-milliseconds the job spent in the given reservation.

name String

Reservation name or "unreserved" for on-demand resources usage.

slotMs String

Slot-milliseconds the job spent in the given reservation.

JobStatisticsResponse

CompletionRatio double

[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.

Copy Pulumi.GoogleNative.BigQuery.V2.Inputs.JobStatistics5Response

Statistics for a copy job.

CreationTime string

Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.

DataMaskingStatistics Pulumi.GoogleNative.BigQuery.V2.Inputs.DataMaskingStatisticsResponse

Statistics for data masking. Present only for query and extract jobs.

EndTime 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 Pulumi.GoogleNative.BigQuery.V2.Inputs.JobStatistics4Response

Statistics for an extract job.

Load Pulumi.GoogleNative.BigQuery.V2.Inputs.JobStatistics3Response

Statistics for a load job.

NumChildJobs string

Number of child jobs executed.

ParentJobId string

If this is a child job, the id of the parent.

Query Pulumi.GoogleNative.BigQuery.V2.Inputs.JobStatistics2Response

Statistics for a query job.

QuotaDeferments List<string>

Quotas which delayed this job's start time.

ReservationId 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 List<Pulumi.GoogleNative.BigQuery.V2.Inputs.JobStatisticsReservationUsageItemResponse>

Job resource usage breakdown by reservation.

RowLevelSecurityStatistics Pulumi.GoogleNative.BigQuery.V2.Inputs.RowLevelSecurityStatisticsResponse

[Preview] Statistics for row-level security. Present only for query and extract jobs.

ScriptStatistics Pulumi.GoogleNative.BigQuery.V2.Inputs.ScriptStatisticsResponse

Statistics for a child job of a script.

SessionInfo Pulumi.GoogleNative.BigQuery.V2.Inputs.SessionInfoResponse

[Preview] Information of the session if this job is part of one.

StartTime 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 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 string

Slot-milliseconds for the job.

TransactionInfo Pulumi.GoogleNative.BigQuery.V2.Inputs.TransactionInfoResponse

[Alpha] Information of the multi-statement transaction if this job is part of one.

CompletionRatio float64

[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.

Copy JobStatistics5Response

Statistics for a copy job.

CreationTime string

Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.

DataMaskingStatistics DataMaskingStatisticsResponse

Statistics for data masking. Present only for query and extract jobs.

EndTime 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 JobStatistics4Response

Statistics for an extract job.

Load JobStatistics3Response

Statistics for a load job.

NumChildJobs string

Number of child jobs executed.

ParentJobId string

If this is a child job, the id of the parent.

Query JobStatistics2Response

Statistics for a query job.

QuotaDeferments []string

Quotas which delayed this job's start time.

ReservationId 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 []JobStatisticsReservationUsageItemResponse

Job resource usage breakdown by reservation.

RowLevelSecurityStatistics RowLevelSecurityStatisticsResponse

[Preview] Statistics for row-level security. Present only for query and extract jobs.

ScriptStatistics ScriptStatisticsResponse

Statistics for a child job of a script.

SessionInfo SessionInfoResponse

[Preview] Information of the session if this job is part of one.

StartTime 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 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 string

Slot-milliseconds for the job.

TransactionInfo TransactionInfoResponse

[Alpha] Information of the multi-statement transaction if this job is part of one.

completionRatio Double

[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.

copy JobStatistics5Response

Statistics for a copy job.

creationTime String

Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.

dataMaskingStatistics DataMaskingStatisticsResponse

Statistics for data masking. Present only for query and extract jobs.

endTime 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 JobStatistics4Response

Statistics for an extract job.

load JobStatistics3Response

Statistics for a load job.

numChildJobs String

Number of child jobs executed.

parentJobId String

If this is a child job, the id of the parent.

query JobStatistics2Response

Statistics for a query job.

quotaDeferments List<String>

Quotas which delayed this job's start time.

reservationId 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 List<JobStatisticsReservationUsageItemResponse>

Job resource usage breakdown by reservation.

rowLevelSecurityStatistics RowLevelSecurityStatisticsResponse

[Preview] Statistics for row-level security. Present only for query and extract jobs.

scriptStatistics ScriptStatisticsResponse

Statistics for a child job of a script.

sessionInfo SessionInfoResponse

[Preview] Information of the session if this job is part of one.

startTime 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 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 String

Slot-milliseconds for the job.

transactionInfo TransactionInfoResponse

[Alpha] Information of the multi-statement transaction if this job is part of one.

completionRatio number

[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.

copy JobStatistics5Response

Statistics for a copy job.

creationTime string

Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.

dataMaskingStatistics DataMaskingStatisticsResponse

Statistics for data masking. Present only for query and extract jobs.

endTime 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 JobStatistics4Response

Statistics for an extract job.

load JobStatistics3Response

Statistics for a load job.

numChildJobs string

Number of child jobs executed.

parentJobId string

If this is a child job, the id of the parent.

query JobStatistics2Response

Statistics for a query job.

quotaDeferments string[]

Quotas which delayed this job's start time.

reservationId 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 JobStatisticsReservationUsageItemResponse[]

Job resource usage breakdown by reservation.

rowLevelSecurityStatistics RowLevelSecurityStatisticsResponse

[Preview] Statistics for row-level security. Present only for query and extract jobs.

scriptStatistics ScriptStatisticsResponse

Statistics for a child job of a script.

sessionInfo SessionInfoResponse

[Preview] Information of the session if this job is part of one.

startTime 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 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 string

Slot-milliseconds for the job.

transactionInfo TransactionInfoResponse

[Alpha] Information of the multi-statement transaction if this job is part of one.

completion_ratio float

[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.

copy JobStatistics5Response

Statistics for a copy job.

creation_time str

Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.

data_masking_statistics DataMaskingStatisticsResponse

Statistics for data masking. Present only for query and extract jobs.

end_time 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 JobStatistics4Response

Statistics for an extract job.

load JobStatistics3Response

Statistics for a load job.

num_child_jobs str

Number of child jobs executed.

parent_job_id str

If this is a child job, the id of the parent.

query JobStatistics2Response

Statistics for a query job.

quota_deferments Sequence[str]

Quotas which delayed this job's start time.

reservation_id 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 Sequence[JobStatisticsReservationUsageItemResponse]

Job resource usage breakdown by reservation.

row_level_security_statistics RowLevelSecurityStatisticsResponse

[Preview] Statistics for row-level security. Present only for query and extract jobs.

script_statistics ScriptStatisticsResponse

Statistics for a child job of a script.

session_info SessionInfoResponse

[Preview] Information of the session if this job is part of one.

start_time 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 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 str

Slot-milliseconds for the job.

transaction_info TransactionInfoResponse

[Alpha] Information of the multi-statement transaction if this job is part of one.

completionRatio Number

[TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.

copy Property Map

Statistics for a copy job.

creationTime String

Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.

dataMaskingStatistics Property Map

Statistics for data masking. Present only for query and extract jobs.

endTime 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 Property Map

Statistics for an extract job.

load Property Map

Statistics for a load job.

numChildJobs String

Number of child jobs executed.

parentJobId String

If this is a child job, the id of the parent.

query Property Map

Statistics for a query job.

quotaDeferments List<String>

Quotas which delayed this job's start time.

reservationId 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 List<Property Map>

Job resource usage breakdown by reservation.

rowLevelSecurityStatistics Property Map

[Preview] Statistics for row-level security. Present only for query and extract jobs.

scriptStatistics Property Map

Statistics for a child job of a script.

sessionInfo Property Map

[Preview] Information of the session if this job is part of one.

startTime 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 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 String

Slot-milliseconds for the job.

transactionInfo Property Map

[Alpha] Information of the multi-statement transaction if this job is part of one.

JobStatusResponse

ErrorResult Pulumi.GoogleNative.BigQuery.V2.Inputs.ErrorProtoResponse

Final error result of the job. If present, indicates that the job has completed and was unsuccessful.

Errors 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 string

Running state of the job.

ErrorResult ErrorProtoResponse

Final error result of the job. If present, indicates that the job has completed and was unsuccessful.

Errors []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 string

Running state of the job.

errorResult ErrorProtoResponse

Final error result of the job. If present, indicates that the job has completed and was unsuccessful.

errors 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 String

Running state of the job.

errorResult ErrorProtoResponse

Final error result of the job. If present, indicates that the job has completed and was unsuccessful.

errors 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 string

Running state of the job.

error_result ErrorProtoResponse

Final error result of the job. If present, indicates that the job has completed and was unsuccessful.

errors 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 str

Running state of the job.

errorResult Property Map

Final error result of the job. If present, indicates that the job has completed and was unsuccessful.

errors 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 String

Running state of the job.

MlStatisticsResponse

IterationResults List<Pulumi.GoogleNative.BigQuery.V2.Inputs.IterationResultResponse>

Results for all completed iterations.

MaxIterations 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 []IterationResultResponse

Results for all completed iterations.

MaxIterations 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 List<IterationResultResponse>

Results for all completed iterations.

maxIterations 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 IterationResultResponse[]

Results for all completed iterations.

maxIterations 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 Sequence[IterationResultResponse]

Results for all completed iterations.

max_iterations 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 List<Property Map>

Results for all completed iterations.

maxIterations 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 string

[Required] The ID of the dataset containing this model.

ModelId string

[Required] 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 string

[Required] The ID of the project containing this model.

DatasetId string

[Required] The ID of the dataset containing this model.

ModelId string

[Required] 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 string

[Required] The ID of the project containing this model.

datasetId String

[Required] The ID of the dataset containing this model.

modelId String

[Required] 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 String

[Required] The ID of the project containing this model.

datasetId string

[Required] The ID of the dataset containing this model.

modelId string

[Required] 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 string

[Required] The ID of the project containing this model.

dataset_id str

[Required] The ID of the dataset containing this model.

model_id str

[Required] 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 str

[Required] The ID of the project containing this model.

datasetId String

[Required] The ID of the dataset containing this model.

modelId String

[Required] 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 String

[Required] The ID of the project containing this model.

ParquetOptionsResponse

EnableListInference bool

[Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.

EnumAsString bool

[Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.

EnableListInference bool

[Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.

EnumAsString bool

[Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.

enableListInference Boolean

[Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.

enumAsString Boolean

[Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.

enableListInference boolean

[Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.

enumAsString boolean

[Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.

enable_list_inference bool

[Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.

enum_as_string bool

[Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.

enableListInference Boolean

[Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.

enumAsString Boolean

[Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.

QueryParameterResponse

Name string

[Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.

ParameterType Pulumi.GoogleNative.BigQuery.V2.Inputs.QueryParameterTypeResponse

[Required] The type of this parameter.

ParameterValue Pulumi.GoogleNative.BigQuery.V2.Inputs.QueryParameterValueResponse

[Required] The value of this parameter.

Name string

[Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.

ParameterType QueryParameterTypeResponse

[Required] The type of this parameter.

ParameterValue QueryParameterValueResponse

[Required] The value of this parameter.

name String

[Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.

parameterType QueryParameterTypeResponse

[Required] The type of this parameter.

parameterValue QueryParameterValueResponse

[Required] The value of this parameter.

name string

[Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.

parameterType QueryParameterTypeResponse

[Required] The type of this parameter.

parameterValue QueryParameterValueResponse

[Required] The value of this parameter.

name str

[Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.

parameter_type QueryParameterTypeResponse

[Required] The type of this parameter.

parameter_value QueryParameterValueResponse

[Required] The value of this parameter.

name String

[Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.

parameterType Property Map

[Required] The type of this parameter.

parameterValue Property Map

[Required] The value of this parameter.

QueryParameterTypeResponse

StructTypes List<Pulumi.GoogleNative.BigQuery.V2.Inputs.QueryParameterTypeStructTypesItemResponse>

[Optional] The types of the fields of this struct, in order, if this is a struct.

Type 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 []QueryParameterTypeStructTypesItemResponse

[Optional] The types of the fields of this struct, in order, if this is a struct.

Type 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 List<QueryParameterTypeStructTypesItemResponse>

[Optional] The types of the fields of this struct, in order, if this is a struct.

type 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 QueryParameterTypeStructTypesItemResponse[]

[Optional] The types of the fields of this struct, in order, if this is a struct.

type 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 Sequence[QueryParameterTypeStructTypesItemResponse]

[Optional] The types of the fields of this struct, in order, if this is a struct.

type 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 List<Property Map>

[Optional] The types of the fields of this struct, in order, if this is a struct.

type 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 string

[Optional] Human-oriented description of the field.

Name string

[Optional] The name of this field.

Type Pulumi.GoogleNative.BigQuery.V2.Inputs.QueryParameterTypeResponse

[Required] The type of this field.

Description string

[Optional] Human-oriented description of the field.

Name string

[Optional] The name of this field.

Type QueryParameterTypeResponse

[Required] The type of this field.

description String

[Optional] Human-oriented description of the field.

name String

[Optional] The name of this field.

type QueryParameterTypeResponse

[Required] The type of this field.

description string

[Optional] Human-oriented description of the field.

name string

[Optional] The name of this field.

type QueryParameterTypeResponse

[Required] The type of this field.

description str

[Optional] Human-oriented description of the field.

name str

[Optional] The name of this field.

type QueryParameterTypeResponse

[Required] The type of this field.

description String

[Optional] Human-oriented description of the field.

name String

[Optional] The name of this field.

type Property Map

[Required] The type of this field.

QueryParameterValueResponse

ArrayValues List<Pulumi.GoogleNative.BigQuery.V2.Inputs.QueryParameterValueResponse>

[Optional] The array values, if this is an array type.

StructValues Dictionary<string, string>

[Optional] The struct field values, in order of the struct type's declaration.

Value string

[Optional] The value of this value, if a simple scalar type.

ArrayValues []QueryParameterValueResponse

[Optional] The array values, if this is an array type.

StructValues map[string]string

[Optional] The struct field values, in order of the struct type's declaration.

Value string

[Optional] The value of this value, if a simple scalar type.

arrayValues List<QueryParameterValueResponse>

[Optional] The array values, if this is an array type.

structValues Map<String,String>

[Optional] The struct field values, in order of the struct type's declaration.

value String

[Optional] The value of this value, if a simple scalar type.

arrayValues QueryParameterValueResponse[]

[Optional] The array values, if this is an array type.

structValues {[key: string]: string}

[Optional] The struct field values, in order of the struct type's declaration.

value string

[Optional] The value of this value, if a simple scalar type.

array_values Sequence[QueryParameterValueResponse]

[Optional] The array values, if this is an array type.

struct_values Mapping[str, str]

[Optional] The struct field values, in order of the struct type's declaration.

value str

[Optional] The value of this value, if a simple scalar type.

arrayValues List<Property Map>

[Optional] The array values, if this is an array type.

structValues Map<String>

[Optional] The struct field values, in order of the struct type's declaration.

value String

[Optional] The value of this value, if a simple scalar type.

QueryTimelineSampleResponse

ActiveUnits 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 string

Total parallel units of work completed by this query.

ElapsedMs string

Milliseconds elapsed since the start of query execution.

EstimatedRunnableUnits 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 string

Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.

TotalSlotMs string

Cumulative slot-ms consumed by the query.

ActiveUnits 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 string

Total parallel units of work completed by this query.

ElapsedMs string

Milliseconds elapsed since the start of query execution.

EstimatedRunnableUnits 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 string

Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.

TotalSlotMs string

Cumulative slot-ms consumed by the query.

activeUnits 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 String

Total parallel units of work completed by this query.

elapsedMs String

Milliseconds elapsed since the start of query execution.

estimatedRunnableUnits 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 String

Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.

totalSlotMs String

Cumulative slot-ms consumed by the query.

activeUnits 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 string

Total parallel units of work completed by this query.

elapsedMs string

Milliseconds elapsed since the start of query execution.

estimatedRunnableUnits 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 string

Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.

totalSlotMs string

Cumulative slot-ms consumed by the query.

active_units 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 str

Total parallel units of work completed by this query.

elapsed_ms str

Milliseconds elapsed since the start of query execution.

estimated_runnable_units 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 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 str

Cumulative slot-ms consumed by the query.

activeUnits 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 String

Total parallel units of work completed by this query.

elapsedMs String

Milliseconds elapsed since the start of query execution.

estimatedRunnableUnits 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 String

Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.

totalSlotMs String

Cumulative slot-ms consumed by the query.

RangePartitioningRangeResponse

End string

[TrustedTester] [Required] The end of range partitioning, exclusive.

Interval string

[TrustedTester] [Required] The width of each interval.

Start string

[TrustedTester] [Required] The start of range partitioning, inclusive.

End string

[TrustedTester] [Required] The end of range partitioning, exclusive.

Interval string

[TrustedTester] [Required] The width of each interval.

Start string

[TrustedTester] [Required] The start of range partitioning, inclusive.

end String

[TrustedTester] [Required] The end of range partitioning, exclusive.

interval String

[TrustedTester] [Required] The width of each interval.

start String

[TrustedTester] [Required] The start of range partitioning, inclusive.

end string

[TrustedTester] [Required] The end of range partitioning, exclusive.

interval string

[TrustedTester] [Required] The width of each interval.

start string

[TrustedTester] [Required] The start of range partitioning, inclusive.

end str

[TrustedTester] [Required] The end of range partitioning, exclusive.

interval str

[TrustedTester] [Required] The width of each interval.

start str

[TrustedTester] [Required] The start of range partitioning, inclusive.

end String

[TrustedTester] [Required] The end of range partitioning, exclusive.

interval String

[TrustedTester] [Required] The width of each interval.

start String

[TrustedTester] [Required] The start of range partitioning, inclusive.

RangePartitioningResponse

Field 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 Pulumi.GoogleNative.BigQuery.V2.Inputs.RangePartitioningRangeResponse

[TrustedTester] [Required] Defines the ranges for range partitioning.

Field 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 RangePartitioningRangeResponse

[TrustedTester] [Required] Defines the ranges for range partitioning.

field 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 RangePartitioningRangeResponse

[TrustedTester] [Required] Defines the ranges for range partitioning.

field 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 RangePartitioningRangeResponse

[TrustedTester] [Required] Defines the ranges for range partitioning.

field 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 RangePartitioningRangeResponse

[TrustedTester] [Required] Defines the ranges for range partitioning.

field 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 Property Map

[TrustedTester] [Required] Defines the ranges for range partitioning.

RoutineReferenceResponse

DatasetId string

[Required] The ID of the dataset containing this routine.

Project string

[Required] The ID of the project containing this routine.

RoutineId string

[Required] 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 string

[Required] The ID of the dataset containing this routine.

Project string

[Required] The ID of the project containing this routine.

RoutineId string

[Required] 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 String

[Required] The ID of the dataset containing this routine.

project String

[Required] The ID of the project containing this routine.

routineId String

[Required] 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 string

[Required] The ID of the dataset containing this routine.

project string

[Required] The ID of the project containing this routine.

routineId string

[Required] 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 str

[Required] The ID of the dataset containing this routine.

project str

[Required] The ID of the project containing this routine.

routine_id str

[Required] 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 String

[Required] The ID of the dataset containing this routine.

project String

[Required] The ID of the project containing this routine.

routineId String

[Required] 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 string

[Required] The ID of the dataset containing this row access policy.

PolicyId string

[Required] 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 string

[Required] The ID of the project containing this row access policy.

TableId string

[Required] The ID of the table containing this row access policy.

DatasetId string

[Required] The ID of the dataset containing this row access policy.

PolicyId string

[Required] 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 string

[Required] The ID of the project containing this row access policy.

TableId string

[Required] The ID of the table containing this row access policy.

datasetId String

[Required] The ID of the dataset containing this row access policy.

policyId String

[Required] 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 String

[Required] The ID of the project containing this row access policy.

tableId String

[Required] The ID of the table containing this row access policy.

datasetId string

[Required] The ID of the dataset containing this row access policy.

policyId string

[Required] 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 string

[Required] The ID of the project containing this row access policy.

tableId string

[Required] The ID of the table containing this row access policy.

dataset_id str

[Required] The ID of the dataset containing this row access policy.

policy_id str

[Required] 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 str

[Required] The ID of the project containing this row access policy.

table_id str

[Required] The ID of the table containing this row access policy.

datasetId String

[Required] The ID of the dataset containing this row access policy.

policyId String

[Required] 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 String

[Required] The ID of the project containing this row access policy.

tableId String

[Required] The ID of the table containing this row access policy.

RowLevelSecurityStatisticsResponse

RowLevelSecurityApplied bool

[Preview] Whether any accessed data was protected by row access policies.

RowLevelSecurityApplied bool

[Preview] Whether any accessed data was protected by row access policies.

rowLevelSecurityApplied Boolean

[Preview] Whether any accessed data was protected by row access policies.

rowLevelSecurityApplied boolean

[Preview] Whether any accessed data was protected by row access policies.

row_level_security_applied bool

[Preview] Whether any accessed data was protected by row access policies.

rowLevelSecurityApplied Boolean

[Preview] Whether any accessed data was protected by row access policies.

ScriptStackFrameResponse

EndColumn int

One-based end column.

EndLine int

One-based end line.

ProcedureId string

Name of the active procedure, empty if in a top-level script.

StartColumn int

One-based start column.

StartLine int

One-based start line.

Text string

Text of the current statement/expression.

EndColumn int

One-based end column.

EndLine int

One-based end line.

ProcedureId string

Name of the active procedure, empty if in a top-level script.

StartColumn int

One-based start column.

StartLine int

One-based start line.

Text string

Text of the current statement/expression.

endColumn Integer

One-based end column.

endLine Integer

One-based end line.

procedureId String

Name of the active procedure, empty if in a top-level script.

startColumn Integer

One-based start column.

startLine Integer

One-based start line.

text String

Text of the current statement/expression.

endColumn number

One-based end column.

endLine number

One-based end line.

procedureId string

Name of the active procedure, empty if in a top-level script.

startColumn number

One-based start column.

startLine number

One-based start line.

text string

Text of the current statement/expression.

end_column int

One-based end column.

end_line int

One-based end line.

procedure_id str

Name of the active procedure, empty if in a top-level script.

start_column int

One-based start column.

start_line int

One-based start line.

text str

Text of the current statement/expression.

endColumn Number

One-based end column.

endLine Number

One-based end line.

procedureId String

Name of the active procedure, empty if in a top-level script.

startColumn Number

One-based start column.

startLine Number

One-based start line.

text String

Text of the current statement/expression.

ScriptStatisticsResponse

EvaluationKind string

Whether this child job was a statement or expression.

StackFrames 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 string

Whether this child job was a statement or expression.

StackFrames []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 String

Whether this child job was a statement or expression.

stackFrames 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 string

Whether this child job was a statement or expression.

stackFrames 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 str

Whether this child job was a statement or expression.

stack_frames 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 String

Whether this child job was a statement or expression.

stackFrames 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

IndexUnusedReason 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 string

Specifies index usage mode for the query.

IndexUnusedReason []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 string

Specifies index usage mode for the query.

indexUnusedReason 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 String

Specifies index usage mode for the query.

indexUnusedReason 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 string

Specifies index usage mode for the query.

index_unused_reason 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 str

Specifies index usage mode for the query.

indexUnusedReason 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 String

Specifies index usage mode for the query.

SessionInfoResponse

SessionId string

// [Preview] Id of the session.

SessionId string

// [Preview] Id of the session.

sessionId String

// [Preview] Id of the session.

sessionId string

// [Preview] Id of the session.

session_id str

// [Preview] Id of the session.

sessionId String

// [Preview] Id of the session.

SparkLoggingInfoResponse

ProjectId string

Project ID used for logging

ResourceType string

Resource type used for logging

ProjectId string

Project ID used for logging

ResourceType string

Resource type used for logging

projectId String

Project ID used for logging

resourceType String

Resource type used for logging

projectId string

Project ID used for logging

resourceType string

Resource type used for logging

project_id str

Project ID used for logging

resource_type str

Resource type used for logging

projectId String

Project ID used for logging

resourceType String

Resource type used for logging

SparkStatisticsResponse

Endpoints Dictionary<string, string>

Endpoints generated for the Spark job.

LoggingInfo Pulumi.GoogleNative.BigQuery.V2.Inputs.SparkLoggingInfoResponse

Logging info is used to generate a link to Cloud Logging.

SparkJobId string

Spark job id if a Spark job is created successfully.

SparkJobLocation string

Location where the Spark job is executed.

Endpoints map[string]string

Endpoints generated for the Spark job.

LoggingInfo SparkLoggingInfoResponse

Logging info is used to generate a link to Cloud Logging.

SparkJobId string

Spark job id if a Spark job is created successfully.

SparkJobLocation string

Location where the Spark job is executed.

endpoints Map<String,String>

Endpoints generated for the Spark job.

loggingInfo SparkLoggingInfoResponse

Logging info is used to generate a link to Cloud Logging.

sparkJobId String

Spark job id if a Spark job is created successfully.

sparkJobLocation String

Location where the Spark job is executed.

endpoints {[key: string]: string}

Endpoints generated for the Spark job.

loggingInfo SparkLoggingInfoResponse

Logging info is used to generate a link to Cloud Logging.

sparkJobId string

Spark job id if a Spark job is created successfully.

sparkJobLocation string

Location where the Spark job is executed.

endpoints Mapping[str, str]

Endpoints generated for the Spark job.

logging_info SparkLoggingInfoResponse

Logging info is used to generate a link to Cloud Logging.

spark_job_id str

Spark job id if a Spark job is created successfully.

spark_job_location str

Location where the Spark job is executed.

endpoints Map<String>

Endpoints generated for the Spark job.

loggingInfo Property Map

Logging info is used to generate a link to Cloud Logging.

sparkJobId String

Spark job id if a Spark job is created successfully.

sparkJobLocation String

Location where the Spark job is executed.

TableFieldSchemaCategoriesResponse

Names List<string>

A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

Names []string

A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

names List<String>

A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

names string[]

A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

names Sequence[str]

A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

names List<String>

A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

TableFieldSchemaPolicyTagsResponse

Names 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 []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 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 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 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 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.

TableFieldSchemaResponse

Categories Pulumi.GoogleNative.BigQuery.V2.Inputs.TableFieldSchemaCategoriesResponse

[Optional] The categories attached to this field, used for field-level access control.

Collation string

Optional. Collation specification of the field. It only can be set on string type field.

DefaultValueExpression 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 string

[Optional] The field description. The maximum length is 1,024 characters.

Fields List<Pulumi.GoogleNative.BigQuery.V2.Inputs.TableFieldSchemaResponse>

[Optional] Describes the nested schema fields if the type property is set to RECORD.

MaxLength 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 string

[Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

Name 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 Pulumi.GoogleNative.BigQuery.V2.Inputs.TableFieldSchemaPolicyTagsResponse
Precision 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.

Scale string

[Optional] See documentation for precision.

Type 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 TableFieldSchemaCategoriesResponse

[Optional] The categories attached to this field, used for field-level access control.

Collation string

Optional. Collation specification of the field. It only can be set on string type field.

DefaultValueExpression 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 string

[Optional] The field description. The maximum length is 1,024 characters.

Fields []TableFieldSchemaResponse

[Optional] Describes the nested schema fields if the type property is set to RECORD.

MaxLength 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 string

[Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

Name 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 TableFieldSchemaPolicyTagsResponse
Precision 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.

Scale string

[Optional] See documentation for precision.

Type 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 TableFieldSchemaCategoriesResponse

[Optional] The categories attached to this field, used for field-level access control.

collation String

Optional. Collation specification of the field. It only can be set on string type field.

defaultValueExpression 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 String

[Optional] The field description. The maximum length is 1,024 characters.

fields List<TableFieldSchemaResponse>

[Optional] Describes the nested schema fields if the type property is set to RECORD.

maxLength 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 String

[Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

name 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 TableFieldSchemaPolicyTagsResponse
precision 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.

scale String

[Optional] See documentation for precision.

type 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 TableFieldSchemaCategoriesResponse

[Optional] The categories attached to this field, used for field-level access control.

collation string

Optional. Collation specification of the field. It only can be set on string type field.

defaultValueExpression 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 string

[Optional] The field description. The maximum length is 1,024 characters.

fields TableFieldSchemaResponse[]

[Optional] Describes the nested schema fields if the type property is set to RECORD.

maxLength 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 string

[Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

name 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 TableFieldSchemaPolicyTagsResponse
precision 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.

scale string

[Optional] See documentation for precision.

type 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 TableFieldSchemaCategoriesResponse

[Optional] The categories attached to this field, used for field-level access control.

collation str

Optional. Collation specification of the field. It only can be set on string type field.

default_value_expression 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 str

[Optional] The field description. The maximum length is 1,024 characters.

fields Sequence[TableFieldSchemaResponse]

[Optional] Describes the nested schema fields if the type property is set to RECORD.

max_length 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 str

[Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

name 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 TableFieldSchemaPolicyTagsResponse
precision 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.

scale str

[Optional] See documentation for precision.

type 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 Property Map

[Optional] The categories attached to this field, used for field-level access control.

collation String

Optional. Collation specification of the field. It only can be set on string type field.

defaultValueExpression 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 String

[Optional] The field description. The maximum length is 1,024 characters.

fields List<Property Map>

[Optional] Describes the nested schema fields if the type property is set to RECORD.

maxLength 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 String

[Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

name 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 Property Map
precision 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.

scale String

[Optional] See documentation for precision.

type 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 string

[Required] The ID of the dataset containing this table.

Project string

[Required] The ID of the project containing this table.

TableId 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 string

[Required] The ID of the dataset containing this table.

Project string

[Required] The ID of the project containing this table.

TableId 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 String

[Required] The ID of the dataset containing this table.

project String

[Required] The ID of the project containing this table.

tableId 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 string

[Required] The ID of the dataset containing this table.

project string

[Required] The ID of the project containing this table.

tableId 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 str

[Required] The ID of the dataset containing this table.

project str

[Required] The ID of the project containing this table.

table_id 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 String

[Required] The ID of the dataset containing this table.

project String

[Required] The ID of the project containing this table.

tableId 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 []TableFieldSchemaResponse

Describes the fields in a table.

fields List<TableFieldSchemaResponse>

Describes the fields in a table.

fields TableFieldSchemaResponse[]

Describes the fields in a table.

fields Sequence[TableFieldSchemaResponse]

Describes the fields in a table.

fields List<Property Map>

Describes the fields in a table.

TimePartitioningResponse

ExpirationMs 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 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 bool
Type 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 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 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 bool
Type 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 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 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 Boolean
type 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 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 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 boolean
type 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 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 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 bool
type 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 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 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 Boolean
type 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 string

// [Alpha] Id of the transaction.

TransactionId string

// [Alpha] Id of the transaction.

transactionId String

// [Alpha] Id of the transaction.

transactionId string

// [Alpha] Id of the transaction.

transaction_id str

// [Alpha] Id of the transaction.

transactionId String

// [Alpha] Id of the transaction.

UserDefinedFunctionResourceResponse

InlineCode 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 string

[Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

InlineCode 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 string

[Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

inlineCode 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 String

[Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

inlineCode 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 string

[Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

inline_code 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 str

[Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

inlineCode 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 String

[Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0