Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.bigquery/v2.Job
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Starts a new asynchronous job. Requires the Can View project role. Auto-naming is currently not supported for this resource.
Create Job Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Job(name: string, args?: JobArgs, opts?: CustomResourceOptions);
@overload
def Job(resource_name: str,
args: Optional[JobArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Job(resource_name: str,
opts: Optional[ResourceOptions] = None,
configuration: Optional[JobConfigurationArgs] = None,
job_reference: Optional[JobReferenceArgs] = None,
project: Optional[str] = None,
source: Optional[Union[pulumi.Asset, pulumi.Archive]] = None)
func NewJob(ctx *Context, name string, args *JobArgs, opts ...ResourceOption) (*Job, error)
public Job(string name, JobArgs? args = null, CustomResourceOptions? opts = null)
type: google-native:bigquery/v2:Job
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args JobArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args JobArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args JobArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args JobArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. JobArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var google_nativeJobResource = new GoogleNative.BigQuery.V2.Job("google-nativeJobResource", new()
{
Configuration = new GoogleNative.BigQuery.V2.Inputs.JobConfigurationArgs
{
Copy = new GoogleNative.BigQuery.V2.Inputs.JobConfigurationTableCopyArgs
{
CreateDisposition = "string",
DestinationEncryptionConfiguration = new GoogleNative.BigQuery.V2.Inputs.EncryptionConfigurationArgs
{
KmsKeyName = "string",
},
DestinationExpirationTime = "any",
DestinationTable = new GoogleNative.BigQuery.V2.Inputs.TableReferenceArgs
{
DatasetId = "string",
Project = "string",
TableId = "string",
},
OperationType = "string",
SourceTable = new GoogleNative.BigQuery.V2.Inputs.TableReferenceArgs
{
DatasetId = "string",
Project = "string",
TableId = "string",
},
SourceTables = new[]
{
new GoogleNative.BigQuery.V2.Inputs.TableReferenceArgs
{
DatasetId = "string",
Project = "string",
TableId = "string",
},
},
WriteDisposition = "string",
},
DryRun = false,
Extract = new GoogleNative.BigQuery.V2.Inputs.JobConfigurationExtractArgs
{
Compression = "string",
DestinationFormat = "string",
DestinationUri = "string",
DestinationUris = new[]
{
"string",
},
FieldDelimiter = "string",
PrintHeader = false,
SourceModel = new GoogleNative.BigQuery.V2.Inputs.ModelReferenceArgs
{
DatasetId = "string",
ModelId = "string",
Project = "string",
},
SourceTable = new GoogleNative.BigQuery.V2.Inputs.TableReferenceArgs
{
DatasetId = "string",
Project = "string",
TableId = "string",
},
UseAvroLogicalTypes = false,
},
JobTimeoutMs = "string",
Labels =
{
{ "string", "string" },
},
Load = new GoogleNative.BigQuery.V2.Inputs.JobConfigurationLoadArgs
{
AllowJaggedRows = false,
AllowQuotedNewlines = false,
Autodetect = false,
Clustering = new GoogleNative.BigQuery.V2.Inputs.ClusteringArgs
{
Fields = new[]
{
"string",
},
},
ConnectionProperties = new[]
{
new GoogleNative.BigQuery.V2.Inputs.ConnectionPropertyArgs
{
Key = "string",
Value = "string",
},
},
CreateDisposition = "string",
CreateSession = false,
DecimalTargetTypes = new[]
{
"string",
},
DestinationEncryptionConfiguration = new GoogleNative.BigQuery.V2.Inputs.EncryptionConfigurationArgs
{
KmsKeyName = "string",
},
DestinationTable = new GoogleNative.BigQuery.V2.Inputs.TableReferenceArgs
{
DatasetId = "string",
Project = "string",
TableId = "string",
},
DestinationTableProperties = new GoogleNative.BigQuery.V2.Inputs.DestinationTablePropertiesArgs
{
Description = "string",
ExpirationTime = "string",
FriendlyName = "string",
Labels =
{
{ "string", "string" },
},
},
Encoding = "string",
FieldDelimiter = "string",
FileSetSpecType = "string",
HivePartitioningOptions = new GoogleNative.BigQuery.V2.Inputs.HivePartitioningOptionsArgs
{
Mode = "string",
RequirePartitionFilter = false,
SourceUriPrefix = "string",
},
IgnoreUnknownValues = false,
JsonExtension = "string",
MaxBadRecords = 0,
NullMarker = "string",
ParquetOptions = new GoogleNative.BigQuery.V2.Inputs.ParquetOptionsArgs
{
EnableListInference = false,
EnumAsString = false,
},
PreserveAsciiControlCharacters = false,
ProjectionFields = new[]
{
"string",
},
Quote = "string",
RangePartitioning = new GoogleNative.BigQuery.V2.Inputs.RangePartitioningArgs
{
Field = "string",
Range = new GoogleNative.BigQuery.V2.Inputs.RangePartitioningRangeArgs
{
End = "string",
Interval = "string",
Start = "string",
},
},
ReferenceFileSchemaUri = "string",
Schema = new GoogleNative.BigQuery.V2.Inputs.TableSchemaArgs
{
Fields = new[]
{
new GoogleNative.BigQuery.V2.Inputs.TableFieldSchemaArgs
{
Categories = new GoogleNative.BigQuery.V2.Inputs.TableFieldSchemaCategoriesArgs
{
Names = new[]
{
"string",
},
},
Collation = "string",
DefaultValueExpression = "string",
Description = "string",
Fields = new[]
{
tableFieldSchema,
},
MaxLength = "string",
Mode = "string",
Name = "string",
PolicyTags = new GoogleNative.BigQuery.V2.Inputs.TableFieldSchemaPolicyTagsArgs
{
Names = new[]
{
"string",
},
},
Precision = "string",
RangeElementType = new GoogleNative.BigQuery.V2.Inputs.TableFieldSchemaRangeElementTypeArgs
{
Type = "string",
},
RoundingMode = "string",
Scale = "string",
Type = "string",
},
},
},
SchemaUpdateOptions = new[]
{
"string",
},
SkipLeadingRows = 0,
SourceFormat = "string",
SourceUris = new[]
{
"string",
},
TimePartitioning = new GoogleNative.BigQuery.V2.Inputs.TimePartitioningArgs
{
ExpirationMs = "string",
Field = "string",
RequirePartitionFilter = false,
Type = "string",
},
UseAvroLogicalTypes = false,
WriteDisposition = "string",
},
Query = new GoogleNative.BigQuery.V2.Inputs.JobConfigurationQueryArgs
{
AllowLargeResults = false,
Clustering = new GoogleNative.BigQuery.V2.Inputs.ClusteringArgs
{
Fields = new[]
{
"string",
},
},
ConnectionProperties = new[]
{
new GoogleNative.BigQuery.V2.Inputs.ConnectionPropertyArgs
{
Key = "string",
Value = "string",
},
},
Continuous = false,
CreateDisposition = "string",
CreateSession = false,
DefaultDataset = new GoogleNative.BigQuery.V2.Inputs.DatasetReferenceArgs
{
DatasetId = "string",
Project = "string",
},
DestinationEncryptionConfiguration = new GoogleNative.BigQuery.V2.Inputs.EncryptionConfigurationArgs
{
KmsKeyName = "string",
},
DestinationTable = new GoogleNative.BigQuery.V2.Inputs.TableReferenceArgs
{
DatasetId = "string",
Project = "string",
TableId = "string",
},
FlattenResults = false,
MaximumBillingTier = 0,
MaximumBytesBilled = "string",
ParameterMode = "string",
Priority = "string",
Query = "string",
QueryParameters = new[]
{
new GoogleNative.BigQuery.V2.Inputs.QueryParameterArgs
{
Name = "string",
ParameterType = new GoogleNative.BigQuery.V2.Inputs.QueryParameterTypeArgs
{
ArrayType = queryParameterType,
StructTypes = new[]
{
new GoogleNative.BigQuery.V2.Inputs.QueryParameterTypeStructTypesItemArgs
{
Description = "string",
Name = "string",
Type = queryParameterType,
},
},
Type = "string",
},
ParameterValue = new GoogleNative.BigQuery.V2.Inputs.QueryParameterValueArgs
{
ArrayValues = new[]
{
queryParameterValue,
},
StructValues =
{
{ "string", "string" },
},
Value = "string",
},
},
},
RangePartitioning = new GoogleNative.BigQuery.V2.Inputs.RangePartitioningArgs
{
Field = "string",
Range = new GoogleNative.BigQuery.V2.Inputs.RangePartitioningRangeArgs
{
End = "string",
Interval = "string",
Start = "string",
},
},
SchemaUpdateOptions = new[]
{
"string",
},
TableDefinitions =
{
{ "string", "string" },
},
TimePartitioning = new GoogleNative.BigQuery.V2.Inputs.TimePartitioningArgs
{
ExpirationMs = "string",
Field = "string",
RequirePartitionFilter = false,
Type = "string",
},
UseLegacySql = false,
UseQueryCache = false,
UserDefinedFunctionResources = new[]
{
new GoogleNative.BigQuery.V2.Inputs.UserDefinedFunctionResourceArgs
{
InlineCode = "string",
ResourceUri = "string",
},
},
WriteDisposition = "string",
},
},
JobReference = new GoogleNative.BigQuery.V2.Inputs.JobReferenceArgs
{
JobId = "string",
Location = "string",
Project = "string",
},
Project = "string",
Source = new StringAsset("content"),
});
example, err := bigquery.NewJob(ctx, "google-nativeJobResource", &bigquery.JobArgs{
Configuration: &bigquery.JobConfigurationArgs{
Copy: &bigquery.JobConfigurationTableCopyArgs{
CreateDisposition: pulumi.String("string"),
DestinationEncryptionConfiguration: &bigquery.EncryptionConfigurationArgs{
KmsKeyName: pulumi.String("string"),
},
DestinationExpirationTime: pulumi.Any("any"),
DestinationTable: &bigquery.TableReferenceArgs{
DatasetId: pulumi.String("string"),
Project: pulumi.String("string"),
TableId: pulumi.String("string"),
},
OperationType: pulumi.String("string"),
SourceTable: &bigquery.TableReferenceArgs{
DatasetId: pulumi.String("string"),
Project: pulumi.String("string"),
TableId: pulumi.String("string"),
},
SourceTables: bigquery.TableReferenceArray{
&bigquery.TableReferenceArgs{
DatasetId: pulumi.String("string"),
Project: pulumi.String("string"),
TableId: pulumi.String("string"),
},
},
WriteDisposition: pulumi.String("string"),
},
DryRun: pulumi.Bool(false),
Extract: &bigquery.JobConfigurationExtractArgs{
Compression: pulumi.String("string"),
DestinationFormat: pulumi.String("string"),
DestinationUri: pulumi.String("string"),
DestinationUris: pulumi.StringArray{
pulumi.String("string"),
},
FieldDelimiter: pulumi.String("string"),
PrintHeader: pulumi.Bool(false),
SourceModel: &bigquery.ModelReferenceArgs{
DatasetId: pulumi.String("string"),
ModelId: pulumi.String("string"),
Project: pulumi.String("string"),
},
SourceTable: &bigquery.TableReferenceArgs{
DatasetId: pulumi.String("string"),
Project: pulumi.String("string"),
TableId: pulumi.String("string"),
},
UseAvroLogicalTypes: pulumi.Bool(false),
},
JobTimeoutMs: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Load: &bigquery.JobConfigurationLoadArgs{
AllowJaggedRows: pulumi.Bool(false),
AllowQuotedNewlines: pulumi.Bool(false),
Autodetect: pulumi.Bool(false),
Clustering: &bigquery.ClusteringArgs{
Fields: pulumi.StringArray{
pulumi.String("string"),
},
},
ConnectionProperties: bigquery.ConnectionPropertyArray{
&bigquery.ConnectionPropertyArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
CreateDisposition: pulumi.String("string"),
CreateSession: pulumi.Bool(false),
DecimalTargetTypes: pulumi.StringArray{
pulumi.String("string"),
},
DestinationEncryptionConfiguration: &bigquery.EncryptionConfigurationArgs{
KmsKeyName: pulumi.String("string"),
},
DestinationTable: &bigquery.TableReferenceArgs{
DatasetId: pulumi.String("string"),
Project: pulumi.String("string"),
TableId: pulumi.String("string"),
},
DestinationTableProperties: &bigquery.DestinationTablePropertiesArgs{
Description: pulumi.String("string"),
ExpirationTime: pulumi.String("string"),
FriendlyName: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
},
Encoding: pulumi.String("string"),
FieldDelimiter: pulumi.String("string"),
FileSetSpecType: pulumi.String("string"),
HivePartitioningOptions: &bigquery.HivePartitioningOptionsArgs{
Mode: pulumi.String("string"),
RequirePartitionFilter: pulumi.Bool(false),
SourceUriPrefix: pulumi.String("string"),
},
IgnoreUnknownValues: pulumi.Bool(false),
JsonExtension: pulumi.String("string"),
MaxBadRecords: pulumi.Int(0),
NullMarker: pulumi.String("string"),
ParquetOptions: &bigquery.ParquetOptionsArgs{
EnableListInference: pulumi.Bool(false),
EnumAsString: pulumi.Bool(false),
},
PreserveAsciiControlCharacters: pulumi.Bool(false),
ProjectionFields: pulumi.StringArray{
pulumi.String("string"),
},
Quote: pulumi.String("string"),
RangePartitioning: &bigquery.RangePartitioningArgs{
Field: pulumi.String("string"),
Range: &bigquery.RangePartitioningRangeArgs{
End: pulumi.String("string"),
Interval: pulumi.String("string"),
Start: pulumi.String("string"),
},
},
ReferenceFileSchemaUri: pulumi.String("string"),
Schema: &bigquery.TableSchemaArgs{
Fields: bigquery.TableFieldSchemaArray{
&bigquery.TableFieldSchemaArgs{
Categories: &bigquery.TableFieldSchemaCategoriesArgs{
Names: pulumi.StringArray{
pulumi.String("string"),
},
},
Collation: pulumi.String("string"),
DefaultValueExpression: pulumi.String("string"),
Description: pulumi.String("string"),
Fields: bigquery.TableFieldSchemaArray{
tableFieldSchema,
},
MaxLength: pulumi.String("string"),
Mode: pulumi.String("string"),
Name: pulumi.String("string"),
PolicyTags: &bigquery.TableFieldSchemaPolicyTagsArgs{
Names: pulumi.StringArray{
pulumi.String("string"),
},
},
Precision: pulumi.String("string"),
RangeElementType: &bigquery.TableFieldSchemaRangeElementTypeArgs{
Type: pulumi.String("string"),
},
RoundingMode: pulumi.String("string"),
Scale: pulumi.String("string"),
Type: pulumi.String("string"),
},
},
},
SchemaUpdateOptions: pulumi.StringArray{
pulumi.String("string"),
},
SkipLeadingRows: pulumi.Int(0),
SourceFormat: pulumi.String("string"),
SourceUris: pulumi.StringArray{
pulumi.String("string"),
},
TimePartitioning: &bigquery.TimePartitioningArgs{
ExpirationMs: pulumi.String("string"),
Field: pulumi.String("string"),
RequirePartitionFilter: pulumi.Bool(false),
Type: pulumi.String("string"),
},
UseAvroLogicalTypes: pulumi.Bool(false),
WriteDisposition: pulumi.String("string"),
},
Query: &bigquery.JobConfigurationQueryArgs{
AllowLargeResults: pulumi.Bool(false),
Clustering: &bigquery.ClusteringArgs{
Fields: pulumi.StringArray{
pulumi.String("string"),
},
},
ConnectionProperties: bigquery.ConnectionPropertyArray{
&bigquery.ConnectionPropertyArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
Continuous: pulumi.Bool(false),
CreateDisposition: pulumi.String("string"),
CreateSession: pulumi.Bool(false),
DefaultDataset: &bigquery.DatasetReferenceArgs{
DatasetId: pulumi.String("string"),
Project: pulumi.String("string"),
},
DestinationEncryptionConfiguration: &bigquery.EncryptionConfigurationArgs{
KmsKeyName: pulumi.String("string"),
},
DestinationTable: &bigquery.TableReferenceArgs{
DatasetId: pulumi.String("string"),
Project: pulumi.String("string"),
TableId: pulumi.String("string"),
},
FlattenResults: pulumi.Bool(false),
MaximumBillingTier: pulumi.Int(0),
MaximumBytesBilled: pulumi.String("string"),
ParameterMode: pulumi.String("string"),
Priority: pulumi.String("string"),
Query: pulumi.String("string"),
QueryParameters: bigquery.QueryParameterArray{
&bigquery.QueryParameterArgs{
Name: pulumi.String("string"),
ParameterType: &bigquery.QueryParameterTypeArgs{
ArrayType: pulumi.Any(queryParameterType),
StructTypes: bigquery.QueryParameterTypeStructTypesItemArray{
&bigquery.QueryParameterTypeStructTypesItemArgs{
Description: pulumi.String("string"),
Name: pulumi.String("string"),
Type: pulumi.Any(queryParameterType),
},
},
Type: pulumi.String("string"),
},
ParameterValue: &bigquery.QueryParameterValueArgs{
ArrayValues: bigquery.QueryParameterValueArray{
queryParameterValue,
},
StructValues: pulumi.StringMap{
"string": pulumi.String("string"),
},
Value: pulumi.String("string"),
},
},
},
RangePartitioning: &bigquery.RangePartitioningArgs{
Field: pulumi.String("string"),
Range: &bigquery.RangePartitioningRangeArgs{
End: pulumi.String("string"),
Interval: pulumi.String("string"),
Start: pulumi.String("string"),
},
},
SchemaUpdateOptions: pulumi.StringArray{
pulumi.String("string"),
},
TableDefinitions: pulumi.StringMap{
"string": pulumi.String("string"),
},
TimePartitioning: &bigquery.TimePartitioningArgs{
ExpirationMs: pulumi.String("string"),
Field: pulumi.String("string"),
RequirePartitionFilter: pulumi.Bool(false),
Type: pulumi.String("string"),
},
UseLegacySql: pulumi.Bool(false),
UseQueryCache: pulumi.Bool(false),
UserDefinedFunctionResources: bigquery.UserDefinedFunctionResourceArray{
&bigquery.UserDefinedFunctionResourceArgs{
InlineCode: pulumi.String("string"),
ResourceUri: pulumi.String("string"),
},
},
WriteDisposition: pulumi.String("string"),
},
},
JobReference: &bigquery.JobReferenceArgs{
JobId: pulumi.String("string"),
Location: pulumi.String("string"),
Project: pulumi.String("string"),
},
Project: pulumi.String("string"),
Source: pulumi.NewStringAsset("content"),
})
var google_nativeJobResource = new Job("google-nativeJobResource", JobArgs.builder()
.configuration(JobConfigurationArgs.builder()
.copy(JobConfigurationTableCopyArgs.builder()
.createDisposition("string")
.destinationEncryptionConfiguration(EncryptionConfigurationArgs.builder()
.kmsKeyName("string")
.build())
.destinationExpirationTime("any")
.destinationTable(TableReferenceArgs.builder()
.datasetId("string")
.project("string")
.tableId("string")
.build())
.operationType("string")
.sourceTable(TableReferenceArgs.builder()
.datasetId("string")
.project("string")
.tableId("string")
.build())
.sourceTables(TableReferenceArgs.builder()
.datasetId("string")
.project("string")
.tableId("string")
.build())
.writeDisposition("string")
.build())
.dryRun(false)
.extract(JobConfigurationExtractArgs.builder()
.compression("string")
.destinationFormat("string")
.destinationUri("string")
.destinationUris("string")
.fieldDelimiter("string")
.printHeader(false)
.sourceModel(ModelReferenceArgs.builder()
.datasetId("string")
.modelId("string")
.project("string")
.build())
.sourceTable(TableReferenceArgs.builder()
.datasetId("string")
.project("string")
.tableId("string")
.build())
.useAvroLogicalTypes(false)
.build())
.jobTimeoutMs("string")
.labels(Map.of("string", "string"))
.load(JobConfigurationLoadArgs.builder()
.allowJaggedRows(false)
.allowQuotedNewlines(false)
.autodetect(false)
.clustering(ClusteringArgs.builder()
.fields("string")
.build())
.connectionProperties(ConnectionPropertyArgs.builder()
.key("string")
.value("string")
.build())
.createDisposition("string")
.createSession(false)
.decimalTargetTypes("string")
.destinationEncryptionConfiguration(EncryptionConfigurationArgs.builder()
.kmsKeyName("string")
.build())
.destinationTable(TableReferenceArgs.builder()
.datasetId("string")
.project("string")
.tableId("string")
.build())
.destinationTableProperties(DestinationTablePropertiesArgs.builder()
.description("string")
.expirationTime("string")
.friendlyName("string")
.labels(Map.of("string", "string"))
.build())
.encoding("string")
.fieldDelimiter("string")
.fileSetSpecType("string")
.hivePartitioningOptions(HivePartitioningOptionsArgs.builder()
.mode("string")
.requirePartitionFilter(false)
.sourceUriPrefix("string")
.build())
.ignoreUnknownValues(false)
.jsonExtension("string")
.maxBadRecords(0)
.nullMarker("string")
.parquetOptions(ParquetOptionsArgs.builder()
.enableListInference(false)
.enumAsString(false)
.build())
.preserveAsciiControlCharacters(false)
.projectionFields("string")
.quote("string")
.rangePartitioning(RangePartitioningArgs.builder()
.field("string")
.range(RangePartitioningRangeArgs.builder()
.end("string")
.interval("string")
.start("string")
.build())
.build())
.referenceFileSchemaUri("string")
.schema(TableSchemaArgs.builder()
.fields(TableFieldSchemaArgs.builder()
.categories(TableFieldSchemaCategoriesArgs.builder()
.names("string")
.build())
.collation("string")
.defaultValueExpression("string")
.description("string")
.fields(tableFieldSchema)
.maxLength("string")
.mode("string")
.name("string")
.policyTags(TableFieldSchemaPolicyTagsArgs.builder()
.names("string")
.build())
.precision("string")
.rangeElementType(TableFieldSchemaRangeElementTypeArgs.builder()
.type("string")
.build())
.roundingMode("string")
.scale("string")
.type("string")
.build())
.build())
.schemaUpdateOptions("string")
.skipLeadingRows(0)
.sourceFormat("string")
.sourceUris("string")
.timePartitioning(TimePartitioningArgs.builder()
.expirationMs("string")
.field("string")
.requirePartitionFilter(false)
.type("string")
.build())
.useAvroLogicalTypes(false)
.writeDisposition("string")
.build())
.query(JobConfigurationQueryArgs.builder()
.allowLargeResults(false)
.clustering(ClusteringArgs.builder()
.fields("string")
.build())
.connectionProperties(ConnectionPropertyArgs.builder()
.key("string")
.value("string")
.build())
.continuous(false)
.createDisposition("string")
.createSession(false)
.defaultDataset(DatasetReferenceArgs.builder()
.datasetId("string")
.project("string")
.build())
.destinationEncryptionConfiguration(EncryptionConfigurationArgs.builder()
.kmsKeyName("string")
.build())
.destinationTable(TableReferenceArgs.builder()
.datasetId("string")
.project("string")
.tableId("string")
.build())
.flattenResults(false)
.maximumBillingTier(0)
.maximumBytesBilled("string")
.parameterMode("string")
.priority("string")
.query("string")
.queryParameters(QueryParameterArgs.builder()
.name("string")
.parameterType(QueryParameterTypeArgs.builder()
.arrayType(queryParameterType)
.structTypes(QueryParameterTypeStructTypesItemArgs.builder()
.description("string")
.name("string")
.type(queryParameterType)
.build())
.type("string")
.build())
.parameterValue(QueryParameterValueArgs.builder()
.arrayValues(queryParameterValue)
.structValues(Map.of("string", "string"))
.value("string")
.build())
.build())
.rangePartitioning(RangePartitioningArgs.builder()
.field("string")
.range(RangePartitioningRangeArgs.builder()
.end("string")
.interval("string")
.start("string")
.build())
.build())
.schemaUpdateOptions("string")
.tableDefinitions(Map.of("string", "string"))
.timePartitioning(TimePartitioningArgs.builder()
.expirationMs("string")
.field("string")
.requirePartitionFilter(false)
.type("string")
.build())
.useLegacySql(false)
.useQueryCache(false)
.userDefinedFunctionResources(UserDefinedFunctionResourceArgs.builder()
.inlineCode("string")
.resourceUri("string")
.build())
.writeDisposition("string")
.build())
.build())
.jobReference(JobReferenceArgs.builder()
.jobId("string")
.location("string")
.project("string")
.build())
.project("string")
.source(new StringAsset("content"))
.build());
google_native_job_resource = google_native.bigquery.v2.Job("google-nativeJobResource",
configuration={
"copy": {
"create_disposition": "string",
"destination_encryption_configuration": {
"kms_key_name": "string",
},
"destination_expiration_time": "any",
"destination_table": {
"dataset_id": "string",
"project": "string",
"table_id": "string",
},
"operation_type": "string",
"source_table": {
"dataset_id": "string",
"project": "string",
"table_id": "string",
},
"source_tables": [{
"dataset_id": "string",
"project": "string",
"table_id": "string",
}],
"write_disposition": "string",
},
"dry_run": False,
"extract": {
"compression": "string",
"destination_format": "string",
"destination_uri": "string",
"destination_uris": ["string"],
"field_delimiter": "string",
"print_header": False,
"source_model": {
"dataset_id": "string",
"model_id": "string",
"project": "string",
},
"source_table": {
"dataset_id": "string",
"project": "string",
"table_id": "string",
},
"use_avro_logical_types": False,
},
"job_timeout_ms": "string",
"labels": {
"string": "string",
},
"load": {
"allow_jagged_rows": False,
"allow_quoted_newlines": False,
"autodetect": False,
"clustering": {
"fields": ["string"],
},
"connection_properties": [{
"key": "string",
"value": "string",
}],
"create_disposition": "string",
"create_session": False,
"decimal_target_types": ["string"],
"destination_encryption_configuration": {
"kms_key_name": "string",
},
"destination_table": {
"dataset_id": "string",
"project": "string",
"table_id": "string",
},
"destination_table_properties": {
"description": "string",
"expiration_time": "string",
"friendly_name": "string",
"labels": {
"string": "string",
},
},
"encoding": "string",
"field_delimiter": "string",
"file_set_spec_type": "string",
"hive_partitioning_options": {
"mode": "string",
"require_partition_filter": False,
"source_uri_prefix": "string",
},
"ignore_unknown_values": False,
"json_extension": "string",
"max_bad_records": 0,
"null_marker": "string",
"parquet_options": {
"enable_list_inference": False,
"enum_as_string": False,
},
"preserve_ascii_control_characters": False,
"projection_fields": ["string"],
"quote": "string",
"range_partitioning": {
"field": "string",
"range": {
"end": "string",
"interval": "string",
"start": "string",
},
},
"reference_file_schema_uri": "string",
"schema": {
"fields": [{
"categories": {
"names": ["string"],
},
"collation": "string",
"default_value_expression": "string",
"description": "string",
"fields": [table_field_schema],
"max_length": "string",
"mode": "string",
"name": "string",
"policy_tags": {
"names": ["string"],
},
"precision": "string",
"range_element_type": {
"type": "string",
},
"rounding_mode": "string",
"scale": "string",
"type": "string",
}],
},
"schema_update_options": ["string"],
"skip_leading_rows": 0,
"source_format": "string",
"source_uris": ["string"],
"time_partitioning": {
"expiration_ms": "string",
"field": "string",
"require_partition_filter": False,
"type": "string",
},
"use_avro_logical_types": False,
"write_disposition": "string",
},
"query": {
"allow_large_results": False,
"clustering": {
"fields": ["string"],
},
"connection_properties": [{
"key": "string",
"value": "string",
}],
"continuous": False,
"create_disposition": "string",
"create_session": False,
"default_dataset": {
"dataset_id": "string",
"project": "string",
},
"destination_encryption_configuration": {
"kms_key_name": "string",
},
"destination_table": {
"dataset_id": "string",
"project": "string",
"table_id": "string",
},
"flatten_results": False,
"maximum_billing_tier": 0,
"maximum_bytes_billed": "string",
"parameter_mode": "string",
"priority": "string",
"query": "string",
"query_parameters": [{
"name": "string",
"parameter_type": {
"array_type": query_parameter_type,
"struct_types": [{
"description": "string",
"name": "string",
"type": query_parameter_type,
}],
"type": "string",
},
"parameter_value": {
"array_values": [query_parameter_value],
"struct_values": {
"string": "string",
},
"value": "string",
},
}],
"range_partitioning": {
"field": "string",
"range": {
"end": "string",
"interval": "string",
"start": "string",
},
},
"schema_update_options": ["string"],
"table_definitions": {
"string": "string",
},
"time_partitioning": {
"expiration_ms": "string",
"field": "string",
"require_partition_filter": False,
"type": "string",
},
"use_legacy_sql": False,
"use_query_cache": False,
"user_defined_function_resources": [{
"inline_code": "string",
"resource_uri": "string",
}],
"write_disposition": "string",
},
},
job_reference={
"job_id": "string",
"location": "string",
"project": "string",
},
project="string",
source=pulumi.StringAsset("content"))
const google_nativeJobResource = new google_native.bigquery.v2.Job("google-nativeJobResource", {
configuration: {
copy: {
createDisposition: "string",
destinationEncryptionConfiguration: {
kmsKeyName: "string",
},
destinationExpirationTime: "any",
destinationTable: {
datasetId: "string",
project: "string",
tableId: "string",
},
operationType: "string",
sourceTable: {
datasetId: "string",
project: "string",
tableId: "string",
},
sourceTables: [{
datasetId: "string",
project: "string",
tableId: "string",
}],
writeDisposition: "string",
},
dryRun: false,
extract: {
compression: "string",
destinationFormat: "string",
destinationUri: "string",
destinationUris: ["string"],
fieldDelimiter: "string",
printHeader: false,
sourceModel: {
datasetId: "string",
modelId: "string",
project: "string",
},
sourceTable: {
datasetId: "string",
project: "string",
tableId: "string",
},
useAvroLogicalTypes: false,
},
jobTimeoutMs: "string",
labels: {
string: "string",
},
load: {
allowJaggedRows: false,
allowQuotedNewlines: false,
autodetect: false,
clustering: {
fields: ["string"],
},
connectionProperties: [{
key: "string",
value: "string",
}],
createDisposition: "string",
createSession: false,
decimalTargetTypes: ["string"],
destinationEncryptionConfiguration: {
kmsKeyName: "string",
},
destinationTable: {
datasetId: "string",
project: "string",
tableId: "string",
},
destinationTableProperties: {
description: "string",
expirationTime: "string",
friendlyName: "string",
labels: {
string: "string",
},
},
encoding: "string",
fieldDelimiter: "string",
fileSetSpecType: "string",
hivePartitioningOptions: {
mode: "string",
requirePartitionFilter: false,
sourceUriPrefix: "string",
},
ignoreUnknownValues: false,
jsonExtension: "string",
maxBadRecords: 0,
nullMarker: "string",
parquetOptions: {
enableListInference: false,
enumAsString: false,
},
preserveAsciiControlCharacters: false,
projectionFields: ["string"],
quote: "string",
rangePartitioning: {
field: "string",
range: {
end: "string",
interval: "string",
start: "string",
},
},
referenceFileSchemaUri: "string",
schema: {
fields: [{
categories: {
names: ["string"],
},
collation: "string",
defaultValueExpression: "string",
description: "string",
fields: [tableFieldSchema],
maxLength: "string",
mode: "string",
name: "string",
policyTags: {
names: ["string"],
},
precision: "string",
rangeElementType: {
type: "string",
},
roundingMode: "string",
scale: "string",
type: "string",
}],
},
schemaUpdateOptions: ["string"],
skipLeadingRows: 0,
sourceFormat: "string",
sourceUris: ["string"],
timePartitioning: {
expirationMs: "string",
field: "string",
requirePartitionFilter: false,
type: "string",
},
useAvroLogicalTypes: false,
writeDisposition: "string",
},
query: {
allowLargeResults: false,
clustering: {
fields: ["string"],
},
connectionProperties: [{
key: "string",
value: "string",
}],
continuous: false,
createDisposition: "string",
createSession: false,
defaultDataset: {
datasetId: "string",
project: "string",
},
destinationEncryptionConfiguration: {
kmsKeyName: "string",
},
destinationTable: {
datasetId: "string",
project: "string",
tableId: "string",
},
flattenResults: false,
maximumBillingTier: 0,
maximumBytesBilled: "string",
parameterMode: "string",
priority: "string",
query: "string",
queryParameters: [{
name: "string",
parameterType: {
arrayType: queryParameterType,
structTypes: [{
description: "string",
name: "string",
type: queryParameterType,
}],
type: "string",
},
parameterValue: {
arrayValues: [queryParameterValue],
structValues: {
string: "string",
},
value: "string",
},
}],
rangePartitioning: {
field: "string",
range: {
end: "string",
interval: "string",
start: "string",
},
},
schemaUpdateOptions: ["string"],
tableDefinitions: {
string: "string",
},
timePartitioning: {
expirationMs: "string",
field: "string",
requirePartitionFilter: false,
type: "string",
},
useLegacySql: false,
useQueryCache: false,
userDefinedFunctionResources: [{
inlineCode: "string",
resourceUri: "string",
}],
writeDisposition: "string",
},
},
jobReference: {
jobId: "string",
location: "string",
project: "string",
},
project: "string",
source: new pulumi.asset.StringAsset("content"),
});
type: google-native:bigquery/v2:Job
properties:
configuration:
copy:
createDisposition: string
destinationEncryptionConfiguration:
kmsKeyName: string
destinationExpirationTime: any
destinationTable:
datasetId: string
project: string
tableId: string
operationType: string
sourceTable:
datasetId: string
project: string
tableId: string
sourceTables:
- datasetId: string
project: string
tableId: string
writeDisposition: string
dryRun: false
extract:
compression: string
destinationFormat: string
destinationUri: string
destinationUris:
- string
fieldDelimiter: string
printHeader: false
sourceModel:
datasetId: string
modelId: string
project: string
sourceTable:
datasetId: string
project: string
tableId: string
useAvroLogicalTypes: false
jobTimeoutMs: string
labels:
string: string
load:
allowJaggedRows: false
allowQuotedNewlines: false
autodetect: false
clustering:
fields:
- string
connectionProperties:
- key: string
value: string
createDisposition: string
createSession: false
decimalTargetTypes:
- string
destinationEncryptionConfiguration:
kmsKeyName: string
destinationTable:
datasetId: string
project: string
tableId: string
destinationTableProperties:
description: string
expirationTime: string
friendlyName: string
labels:
string: string
encoding: string
fieldDelimiter: string
fileSetSpecType: string
hivePartitioningOptions:
mode: string
requirePartitionFilter: false
sourceUriPrefix: string
ignoreUnknownValues: false
jsonExtension: string
maxBadRecords: 0
nullMarker: string
parquetOptions:
enableListInference: false
enumAsString: false
preserveAsciiControlCharacters: false
projectionFields:
- string
quote: string
rangePartitioning:
field: string
range:
end: string
interval: string
start: string
referenceFileSchemaUri: string
schema:
fields:
- categories:
names:
- string
collation: string
defaultValueExpression: string
description: string
fields:
- ${tableFieldSchema}
maxLength: string
mode: string
name: string
policyTags:
names:
- string
precision: string
rangeElementType:
type: string
roundingMode: string
scale: string
type: string
schemaUpdateOptions:
- string
skipLeadingRows: 0
sourceFormat: string
sourceUris:
- string
timePartitioning:
expirationMs: string
field: string
requirePartitionFilter: false
type: string
useAvroLogicalTypes: false
writeDisposition: string
query:
allowLargeResults: false
clustering:
fields:
- string
connectionProperties:
- key: string
value: string
continuous: false
createDisposition: string
createSession: false
defaultDataset:
datasetId: string
project: string
destinationEncryptionConfiguration:
kmsKeyName: string
destinationTable:
datasetId: string
project: string
tableId: string
flattenResults: false
maximumBillingTier: 0
maximumBytesBilled: string
parameterMode: string
priority: string
query: string
queryParameters:
- name: string
parameterType:
arrayType: ${queryParameterType}
structTypes:
- description: string
name: string
type: ${queryParameterType}
type: string
parameterValue:
arrayValues:
- ${queryParameterValue}
structValues:
string: string
value: string
rangePartitioning:
field: string
range:
end: string
interval: string
start: string
schemaUpdateOptions:
- string
tableDefinitions:
string: string
timePartitioning:
expirationMs: string
field: string
requirePartitionFilter: false
type: string
useLegacySql: false
useQueryCache: false
userDefinedFunctionResources:
- inlineCode: string
resourceUri: string
writeDisposition: string
jobReference:
jobId: string
location: string
project: string
project: string
source:
fn::StringAsset: content
Job Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Job resource accepts the following input properties:
- Configuration
Pulumi.
Google Native. Big Query. V2. Inputs. Job Configuration - [Required] Describes the job configuration.
- Job
Reference Pulumi.Google Native. Big Query. V2. Inputs. Job Reference - [Optional] Reference describing the unique-per-user name of the job.
- Project
Changes to this property will trigger replacement.
- Source
Asset
Or Archive
- Configuration
Job
Configuration Args - [Required] Describes the job configuration.
- Job
Reference JobReference Args - [Optional] Reference describing the unique-per-user name of the job.
- Project
Changes to this property will trigger replacement.
- Source
pulumi.
Asset Or Archive
- configuration
Job
Configuration - [Required] Describes the job configuration.
- job
Reference JobReference - [Optional] Reference describing the unique-per-user name of the job.
- project
Changes to this property will trigger replacement.
- source
Asset
Or Archive
- configuration
Job
Configuration - [Required] Describes the job configuration.
- job
Reference JobReference - [Optional] Reference describing the unique-per-user name of the job.
- project
Changes to this property will trigger replacement.
- source
pulumi.asset.
Asset | pulumi.asset. Archive
- configuration
Job
Configuration Args - [Required] Describes the job configuration.
- job_
reference JobReference Args - [Optional] Reference describing the unique-per-user name of the job.
- project
Changes to this property will trigger replacement.
- source
Union[pulumi.
Asset, pulumi. Archive]
- configuration Property Map
- [Required] Describes the job configuration.
- job
Reference Property Map - [Optional] Reference describing the unique-per-user name of the job.
- project
Changes to this property will trigger replacement.
- source Asset
Outputs
All input properties are implicitly available as output properties. Additionally, the Job resource produces the following output properties:
- Etag string
- A hash of this resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Job
Creation objectReason - If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
- Kind string
- The type of the resource.
- Self
Link string - A URL that can be used to access this resource again.
- Statistics
Pulumi.
Google Native. Big Query. V2. Outputs. Job Statistics Response - Information about the job, including starting time and ending time of the job.
- Status
Pulumi.
Google Native. Big Query. V2. Outputs. Job Status Response - The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
- User
Email string - Email address of the user who ran the job.
- Etag string
- A hash of this resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- Job
Creation interface{}Reason - If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
- Kind string
- The type of the resource.
- Self
Link string - A URL that can be used to access this resource again.
- Statistics
Job
Statistics Response - Information about the job, including starting time and ending time of the job.
- Status
Job
Status Response - The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
- User
Email string - Email address of the user who ran the job.
- etag String
- A hash of this resource.
- id String
- The provider-assigned unique ID for this managed resource.
- job
Creation ObjectReason - If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
- kind String
- The type of the resource.
- self
Link String - A URL that can be used to access this resource again.
- statistics
Job
Statistics Response - Information about the job, including starting time and ending time of the job.
- status
Job
Status Response - The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
- user
Email String - Email address of the user who ran the job.
- etag string
- A hash of this resource.
- id string
- The provider-assigned unique ID for this managed resource.
- job
Creation anyReason - If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
- kind string
- The type of the resource.
- self
Link string - A URL that can be used to access this resource again.
- statistics
Job
Statistics Response - Information about the job, including starting time and ending time of the job.
- status
Job
Status Response - The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
- user
Email string - Email address of the user who ran the job.
- etag str
- A hash of this resource.
- id str
- The provider-assigned unique ID for this managed resource.
- job_
creation_ Anyreason - If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
- kind str
- The type of the resource.
- self_
link str - A URL that can be used to access this resource again.
- statistics
Job
Statistics Response - Information about the job, including starting time and ending time of the job.
- status
Job
Status Response - 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.
- etag String
- A hash of this resource.
- id String
- The provider-assigned unique ID for this managed resource.
- job
Creation AnyReason - If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
- kind String
- The type of the resource.
- self
Link 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.
- user
Email String - Email address of the user who ran the job.
Supporting Types
BiEngineReasonResponse, BiEngineReasonResponseArgs
BiEngineStatisticsResponse, BiEngineStatisticsResponseArgs
- Acceleration
Mode This property is required. string - Specifies which mode of BI Engine acceleration was performed (if any).
- Bi
Engine Mode This property is required. string - Specifies which mode of BI Engine acceleration was performed (if any).
- Bi
Engine Reasons This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. Bi Engine Reason Response> - In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.
- Acceleration
Mode This property is required. string - Specifies which mode of BI Engine acceleration was performed (if any).
- Bi
Engine Mode This property is required. string - Specifies which mode of BI Engine acceleration was performed (if any).
- Bi
Engine Reasons This property is required. []BiEngine Reason Response - In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.
- acceleration
Mode This property is required. String - Specifies which mode of BI Engine acceleration was performed (if any).
- bi
Engine Mode This property is required. String - Specifies which mode of BI Engine acceleration was performed (if any).
- bi
Engine Reasons This property is required. List<BiEngine Reason Response> - In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.
- acceleration
Mode This property is required. string - Specifies which mode of BI Engine acceleration was performed (if any).
- bi
Engine Mode This property is required. string - Specifies which mode of BI Engine acceleration was performed (if any).
- bi
Engine Reasons This property is required. BiEngine Reason Response[] - In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.
- acceleration_
mode This property is required. str - Specifies which mode of BI Engine acceleration was performed (if any).
- bi_
engine_ mode This property is required. str - Specifies which mode of BI Engine acceleration was performed (if any).
- bi_
engine_ reasons This property is required. Sequence[BiEngine Reason Response] - In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.
- acceleration
Mode This property is required. String - Specifies which mode of BI Engine acceleration was performed (if any).
- bi
Engine Mode This property is required. String - Specifies which mode of BI Engine acceleration was performed (if any).
- bi
Engine Reasons This property is required. List<Property Map> - In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.
BigQueryModelTrainingResponse, BigQueryModelTrainingResponseArgs
- Current
Iteration This property is required. int - [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
- Expected
Total Iterations This property is required. string - [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
- Current
Iteration This property is required. int - [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
- Expected
Total Iterations This property is required. string - [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
- current
Iteration This property is required. Integer - [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
- expected
Total Iterations This property is required. String - [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
- current
Iteration This property is required. number - [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
- expected
Total Iterations This property is required. string - [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
- current_
iteration This property is required. int - [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
- expected_
total_ iterations This property is required. str - [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
- current
Iteration This property is required. Number - [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
- expected
Total Iterations This property is required. 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.
Clustering, ClusteringArgs
- 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.
ClusteringResponse, ClusteringResponseArgs
- Fields
This property is required. List<string> - [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
- Fields
This property is required. []string - [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
- fields
This property is required. List<String> - [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
- fields
This property is required. string[] - [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
- fields
This property is required. Sequence[str] - [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
- fields
This property is required. List<String> - [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
ConnectionProperty, ConnectionPropertyArgs
ConnectionPropertyResponse, ConnectionPropertyResponseArgs
DataMaskingStatisticsResponse, DataMaskingStatisticsResponseArgs
- Data
Masking Applied This property is required. bool - [Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where.
- Data
Masking Applied This property is required. bool - [Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where.
- data
Masking Applied This property is required. Boolean - [Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where.
- data
Masking Applied This property is required. boolean - [Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where.
- data_
masking_ applied This property is required. bool - [Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where.
- data
Masking Applied This property is required. Boolean - [Preview] Whether any accessed data was protected by data masking. The actual evaluation is done by accessStats.masked_field_count > 0. Since this is only used for the discovery_doc generation purpose, as long as the type (boolean) matches, client library can leverage this. The actual evaluation of the variable is done else-where.
DatasetReference, DatasetReferenceArgs
- 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.
DatasetReferenceResponse, DatasetReferenceResponseArgs
- Dataset
Id This property is required. string - [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- Project
This property is required. string - [Optional] The ID of the project containing this dataset.
- Dataset
Id This property is required. string - [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- Project
This property is required. string - [Optional] The ID of the project containing this dataset.
- dataset
Id This property is required. String - [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- project
This property is required. String - [Optional] The ID of the project containing this dataset.
- dataset
Id This property is required. string - [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- project
This property is required. string - [Optional] The ID of the project containing this dataset.
- dataset_
id This property is required. str - [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- project
This property is required. str - [Optional] The ID of the project containing this dataset.
- dataset
Id This property is required. String - [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- project
This property is required. String - [Optional] The ID of the project containing this dataset.
DestinationTableProperties, DestinationTablePropertiesArgs
- 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.
- Expiration
Time string - [Internal] This field is for Google internal use only.
- Friendly
Name 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.
- Expiration
Time string - [Internal] This field is for Google internal use only.
- Friendly
Name 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.
- expiration
Time String - [Internal] This field is for Google internal use only.
- friendly
Name 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.
- expiration
Time string - [Internal] This field is for Google internal use only.
- friendly
Name 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.
- expiration
Time String - [Internal] This field is for Google internal use only.
- friendly
Name 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.
DestinationTablePropertiesResponse, DestinationTablePropertiesResponseArgs
- Description
This property is required. string - [Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
- Expiration
Time This property is required. string - [Internal] This field is for Google internal use only.
- Friendly
Name This property is required. string - [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
- Labels
This property is required. Dictionary<string, string> - [Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
- Description
This property is required. string - [Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
- Expiration
Time This property is required. string - [Internal] This field is for Google internal use only.
- Friendly
Name This property is required. string - [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
- Labels
This property is required. map[string]string - [Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
- description
This property is required. String - [Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
- expiration
Time This property is required. String - [Internal] This field is for Google internal use only.
- friendly
Name This property is required. String - [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
- labels
This property is required. Map<String,String> - [Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
- description
This property is required. string - [Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
- expiration
Time This property is required. string - [Internal] This field is for Google internal use only.
- friendly
Name This property is required. string - [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
- labels
This property is required. {[key: string]: string} - [Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
- description
This property is required. str - [Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
- expiration_
time This property is required. str - [Internal] This field is for Google internal use only.
- friendly_
name This property is required. str - [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
- labels
This property is required. Mapping[str, str] - [Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
- description
This property is required. String - [Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
- expiration
Time This property is required. String - [Internal] This field is for Google internal use only.
- friendly
Name This property is required. String - [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
- labels
This property is required. Map<String> - [Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
DmlStatisticsResponse, DmlStatisticsResponseArgs
- Deleted
Row Count This property is required. string - Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
- Inserted
Row Count This property is required. string - Number of inserted Rows. Populated by DML INSERT and MERGE statements.
- Updated
Row Count This property is required. string - Number of updated Rows. Populated by DML UPDATE and MERGE statements.
- Deleted
Row Count This property is required. string - Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
- Inserted
Row Count This property is required. string - Number of inserted Rows. Populated by DML INSERT and MERGE statements.
- Updated
Row Count This property is required. string - Number of updated Rows. Populated by DML UPDATE and MERGE statements.
- deleted
Row Count This property is required. String - Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
- inserted
Row Count This property is required. String - Number of inserted Rows. Populated by DML INSERT and MERGE statements.
- updated
Row Count This property is required. String - Number of updated Rows. Populated by DML UPDATE and MERGE statements.
- deleted
Row Count This property is required. string - Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
- inserted
Row Count This property is required. string - Number of inserted Rows. Populated by DML INSERT and MERGE statements.
- updated
Row Count This property is required. string - Number of updated Rows. Populated by DML UPDATE and MERGE statements.
- deleted_
row_ count This property is required. str - Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
- inserted_
row_ count This property is required. str - Number of inserted Rows. Populated by DML INSERT and MERGE statements.
- updated_
row_ count This property is required. str - Number of updated Rows. Populated by DML UPDATE and MERGE statements.
- deleted
Row Count This property is required. String - Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.
- inserted
Row Count This property is required. String - Number of inserted Rows. Populated by DML INSERT and MERGE statements.
- updated
Row Count This property is required. String - Number of updated Rows. Populated by DML UPDATE and MERGE statements.
EncryptionConfiguration, EncryptionConfigurationArgs
- Kms
Key stringName - 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 stringName - 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 StringName - 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 stringName - 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_ strname - 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 StringName - 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.
EncryptionConfigurationResponse, EncryptionConfigurationResponseArgs
- Kms
Key Name This property is required. string - Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
- Kms
Key Name This property is required. string - Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
- kms
Key Name This property is required. String - Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
- kms
Key Name This property is required. string - Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
- kms_
key_ name This property is required. str - Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
- kms
Key Name This property is required. String - Optional. Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
ErrorProtoResponse, ErrorProtoResponseArgs
- Debug
Info This property is required. string - Debugging information. This property is internal to Google and should not be used.
- Location
This property is required. string - Specifies where the error occurred, if present.
- Message
This property is required. string - A human-readable description of the error.
- Reason
This property is required. string - A short error code that summarizes the error.
- Debug
Info This property is required. string - Debugging information. This property is internal to Google and should not be used.
- Location
This property is required. string - Specifies where the error occurred, if present.
- Message
This property is required. string - A human-readable description of the error.
- Reason
This property is required. string - A short error code that summarizes the error.
- debug
Info This property is required. String - Debugging information. This property is internal to Google and should not be used.
- location
This property is required. String - Specifies where the error occurred, if present.
- message
This property is required. String - A human-readable description of the error.
- reason
This property is required. String - A short error code that summarizes the error.
- debug
Info This property is required. string - Debugging information. This property is internal to Google and should not be used.
- location
This property is required. string - Specifies where the error occurred, if present.
- message
This property is required. string - A human-readable description of the error.
- reason
This property is required. string - A short error code that summarizes the error.
- debug_
info This property is required. str - Debugging information. This property is internal to Google and should not be used.
- location
This property is required. str - Specifies where the error occurred, if present.
- message
This property is required. str - A human-readable description of the error.
- reason
This property is required. str - A short error code that summarizes the error.
- debug
Info This property is required. String - Debugging information. This property is internal to Google and should not be used.
- location
This property is required. String - Specifies where the error occurred, if present.
- message
This property is required. String - A human-readable description of the error.
- reason
This property is required. String - A short error code that summarizes the error.
ExplainQueryStageResponse, ExplainQueryStageResponseArgs
- Completed
Parallel Inputs This property is required. string - Number of parallel input segments completed.
- Compute
Ms Avg This property is required. string - Milliseconds the average shard spent on CPU-bound tasks.
- Compute
Ms Max This property is required. string - Milliseconds the slowest shard spent on CPU-bound tasks.
- Compute
Ratio Avg This property is required. double - Relative amount of time the average shard spent on CPU-bound tasks.
- Compute
Ratio Max This property is required. double - Relative amount of time the slowest shard spent on CPU-bound tasks.
- End
Ms This property is required. string - Stage end time represented as milliseconds since epoch.
- Input
Stages This property is required. List<string> - IDs for stages that are inputs to this stage.
- Name
This property is required. string - Human-readable name for stage.
- Parallel
Inputs This property is required. string - Number of parallel input segments to be processed.
- Read
Ms Avg This property is required. string - Milliseconds the average shard spent reading input.
- Read
Ms Max This property is required. string - Milliseconds the slowest shard spent reading input.
- Read
Ratio Avg This property is required. double - Relative amount of time the average shard spent reading input.
- Read
Ratio Max This property is required. double - Relative amount of time the slowest shard spent reading input.
- Records
Read This property is required. string - Number of records read into the stage.
- Records
Written This property is required. string - Number of records written by the stage.
- Shuffle
Output Bytes This property is required. string - Total number of bytes written to shuffle.
- Shuffle
Output Bytes Spilled This property is required. string - Total number of bytes written to shuffle and spilled to disk.
- Slot
Ms This property is required. string - Slot-milliseconds used by the stage.
- Start
Ms This property is required. string - Stage start time represented as milliseconds since epoch.
- Status
This property is required. string - Current status for the stage.
- Steps
This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. Explain Query Step Response> - List of operations within the stage in dependency order (approximately chronological).
- Wait
Ms Avg This property is required. string - Milliseconds the average shard spent waiting to be scheduled.
- Wait
Ms Max This property is required. string - Milliseconds the slowest shard spent waiting to be scheduled.
- Wait
Ratio Avg This property is required. double - Relative amount of time the average shard spent waiting to be scheduled.
- Wait
Ratio Max This property is required. double - Relative amount of time the slowest shard spent waiting to be scheduled.
- Write
Ms Avg This property is required. string - Milliseconds the average shard spent on writing output.
- Write
Ms Max This property is required. string - Milliseconds the slowest shard spent on writing output.
- Write
Ratio Avg This property is required. double - Relative amount of time the average shard spent on writing output.
- Write
Ratio Max This property is required. double - Relative amount of time the slowest shard spent on writing output.
- Completed
Parallel Inputs This property is required. string - Number of parallel input segments completed.
- Compute
Ms Avg This property is required. string - Milliseconds the average shard spent on CPU-bound tasks.
- Compute
Ms Max This property is required. string - Milliseconds the slowest shard spent on CPU-bound tasks.
- Compute
Ratio Avg This property is required. float64 - Relative amount of time the average shard spent on CPU-bound tasks.
- Compute
Ratio Max This property is required. float64 - Relative amount of time the slowest shard spent on CPU-bound tasks.
- End
Ms This property is required. string - Stage end time represented as milliseconds since epoch.
- Input
Stages This property is required. []string - IDs for stages that are inputs to this stage.
- Name
This property is required. string - Human-readable name for stage.
- Parallel
Inputs This property is required. string - Number of parallel input segments to be processed.
- Read
Ms Avg This property is required. string - Milliseconds the average shard spent reading input.
- Read
Ms Max This property is required. string - Milliseconds the slowest shard spent reading input.
- Read
Ratio Avg This property is required. float64 - Relative amount of time the average shard spent reading input.
- Read
Ratio Max This property is required. float64 - Relative amount of time the slowest shard spent reading input.
- Records
Read This property is required. string - Number of records read into the stage.
- Records
Written This property is required. string - Number of records written by the stage.
- Shuffle
Output Bytes This property is required. string - Total number of bytes written to shuffle.
- Shuffle
Output Bytes Spilled This property is required. string - Total number of bytes written to shuffle and spilled to disk.
- Slot
Ms This property is required. string - Slot-milliseconds used by the stage.
- Start
Ms This property is required. string - Stage start time represented as milliseconds since epoch.
- Status
This property is required. string - Current status for the stage.
- Steps
This property is required. []ExplainQuery Step Response - List of operations within the stage in dependency order (approximately chronological).
- Wait
Ms Avg This property is required. string - Milliseconds the average shard spent waiting to be scheduled.
- Wait
Ms Max This property is required. string - Milliseconds the slowest shard spent waiting to be scheduled.
- Wait
Ratio Avg This property is required. float64 - Relative amount of time the average shard spent waiting to be scheduled.
- Wait
Ratio Max This property is required. float64 - Relative amount of time the slowest shard spent waiting to be scheduled.
- Write
Ms Avg This property is required. string - Milliseconds the average shard spent on writing output.
- Write
Ms Max This property is required. string - Milliseconds the slowest shard spent on writing output.
- Write
Ratio Avg This property is required. float64 - Relative amount of time the average shard spent on writing output.
- Write
Ratio Max This property is required. float64 - Relative amount of time the slowest shard spent on writing output.
- completed
Parallel Inputs This property is required. String - Number of parallel input segments completed.
- compute
Ms Avg This property is required. String - Milliseconds the average shard spent on CPU-bound tasks.
- compute
Ms Max This property is required. String - Milliseconds the slowest shard spent on CPU-bound tasks.
- compute
Ratio Avg This property is required. Double - Relative amount of time the average shard spent on CPU-bound tasks.
- compute
Ratio Max This property is required. Double - Relative amount of time the slowest shard spent on CPU-bound tasks.
- end
Ms This property is required. String - Stage end time represented as milliseconds since epoch.
- input
Stages This property is required. List<String> - IDs for stages that are inputs to this stage.
- name
This property is required. String - Human-readable name for stage.
- parallel
Inputs This property is required. String - Number of parallel input segments to be processed.
- read
Ms Avg This property is required. String - Milliseconds the average shard spent reading input.
- read
Ms Max This property is required. String - Milliseconds the slowest shard spent reading input.
- read
Ratio Avg This property is required. Double - Relative amount of time the average shard spent reading input.
- read
Ratio Max This property is required. Double - Relative amount of time the slowest shard spent reading input.
- records
Read This property is required. String - Number of records read into the stage.
- records
Written This property is required. String - Number of records written by the stage.
- shuffle
Output Bytes This property is required. String - Total number of bytes written to shuffle.
- shuffle
Output Bytes Spilled This property is required. String - Total number of bytes written to shuffle and spilled to disk.
- slot
Ms This property is required. String - Slot-milliseconds used by the stage.
- start
Ms This property is required. String - Stage start time represented as milliseconds since epoch.
- status
This property is required. String - Current status for the stage.
- steps
This property is required. List<ExplainQuery Step Response> - List of operations within the stage in dependency order (approximately chronological).
- wait
Ms Avg This property is required. String - Milliseconds the average shard spent waiting to be scheduled.
- wait
Ms Max This property is required. String - Milliseconds the slowest shard spent waiting to be scheduled.
- wait
Ratio Avg This property is required. Double - Relative amount of time the average shard spent waiting to be scheduled.
- wait
Ratio Max This property is required. Double - Relative amount of time the slowest shard spent waiting to be scheduled.
- write
Ms Avg This property is required. String - Milliseconds the average shard spent on writing output.
- write
Ms Max This property is required. String - Milliseconds the slowest shard spent on writing output.
- write
Ratio Avg This property is required. Double - Relative amount of time the average shard spent on writing output.
- write
Ratio Max This property is required. Double - Relative amount of time the slowest shard spent on writing output.
- completed
Parallel Inputs This property is required. string - Number of parallel input segments completed.
- compute
Ms Avg This property is required. string - Milliseconds the average shard spent on CPU-bound tasks.
- compute
Ms Max This property is required. string - Milliseconds the slowest shard spent on CPU-bound tasks.
- compute
Ratio Avg This property is required. number - Relative amount of time the average shard spent on CPU-bound tasks.
- compute
Ratio Max This property is required. number - Relative amount of time the slowest shard spent on CPU-bound tasks.
- end
Ms This property is required. string - Stage end time represented as milliseconds since epoch.
- input
Stages This property is required. string[] - IDs for stages that are inputs to this stage.
- name
This property is required. string - Human-readable name for stage.
- parallel
Inputs This property is required. string - Number of parallel input segments to be processed.
- read
Ms Avg This property is required. string - Milliseconds the average shard spent reading input.
- read
Ms Max This property is required. string - Milliseconds the slowest shard spent reading input.
- read
Ratio Avg This property is required. number - Relative amount of time the average shard spent reading input.
- read
Ratio Max This property is required. number - Relative amount of time the slowest shard spent reading input.
- records
Read This property is required. string - Number of records read into the stage.
- records
Written This property is required. string - Number of records written by the stage.
- shuffle
Output Bytes This property is required. string - Total number of bytes written to shuffle.
- shuffle
Output Bytes Spilled This property is required. string - Total number of bytes written to shuffle and spilled to disk.
- slot
Ms This property is required. string - Slot-milliseconds used by the stage.
- start
Ms This property is required. string - Stage start time represented as milliseconds since epoch.
- status
This property is required. string - Current status for the stage.
- steps
This property is required. ExplainQuery Step Response[] - List of operations within the stage in dependency order (approximately chronological).
- wait
Ms Avg This property is required. string - Milliseconds the average shard spent waiting to be scheduled.
- wait
Ms Max This property is required. string - Milliseconds the slowest shard spent waiting to be scheduled.
- wait
Ratio Avg This property is required. number - Relative amount of time the average shard spent waiting to be scheduled.
- wait
Ratio Max This property is required. number - Relative amount of time the slowest shard spent waiting to be scheduled.
- write
Ms Avg This property is required. string - Milliseconds the average shard spent on writing output.
- write
Ms Max This property is required. string - Milliseconds the slowest shard spent on writing output.
- write
Ratio Avg This property is required. number - Relative amount of time the average shard spent on writing output.
- write
Ratio Max This property is required. number - Relative amount of time the slowest shard spent on writing output.
- completed_
parallel_ inputs This property is required. str - Number of parallel input segments completed.
- compute_
ms_ avg This property is required. str - Milliseconds the average shard spent on CPU-bound tasks.
- compute_
ms_ max This property is required. str - Milliseconds the slowest shard spent on CPU-bound tasks.
- compute_
ratio_ avg This property is required. float - Relative amount of time the average shard spent on CPU-bound tasks.
- compute_
ratio_ max This property is required. float - Relative amount of time the slowest shard spent on CPU-bound tasks.
- end_
ms This property is required. str - Stage end time represented as milliseconds since epoch.
- input_
stages This property is required. Sequence[str] - IDs for stages that are inputs to this stage.
- name
This property is required. str - Human-readable name for stage.
- parallel_
inputs This property is required. str - Number of parallel input segments to be processed.
- read_
ms_ avg This property is required. str - Milliseconds the average shard spent reading input.
- read_
ms_ max This property is required. str - Milliseconds the slowest shard spent reading input.
- read_
ratio_ avg This property is required. float - Relative amount of time the average shard spent reading input.
- read_
ratio_ max This property is required. float - Relative amount of time the slowest shard spent reading input.
- records_
read This property is required. str - Number of records read into the stage.
- records_
written This property is required. str - Number of records written by the stage.
- shuffle_
output_ bytes This property is required. str - Total number of bytes written to shuffle.
- shuffle_
output_ bytes_ spilled This property is required. str - Total number of bytes written to shuffle and spilled to disk.
- slot_
ms This property is required. str - Slot-milliseconds used by the stage.
- start_
ms This property is required. str - Stage start time represented as milliseconds since epoch.
- status
This property is required. str - Current status for the stage.
- steps
This property is required. Sequence[ExplainQuery Step Response] - List of operations within the stage in dependency order (approximately chronological).
- wait_
ms_ avg This property is required. str - Milliseconds the average shard spent waiting to be scheduled.
- wait_
ms_ max This property is required. str - Milliseconds the slowest shard spent waiting to be scheduled.
- wait_
ratio_ avg This property is required. float - Relative amount of time the average shard spent waiting to be scheduled.
- wait_
ratio_ max This property is required. float - Relative amount of time the slowest shard spent waiting to be scheduled.
- write_
ms_ avg This property is required. str - Milliseconds the average shard spent on writing output.
- write_
ms_ max This property is required. str - Milliseconds the slowest shard spent on writing output.
- write_
ratio_ avg This property is required. float - Relative amount of time the average shard spent on writing output.
- write_
ratio_ max This property is required. float - Relative amount of time the slowest shard spent on writing output.
- completed
Parallel Inputs This property is required. String - Number of parallel input segments completed.
- compute
Ms Avg This property is required. String - Milliseconds the average shard spent on CPU-bound tasks.
- compute
Ms Max This property is required. String - Milliseconds the slowest shard spent on CPU-bound tasks.
- compute
Ratio Avg This property is required. Number - Relative amount of time the average shard spent on CPU-bound tasks.
- compute
Ratio Max This property is required. Number - Relative amount of time the slowest shard spent on CPU-bound tasks.
- end
Ms This property is required. String - Stage end time represented as milliseconds since epoch.
- input
Stages This property is required. List<String> - IDs for stages that are inputs to this stage.
- name
This property is required. String - Human-readable name for stage.
- parallel
Inputs This property is required. String - Number of parallel input segments to be processed.
- read
Ms Avg This property is required. String - Milliseconds the average shard spent reading input.
- read
Ms Max This property is required. String - Milliseconds the slowest shard spent reading input.
- read
Ratio Avg This property is required. Number - Relative amount of time the average shard spent reading input.
- read
Ratio Max This property is required. Number - Relative amount of time the slowest shard spent reading input.
- records
Read This property is required. String - Number of records read into the stage.
- records
Written This property is required. String - Number of records written by the stage.
- shuffle
Output Bytes This property is required. String - Total number of bytes written to shuffle.
- shuffle
Output Bytes Spilled This property is required. String - Total number of bytes written to shuffle and spilled to disk.
- slot
Ms This property is required. String - Slot-milliseconds used by the stage.
- start
Ms This property is required. String - Stage start time represented as milliseconds since epoch.
- status
This property is required. String - Current status for the stage.
- steps
This property is required. List<Property Map> - List of operations within the stage in dependency order (approximately chronological).
- wait
Ms Avg This property is required. String - Milliseconds the average shard spent waiting to be scheduled.
- wait
Ms Max This property is required. String - Milliseconds the slowest shard spent waiting to be scheduled.
- wait
Ratio Avg This property is required. Number - Relative amount of time the average shard spent waiting to be scheduled.
- wait
Ratio Max This property is required. Number - Relative amount of time the slowest shard spent waiting to be scheduled.
- write
Ms Avg This property is required. String - Milliseconds the average shard spent on writing output.
- write
Ms Max This property is required. String - Milliseconds the slowest shard spent on writing output.
- write
Ratio Avg This property is required. Number - Relative amount of time the average shard spent on writing output.
- write
Ratio Max This property is required. Number - Relative amount of time the slowest shard spent on writing output.
ExplainQueryStepResponse, ExplainQueryStepResponseArgs
HivePartitioningOptions, HivePartitioningOptionsArgs
- 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.
- Require
Partition boolFilter - [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 stringPrefix - [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.
- Require
Partition boolFilter - [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 stringPrefix - [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.
- require
Partition BooleanFilter - [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 StringPrefix - [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.
- require
Partition booleanFilter - [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 stringPrefix - [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_ boolfilter - [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_ strprefix - [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.
- require
Partition BooleanFilter - [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 StringPrefix - [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).
HivePartitioningOptionsResponse, HivePartitioningOptionsResponseArgs
- Fields
This property is required. List<string> - For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.
- Mode
This property is required. string - [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
- Require
Partition Filter This property is required. bool - [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
- Source
Uri Prefix This property is required. string - [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
- Fields
This property is required. []string - For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.
- Mode
This property is required. string - [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
- Require
Partition Filter This property is required. bool - [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
- Source
Uri Prefix This property is required. string - [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
- fields
This property is required. List<String> - For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.
- mode
This property is required. String - [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
- require
Partition Filter This property is required. Boolean - [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
- source
Uri Prefix This property is required. String - [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
- fields
This property is required. string[] - For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.
- mode
This property is required. string - [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
- require
Partition Filter This property is required. boolean - [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
- source
Uri Prefix This property is required. string - [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
- fields
This property is required. Sequence[str] - For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.
- mode
This property is required. str - [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
- require_
partition_ filter This property is required. bool - [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
- source_
uri_ prefix This property is required. str - [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
- fields
This property is required. List<String> - For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.
- mode
This property is required. String - [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
- require
Partition Filter This property is required. Boolean - [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
- source
Uri Prefix This property is required. String - [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
IndexUnusedReasonResponse, IndexUnusedReasonResponseArgs
- Base
Table This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Table Reference Response - Specifies the base table involved in the reason that no search index was used.
- Code
This property is required. string - Specifies the high-level reason for the scenario when no search index was used.
- Index
Name This property is required. string - Specifies the name of the unused search index, if available.
- Message
This property is required. string - Free form human-readable reason for the scenario when no search index was used.
- Base
Table This property is required. TableReference Response - Specifies the base table involved in the reason that no search index was used.
- Code
This property is required. string - Specifies the high-level reason for the scenario when no search index was used.
- Index
Name This property is required. string - Specifies the name of the unused search index, if available.
- Message
This property is required. string - Free form human-readable reason for the scenario when no search index was used.
- base
Table This property is required. TableReference Response - Specifies the base table involved in the reason that no search index was used.
- code
This property is required. String - Specifies the high-level reason for the scenario when no search index was used.
- index
Name This property is required. String - Specifies the name of the unused search index, if available.
- message
This property is required. String - Free form human-readable reason for the scenario when no search index was used.
- base
Table This property is required. TableReference Response - Specifies the base table involved in the reason that no search index was used.
- code
This property is required. string - Specifies the high-level reason for the scenario when no search index was used.
- index
Name This property is required. string - Specifies the name of the unused search index, if available.
- message
This property is required. string - Free form human-readable reason for the scenario when no search index was used.
- base_
table This property is required. TableReference Response - Specifies the base table involved in the reason that no search index was used.
- code
This property is required. str - Specifies the high-level reason for the scenario when no search index was used.
- index_
name This property is required. str - Specifies the name of the unused search index, if available.
- message
This property is required. str - Free form human-readable reason for the scenario when no search index was used.
- base
Table This property is required. Property Map - Specifies the base table involved in the reason that no search index was used.
- code
This property is required. String - Specifies the high-level reason for the scenario when no search index was used.
- index
Name This property is required. String - Specifies the name of the unused search index, if available.
- message
This property is required. String - Free form human-readable reason for the scenario when no search index was used.
IterationResultResponse, IterationResultResponseArgs
- Duration
Ms This property is required. string - Time taken to run the iteration in milliseconds.
- Eval
Loss This property is required. double - Loss computed on the eval data at the end of iteration.
- Index
This property is required. int - Index of the iteration, 0 based.
- Learn
Rate This property is required. double - Learn rate used for this iteration.
- Training
Loss This property is required. double - Loss computed on the training data at the end of iteration.
- Duration
Ms This property is required. string - Time taken to run the iteration in milliseconds.
- Eval
Loss This property is required. float64 - Loss computed on the eval data at the end of iteration.
- Index
This property is required. int - Index of the iteration, 0 based.
- Learn
Rate This property is required. float64 - Learn rate used for this iteration.
- Training
Loss This property is required. float64 - Loss computed on the training data at the end of iteration.
- duration
Ms This property is required. String - Time taken to run the iteration in milliseconds.
- eval
Loss This property is required. Double - Loss computed on the eval data at the end of iteration.
- index
This property is required. Integer - Index of the iteration, 0 based.
- learn
Rate This property is required. Double - Learn rate used for this iteration.
- training
Loss This property is required. Double - Loss computed on the training data at the end of iteration.
- duration
Ms This property is required. string - Time taken to run the iteration in milliseconds.
- eval
Loss This property is required. number - Loss computed on the eval data at the end of iteration.
- index
This property is required. number - Index of the iteration, 0 based.
- learn
Rate This property is required. number - Learn rate used for this iteration.
- training
Loss This property is required. number - Loss computed on the training data at the end of iteration.
- duration_
ms This property is required. str - Time taken to run the iteration in milliseconds.
- eval_
loss This property is required. float - Loss computed on the eval data at the end of iteration.
- index
This property is required. int - Index of the iteration, 0 based.
- learn_
rate This property is required. float - Learn rate used for this iteration.
- training_
loss This property is required. float - Loss computed on the training data at the end of iteration.
- duration
Ms This property is required. String - Time taken to run the iteration in milliseconds.
- eval
Loss This property is required. Number - Loss computed on the eval data at the end of iteration.
- index
This property is required. Number - Index of the iteration, 0 based.
- learn
Rate This property is required. Number - Learn rate used for this iteration.
- training
Loss This property is required. Number - Loss computed on the training data at the end of iteration.
JobConfiguration, JobConfigurationArgs
- Copy
Pulumi.
Google Native. Big Query. V2. Inputs. Job Configuration Table Copy - [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
Pulumi.
Google Native. Big Query. V2. Inputs. Job Configuration Extract - [Pick one] Configures an extract job.
- Job
Timeout stringMs - [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- 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.
Google Native. Big Query. V2. Inputs. Job Configuration Load - [Pick one] Configures a load job.
- Query
Pulumi.
Google Native. Big Query. V2. Inputs. Job Configuration Query - [Pick one] Configures a query job.
- Copy
Job
Configuration Table Copy - [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
Job
Configuration Extract - [Pick one] Configures an extract job.
- Job
Timeout stringMs - [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- 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
Job
Configuration Load - [Pick one] Configures a load job.
- Query
Job
Configuration Query - [Pick one] Configures a query job.
- copy
Job
Configuration Table Copy - [Pick one] Copies a table.
- dry
Run 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
Job
Configuration Extract - [Pick one] Configures an extract job.
- job
Timeout StringMs - [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- 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
Job
Configuration Load - [Pick one] Configures a load job.
- query
Job
Configuration Query - [Pick one] Configures a query job.
- copy
Job
Configuration Table Copy - [Pick one] Copies a table.
- dry
Run 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
Job
Configuration Extract - [Pick one] Configures an extract job.
- job
Timeout stringMs - [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- 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
Job
Configuration Load - [Pick one] Configures a load job.
- query
Job
Configuration Query - [Pick one] Configures a query job.
- copy
Job
Configuration Table Copy - [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
Job
Configuration Extract - [Pick one] Configures an extract job.
- job_
timeout_ strms - [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- 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
Job
Configuration Load - [Pick one] Configures a load job.
- query
Job
Configuration Query - [Pick one] Configures a query job.
- copy Property Map
- [Pick one] Copies a table.
- dry
Run 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.
- job
Timeout StringMs - [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- 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.
JobConfigurationExtract, JobConfigurationExtractArgs
- 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.
- Destination
Format 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.
- Destination
Uri 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.
- Destination
Uris List<string> - [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- Field
Delimiter string - [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 Pulumi.Google Native. Big Query. V2. Inputs. Model Reference - A reference to the model being exported.
- Source
Table Pulumi.Google Native. Big Query. V2. Inputs. Table Reference - A reference to the table being exported.
- Use
Avro boolLogical Types - [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.
- Destination
Format 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.
- Destination
Uri 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.
- Destination
Uris []string - [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- Field
Delimiter string - [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 ModelReference - A reference to the model being exported.
- Source
Table TableReference - A reference to the table being exported.
- Use
Avro boolLogical Types - [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.
- destination
Format 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.
- destination
Uri 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.
- destination
Uris List<String> - [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- field
Delimiter String - [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
- print
Header Boolean - [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
- source
Model ModelReference - A reference to the model being exported.
- source
Table TableReference - A reference to the table being exported.
- use
Avro BooleanLogical Types - [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.
- destination
Format 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.
- destination
Uri 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.
- destination
Uris string[] - [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- field
Delimiter string - [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
- print
Header boolean - [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
- source
Model ModelReference - A reference to the model being exported.
- source
Table TableReference - A reference to the table being exported.
- use
Avro booleanLogical Types - [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 ModelReference - A reference to the model being exported.
- source_
table TableReference - A reference to the table being exported.
- use_
avro_ boollogical_ types - [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.
- destination
Format 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.
- destination
Uri 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.
- destination
Uris List<String> - [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- field
Delimiter String - [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
- print
Header Boolean - [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
- source
Model Property Map - A reference to the model being exported.
- source
Table Property Map - A reference to the table being exported.
- use
Avro BooleanLogical Types - [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.
JobConfigurationExtractResponse, JobConfigurationExtractResponseArgs
- Compression
This property is required. string - [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
- Destination
Format This property is required. string - [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
- Destination
Uri This property is required. string - [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- Destination
Uris This property is required. List<string> - [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- Field
Delimiter This property is required. string - [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
- Print
Header This property is required. bool - [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
- Source
Model This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Model Reference Response - A reference to the model being exported.
- Source
Table This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Table Reference Response - A reference to the table being exported.
- Use
Avro Logical Types This property is required. bool - [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
- Compression
This property is required. string - [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
- Destination
Format This property is required. string - [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
- Destination
Uri This property is required. string - [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- Destination
Uris This property is required. []string - [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- Field
Delimiter This property is required. string - [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
- Print
Header This property is required. bool - [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
- Source
Model This property is required. ModelReference Response - A reference to the model being exported.
- Source
Table This property is required. TableReference Response - A reference to the table being exported.
- Use
Avro Logical Types This property is required. bool - [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
- compression
This property is required. String - [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
- destination
Format This property is required. String - [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
- destination
Uri This property is required. String - [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- destination
Uris This property is required. List<String> - [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- field
Delimiter This property is required. String - [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
- print
Header This property is required. Boolean - [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
- source
Model This property is required. ModelReference Response - A reference to the model being exported.
- source
Table This property is required. TableReference Response - A reference to the table being exported.
- use
Avro Logical Types This property is required. Boolean - [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
- compression
This property is required. string - [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
- destination
Format This property is required. string - [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
- destination
Uri This property is required. string - [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- destination
Uris This property is required. string[] - [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- field
Delimiter This property is required. string - [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
- print
Header This property is required. boolean - [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
- source
Model This property is required. ModelReference Response - A reference to the model being exported.
- source
Table This property is required. TableReference Response - A reference to the table being exported.
- use
Avro Logical Types This property is required. boolean - [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
- compression
This property is required. str - [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
- destination_
format This property is required. str - [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
- destination_
uri This property is required. str - [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- destination_
uris This property is required. Sequence[str] - [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- field_
delimiter This property is required. str - [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
- print_
header This property is required. bool - [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
- source_
model This property is required. ModelReference Response - A reference to the model being exported.
- source_
table This property is required. TableReference Response - A reference to the table being exported.
- use_
avro_ logical_ types This property is required. bool - [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
- compression
This property is required. String - [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
- destination
Format This property is required. String - [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
- destination
Uri This property is required. String - [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
- destination
Uris This property is required. List<String> - [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
- field
Delimiter This property is required. String - [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.
- print
Header This property is required. Boolean - [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
- source
Model This property is required. Property Map - A reference to the model being exported.
- source
Table This property is required. Property Map - A reference to the table being exported.
- use
Avro Logical Types This property is required. Boolean - [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
JobConfigurationLoad, JobConfigurationLoadArgs
- Allow
Jagged boolRows - [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 boolNewlines - 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.
Google Native. Big Query. V2. Inputs. Clustering - [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 List<Pulumi.Google Native. Big Query. V2. Inputs. Connection Property> - Connection properties.
- Create
Disposition 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.
- 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 List<string>Types - [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 Pulumi.Configuration Google Native. Big Query. V2. Inputs. Encryption Configuration - Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Table Pulumi.Google Native. Big Query. V2. Inputs. Table Reference - [Required] The destination table to load the data into.
- Destination
Table Pulumi.Properties Google Native. Big Query. V2. Inputs. Destination Table Properties - [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.
- Field
Delimiter 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 (',').
- File
Set stringSpec Type - [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- Hive
Partitioning Pulumi.Options Google Native. Big Query. V2. Inputs. Hive Partitioning Options - [Optional] Options to configure hive partitioning support.
- Ignore
Unknown boolValues - [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 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.
- Max
Bad intRecords - [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 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.
- Parquet
Options Pulumi.Google Native. Big Query. V2. Inputs. Parquet Options - [Optional] Options to configure parquet support.
- Preserve
Ascii boolControl Characters - [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 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.
- Range
Partitioning Pulumi.Google Native. Big Query. V2. Inputs. Range Partitioning - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- Reference
File stringSchema Uri - User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- Schema
Pulumi.
Google Native. Big Query. V2. Inputs. Table Schema - [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 string - [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- Schema
Inline stringFormat - [Deprecated] The format of the schemaInline property.
- Schema
Update List<string>Options - 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 intRows - [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 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.
- Source
Uris 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.
- Time
Partitioning Pulumi.Google Native. Big Query. V2. Inputs. Time Partitioning - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- Use
Avro boolLogical Types - [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 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 boolRows - [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 boolNewlines - 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 Clustering
- [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 []ConnectionProperty - Connection properties.
- Create
Disposition 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.
- 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 []stringTypes - [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 EncryptionConfiguration Configuration - Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Table TableReference - [Required] The destination table to load the data into.
- Destination
Table DestinationProperties Table Properties - [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.
- Field
Delimiter 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 (',').
- File
Set stringSpec Type - [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- Hive
Partitioning HiveOptions Partitioning Options - [Optional] Options to configure hive partitioning support.
- Ignore
Unknown boolValues - [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 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.
- Max
Bad intRecords - [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 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.
- Parquet
Options ParquetOptions - [Optional] Options to configure parquet support.
- Preserve
Ascii boolControl Characters - [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 []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.
- Range
Partitioning RangePartitioning - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- Reference
File stringSchema Uri - User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- Schema
Table
Schema - [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 string - [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- Schema
Inline stringFormat - [Deprecated] The format of the schemaInline property.
- Schema
Update []stringOptions - 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 intRows - [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 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.
- Source
Uris []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.
- Time
Partitioning TimePartitioning - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- Use
Avro boolLogical Types - [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 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 BooleanRows - [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 BooleanNewlines - 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 Clustering
- [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 List<ConnectionProperty> - Connection properties.
- create
Disposition 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.
- create
Session 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.
- decimal
Target List<String>Types - [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 EncryptionConfiguration Configuration - Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table TableReference - [Required] The destination table to load the data into.
- destination
Table DestinationProperties Table Properties - [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.
- field
Delimiter 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 (',').
- file
Set StringSpec Type - [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- hive
Partitioning HiveOptions Partitioning Options - [Optional] Options to configure hive partitioning support.
- ignore
Unknown BooleanValues - [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 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.
- max
Bad IntegerRecords - [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 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.
- parquet
Options ParquetOptions - [Optional] Options to configure parquet support.
- preserve
Ascii BooleanControl Characters - [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 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.
- range
Partitioning RangePartitioning - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- reference
File StringSchema Uri - User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- schema
Table
Schema - [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 String - [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- schema
Inline StringFormat - [Deprecated] The format of the schemaInline property.
- schema
Update List<String>Options - 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 IntegerRows - [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 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.
- source
Uris 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.
- time
Partitioning TimePartitioning - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Avro BooleanLogical Types - [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 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 booleanRows - [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 booleanNewlines - 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 Clustering
- [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 ConnectionProperty[] - Connection properties.
- create
Disposition 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.
- create
Session 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.
- decimal
Target string[]Types - [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 EncryptionConfiguration Configuration - Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table TableReference - [Required] The destination table to load the data into.
- destination
Table DestinationProperties Table Properties - [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.
- field
Delimiter 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 (',').
- file
Set stringSpec Type - [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- hive
Partitioning HiveOptions Partitioning Options - [Optional] Options to configure hive partitioning support.
- ignore
Unknown booleanValues - [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 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.
- max
Bad numberRecords - [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 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.
- parquet
Options ParquetOptions - [Optional] Options to configure parquet support.
- preserve
Ascii booleanControl Characters - [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 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.
- range
Partitioning RangePartitioning - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- reference
File stringSchema Uri - User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- schema
Table
Schema - [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 string - [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- schema
Inline stringFormat - [Deprecated] The format of the schemaInline property.
- schema
Update string[]Options - 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 numberRows - [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 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.
- source
Uris 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.
- time
Partitioning TimePartitioning - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Avro booleanLogical Types - [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 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_ boolrows - [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_ boolnewlines - 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 Clustering
- [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[ConnectionProperty] - 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_ Sequence[str]types - [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_ Encryptionconfiguration Configuration - Custom encryption configuration (e.g., Cloud KMS keys).
- destination_
table TableReference - [Required] The destination table to load the data into.
- destination_
table_ Destinationproperties Table Properties - [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 (',').
- file_
set_ strspec_ type - [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- hive_
partitioning_ Hiveoptions Partitioning Options - [Optional] Options to configure hive partitioning support.
- ignore_
unknown_ boolvalues - [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_ intrecords - [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 ParquetOptions - [Optional] Options to configure parquet support.
- preserve_
ascii_ boolcontrol_ characters - [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 RangePartitioning - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- reference_
file_ strschema_ uri - User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- schema
Table
Schema - [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".
- schema_
inline_ strformat - [Deprecated] The format of the schemaInline property.
- schema_
update_ Sequence[str]options - 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_ introws - [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 TimePartitioning - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use_
avro_ boollogical_ types - [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.
- allow
Jagged BooleanRows - [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 BooleanNewlines - 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.
- connection
Properties List<Property Map> - Connection properties.
- create
Disposition 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.
- create
Session 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.
- decimal
Target List<String>Types - [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 Property MapConfiguration - Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table Property Map - [Required] The destination table to load the data into.
- destination
Table Property MapProperties - [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.
- field
Delimiter 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 (',').
- file
Set StringSpec Type - [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- hive
Partitioning Property MapOptions - [Optional] Options to configure hive partitioning support.
- ignore
Unknown BooleanValues - [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 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.
- max
Bad NumberRecords - [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 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.
- parquet
Options Property Map - [Optional] Options to configure parquet support.
- preserve
Ascii BooleanControl Characters - [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 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.
- range
Partitioning Property Map - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- reference
File StringSchema Uri - 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.
- schema
Inline String - [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- schema
Inline StringFormat - [Deprecated] The format of the schemaInline property.
- schema
Update List<String>Options - 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 NumberRows - [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 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.
- source
Uris 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.
- time
Partitioning Property Map - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Avro BooleanLogical Types - [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 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.
JobConfigurationLoadResponse, JobConfigurationLoadResponseArgs
- Allow
Jagged Rows This property is required. bool - [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
- Allow
Quoted Newlines This property is required. bool - Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- Autodetect
This property is required. bool - [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
- Clustering
This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Clustering Response - [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
- Connection
Properties This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. Connection Property Response> - Connection properties.
- Create
Disposition This property is required. string - [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- Create
Session This property is required. bool - If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
- Decimal
Target Types This property is required. 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.
- Destination
Encryption Configuration This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Encryption Configuration Response - Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Table This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Table Reference Response - [Required] The destination table to load the data into.
- Destination
Table Properties This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Destination Table Properties Response - [Beta] [Optional] Properties with which to create the destination table if it is new.
- Encoding
This property is required. string - [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- Field
Delimiter This property is required. string - [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- File
Set Spec Type This property is required. string - [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- Hive
Partitioning Options This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Hive Partitioning Options Response - [Optional] Options to configure hive partitioning support.
- Ignore
Unknown Values This property is required. bool - [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
- Json
Extension This property is required. 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.
- Max
Bad Records This property is required. int - [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
- Null
Marker This property is required. 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.
- Parquet
Options This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Parquet Options Response - [Optional] Options to configure parquet support.
- Preserve
Ascii Control Characters This property is required. bool - [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
- Projection
Fields This property is required. List<string> - If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
- Quote
This property is required. string - [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- Range
Partitioning This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Range Partitioning Response - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- Reference
File Schema Uri This property is required. string - User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- Schema
This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Table Schema Response - [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
- Schema
Inline This property is required. string - [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- Schema
Inline Format This property is required. string - [Deprecated] The format of the schemaInline property.
- Schema
Update Options This property is required. List<string> - Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
- Skip
Leading Rows This property is required. int - [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- Source
Format This property is required. 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.
- Source
Uris This property is required. List<string> - [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
- Time
Partitioning This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Time Partitioning Response - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- Use
Avro Logical Types This property is required. bool - [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
- Write
Disposition This property is required. string - [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
- Allow
Jagged Rows This property is required. bool - [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
- Allow
Quoted Newlines This property is required. bool - Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- Autodetect
This property is required. bool - [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
- Clustering
This property is required. ClusteringResponse - [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
- Connection
Properties This property is required. []ConnectionProperty Response - Connection properties.
- Create
Disposition This property is required. string - [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- Create
Session This property is required. bool - If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
- Decimal
Target Types This property is required. []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.
- Destination
Encryption Configuration This property is required. EncryptionConfiguration Response - Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Table This property is required. TableReference Response - [Required] The destination table to load the data into.
- Destination
Table Properties This property is required. DestinationTable Properties Response - [Beta] [Optional] Properties with which to create the destination table if it is new.
- Encoding
This property is required. string - [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- Field
Delimiter This property is required. string - [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- File
Set Spec Type This property is required. string - [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- Hive
Partitioning Options This property is required. HivePartitioning Options Response - [Optional] Options to configure hive partitioning support.
- Ignore
Unknown Values This property is required. bool - [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
- Json
Extension This property is required. 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.
- Max
Bad Records This property is required. int - [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
- Null
Marker This property is required. 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.
- Parquet
Options This property is required. ParquetOptions Response - [Optional] Options to configure parquet support.
- Preserve
Ascii Control Characters This property is required. bool - [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
- Projection
Fields This property is required. []string - If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
- Quote
This property is required. string - [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- Range
Partitioning This property is required. RangePartitioning Response - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- Reference
File Schema Uri This property is required. string - User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- Schema
This property is required. TableSchema Response - [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
- Schema
Inline This property is required. string - [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- Schema
Inline Format This property is required. string - [Deprecated] The format of the schemaInline property.
- Schema
Update Options This property is required. []string - Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
- Skip
Leading Rows This property is required. int - [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- Source
Format This property is required. 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.
- Source
Uris This property is required. []string - [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
- Time
Partitioning This property is required. TimePartitioning Response - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- Use
Avro Logical Types This property is required. bool - [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
- Write
Disposition This property is required. string - [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
- allow
Jagged Rows This property is required. 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.
- allow
Quoted Newlines This property is required. Boolean - Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- autodetect
This property is required. Boolean - [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
- clustering
This property is required. ClusteringResponse - [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
- connection
Properties This property is required. List<ConnectionProperty Response> - Connection properties.
- create
Disposition This property is required. String - [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- create
Session This property is required. Boolean - If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
- decimal
Target Types This property is required. List<String> - [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
- destination
Encryption Configuration This property is required. EncryptionConfiguration Response - Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table This property is required. TableReference Response - [Required] The destination table to load the data into.
- destination
Table Properties This property is required. DestinationTable Properties Response - [Beta] [Optional] Properties with which to create the destination table if it is new.
- encoding
This property is required. String - [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- field
Delimiter This property is required. String - [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- file
Set Spec Type This property is required. String - [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- hive
Partitioning Options This property is required. HivePartitioning Options Response - [Optional] Options to configure hive partitioning support.
- ignore
Unknown Values This property is required. Boolean - [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
- json
Extension This property is required. String - [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
- max
Bad Records This property is required. Integer - [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
- null
Marker This property is required. String - [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
- parquet
Options This property is required. ParquetOptions Response - [Optional] Options to configure parquet support.
- preserve
Ascii Control Characters This property is required. Boolean - [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
- projection
Fields This property is required. List<String> - If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
- quote
This property is required. String - [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- range
Partitioning This property is required. RangePartitioning Response - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- reference
File Schema Uri This property is required. String - User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- schema
This property is required. TableSchema Response - [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
- schema
Inline This property is required. String - [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- schema
Inline Format This property is required. String - [Deprecated] The format of the schemaInline property.
- schema
Update Options This property is required. List<String> - Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
- skip
Leading Rows This property is required. Integer - [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- source
Format This property is required. String - [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
- source
Uris This property is required. List<String> - [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
- time
Partitioning This property is required. TimePartitioning Response - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Avro Logical Types This property is required. 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).
- write
Disposition This property is required. String - [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
- allow
Jagged Rows This property is required. 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.
- allow
Quoted Newlines This property is required. boolean - Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- autodetect
This property is required. boolean - [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
- clustering
This property is required. ClusteringResponse - [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
- connection
Properties This property is required. ConnectionProperty Response[] - Connection properties.
- create
Disposition This property is required. string - [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- create
Session This property is required. boolean - If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
- decimal
Target Types This property is required. string[] - [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
- destination
Encryption Configuration This property is required. EncryptionConfiguration Response - Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table This property is required. TableReference Response - [Required] The destination table to load the data into.
- destination
Table Properties This property is required. DestinationTable Properties Response - [Beta] [Optional] Properties with which to create the destination table if it is new.
- encoding
This property is required. string - [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- field
Delimiter This property is required. string - [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- file
Set Spec Type This property is required. string - [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- hive
Partitioning Options This property is required. HivePartitioning Options Response - [Optional] Options to configure hive partitioning support.
- ignore
Unknown Values This property is required. boolean - [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
- json
Extension This property is required. string - [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
- max
Bad Records This property is required. number - [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
- null
Marker This property is required. string - [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
- parquet
Options This property is required. ParquetOptions Response - [Optional] Options to configure parquet support.
- preserve
Ascii Control Characters This property is required. boolean - [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
- projection
Fields This property is required. string[] - If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
- quote
This property is required. string - [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- range
Partitioning This property is required. RangePartitioning Response - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- reference
File Schema Uri This property is required. string - User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- schema
This property is required. TableSchema Response - [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
- schema
Inline This property is required. string - [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- schema
Inline Format This property is required. string - [Deprecated] The format of the schemaInline property.
- schema
Update Options This property is required. string[] - Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
- skip
Leading Rows This property is required. number - [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- source
Format This property is required. string - [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
- source
Uris This property is required. string[] - [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
- time
Partitioning This property is required. TimePartitioning Response - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Avro Logical Types This property is required. 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).
- write
Disposition This property is required. string - [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
- allow_
jagged_ rows This property is required. bool - [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
- allow_
quoted_ newlines This property is required. bool - Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- autodetect
This property is required. bool - [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
- clustering
This property is required. ClusteringResponse - [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
- connection_
properties This property is required. Sequence[ConnectionProperty Response] - Connection properties.
- create_
disposition This property is required. str - [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- create_
session This property is required. bool - If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
- decimal_
target_ types This property is required. Sequence[str] - [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
- destination_
encryption_ configuration This property is required. EncryptionConfiguration Response - Custom encryption configuration (e.g., Cloud KMS keys).
- destination_
table This property is required. TableReference Response - [Required] The destination table to load the data into.
- destination_
table_ properties This property is required. DestinationTable Properties Response - [Beta] [Optional] Properties with which to create the destination table if it is new.
- encoding
This property is required. str - [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- field_
delimiter This property is required. str - [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- file_
set_ spec_ type This property is required. str - [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- hive_
partitioning_ options This property is required. HivePartitioning Options Response - [Optional] Options to configure hive partitioning support.
- ignore_
unknown_ values This property is required. bool - [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
- json_
extension This property is required. str - [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
- max_
bad_ records This property is required. int - [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
- null_
marker This property is required. str - [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
- parquet_
options This property is required. ParquetOptions Response - [Optional] Options to configure parquet support.
- preserve_
ascii_ control_ characters This property is required. bool - [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
- projection_
fields This property is required. Sequence[str] - If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
- quote
This property is required. str - [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- range_
partitioning This property is required. RangePartitioning Response - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- reference_
file_ schema_ uri This property is required. str - User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- schema
This property is required. TableSchema Response - [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
- schema_
inline This property is required. str - [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- schema_
inline_ format This property is required. str - [Deprecated] The format of the schemaInline property.
- schema_
update_ options This property is required. Sequence[str] - Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
- skip_
leading_ rows This property is required. int - [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- source_
format This property is required. str - [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
- source_
uris This property is required. Sequence[str] - [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
- time_
partitioning This property is required. TimePartitioning Response - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use_
avro_ logical_ types This property is required. bool - [Optional] If sourceFormat is set to "AVRO", indicates whether to interpret logical types as the corresponding BigQuery data type (for example, TIMESTAMP), instead of using the raw type (for example, INTEGER).
- write_
disposition This property is required. str - [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
- allow
Jagged Rows This property is required. Boolean - [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
- allow
Quoted Newlines This property is required. Boolean - Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
- autodetect
This property is required. Boolean - [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
- clustering
This property is required. Property Map - [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
- connection
Properties This property is required. List<Property Map> - Connection properties.
- create
Disposition This property is required. String - [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- create
Session This property is required. Boolean - If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs the load job in non-session mode.
- decimal
Target Types This property is required. List<String> - [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.
- destination
Encryption Configuration This property is required. Property Map - Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table This property is required. Property Map - [Required] The destination table to load the data into.
- destination
Table Properties This property is required. Property Map - [Beta] [Optional] Properties with which to create the destination table if it is new.
- encoding
This property is required. String - [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
- field
Delimiter This property is required. String - [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (',').
- file
Set Spec Type This property is required. String - [Optional] Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
- hive
Partitioning Options This property is required. Property Map - [Optional] Options to configure hive partitioning support.
- ignore
Unknown Values This property is required. Boolean - [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names
- json
Extension This property is required. String - [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.
- max
Bad Records This property is required. Number - [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
- null
Marker This property is required. String - [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
- parquet
Options This property is required. Property Map - [Optional] Options to configure parquet support.
- preserve
Ascii Control Characters This property is required. Boolean - [Optional] Preserves the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') when loading from CSV. Only applicable to CSV, ignored for other formats.
- projection
Fields This property is required. List<String> - If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.
- quote
This property is required. String - [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
- range
Partitioning This property is required. Property Map - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- reference
File Schema Uri This property is required. String - User provided referencing file with the expected reader schema, Available for the format: AVRO, PARQUET, ORC.
- schema
This property is required. Property Map - [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.
- schema
Inline This property is required. String - [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".
- schema
Inline Format This property is required. String - [Deprecated] The format of the schemaInline property.
- schema
Update Options This property is required. List<String> - Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
- skip
Leading Rows This property is required. Number - [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
- source
Format This property is required. String - [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.
- source
Uris This property is required. List<String> - [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.
- time
Partitioning This property is required. Property Map - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Avro Logical Types This property is required. 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).
- write
Disposition This property is required. String - [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
JobConfigurationQuery, JobConfigurationQueryArgs
- Allow
Large boolResults - [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.
Google Native. Big Query. V2. Inputs. Clustering - [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 List<Pulumi.Google Native. Big Query. V2. Inputs. Connection Property> - Connection properties.
- Continuous bool
- [Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- Create
Disposition 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.
- 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 Pulumi.Google Native. Big Query. V2. Inputs. Dataset Reference - [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 Pulumi.Configuration Google Native. Big Query. V2. Inputs. Encryption Configuration - Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Table Pulumi.Google Native. Big Query. V2. Inputs. Table Reference - [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 intTier - [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 stringBilled - [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 string - 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.
- 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.
- Query
Parameters List<Pulumi.Google Native. Big Query. V2. Inputs. Query Parameter> - Query parameters for standard SQL queries.
- Range
Partitioning Pulumi.Google Native. Big Query. V2. Inputs. Range Partitioning - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- Schema
Update List<string>Options - 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 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.
- Time
Partitioning Pulumi.Google Native. Big Query. V2. Inputs. Time Partitioning - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- Use
Legacy boolSql - 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 boolCache - [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 List<Pulumi.Function Resources Google Native. Big Query. V2. Inputs. User Defined Function Resource> - Describes user-defined function resources used in the query.
- Write
Disposition 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 boolResults - [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 Clustering
- [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 []ConnectionProperty - Connection properties.
- Continuous bool
- [Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- Create
Disposition 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.
- 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 DatasetReference - [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 EncryptionConfiguration Configuration - Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Table TableReference - [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 intTier - [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 stringBilled - [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 string - 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.
- 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.
- Query
Parameters []QueryParameter - Query parameters for standard SQL queries.
- Range
Partitioning RangePartitioning - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- Schema
Update []stringOptions - 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 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.
- Time
Partitioning TimePartitioning - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- Use
Legacy boolSql - 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 boolCache - [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 []UserFunction Resources Defined Function Resource - Describes user-defined function resources used in the query.
- Write
Disposition 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 BooleanResults - [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 Clustering
- [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 List<ConnectionProperty> - Connection properties.
- continuous Boolean
- [Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- create
Disposition 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.
- create
Session 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.
- default
Dataset DatasetReference - [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 EncryptionConfiguration Configuration - Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table TableReference - [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 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.
- maximum
Billing IntegerTier - [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 StringBilled - [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 String - 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 Boolean - [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.
- query
Parameters List<QueryParameter> - Query parameters for standard SQL queries.
- range
Partitioning RangePartitioning - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- schema
Update List<String>Options - 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 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.
- time
Partitioning TimePartitioning - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Legacy BooleanSql - 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 BooleanCache - [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 List<UserFunction Resources Defined Function Resource> - Describes user-defined function resources used in the query.
- write
Disposition 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 booleanResults - [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 Clustering
- [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 ConnectionProperty[] - Connection properties.
- continuous boolean
- [Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- create
Disposition 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.
- create
Session 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.
- default
Dataset DatasetReference - [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 EncryptionConfiguration Configuration - Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table TableReference - [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 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.
- maximum
Billing numberTier - [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 stringBilled - [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 string - 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 boolean - [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.
- query
Parameters QueryParameter[] - Query parameters for standard SQL queries.
- range
Partitioning RangePartitioning - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- schema
Update string[]Options - 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 {[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.
- time
Partitioning TimePartitioning - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Legacy booleanSql - 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 booleanCache - [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 UserFunction Resources Defined Function Resource[] - Describes user-defined function resources used in the query.
- write
Disposition 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_ boolresults - [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 Clustering
- [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[ConnectionProperty] - Connection properties.
- continuous bool
- [Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- 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 DatasetReference - [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_ Encryptionconfiguration Configuration - Custom encryption configuration (e.g., Cloud KMS keys).
- destination_
table TableReference - [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_ inttier - [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_ strbilled - [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.
- 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[QueryParameter] - Query parameters for standard SQL queries.
- range_
partitioning RangePartitioning - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- schema_
update_ Sequence[str]options - 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 TimePartitioning - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use_
legacy_ boolsql - 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_ boolcache - [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_ Sequence[Userfunction_ resources Defined Function Resource] - 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.
- allow
Large BooleanResults - [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.
- connection
Properties List<Property Map> - Connection properties.
- continuous Boolean
- [Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- create
Disposition 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.
- create
Session 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.
- default
Dataset 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.
- destination
Encryption Property MapConfiguration - Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table 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.
- flatten
Results 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.
- maximum
Billing NumberTier - [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 StringBilled - [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 String - 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 Boolean - [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.
- query
Parameters List<Property Map> - Query parameters for standard SQL queries.
- range
Partitioning Property Map - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- schema
Update List<String>Options - 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 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.
- time
Partitioning Property Map - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Legacy BooleanSql - 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 BooleanCache - [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 List<Property Map>Function Resources - Describes user-defined function resources used in the query.
- write
Disposition 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.
JobConfigurationQueryResponse, JobConfigurationQueryResponseArgs
- Allow
Large Results This property is required. bool - [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.
- Clustering
This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Clustering Response - [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
- Connection
Properties This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. Connection Property Response> - Connection properties.
- Continuous
This property is required. bool - [Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- Create
Disposition This property is required. 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.
- Create
Session This property is required. bool - If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
- Default
Dataset This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Dataset Reference Response - [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.
- Destination
Encryption Configuration This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Encryption Configuration Response - Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Table This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Table Reference Response - [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size.
- Flatten
Results This property is required. bool - [Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened.
- Maximum
Billing Tier This property is required. int - [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
- Maximum
Bytes Billed This property is required. 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.
- Parameter
Mode This property is required. string - Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
- Preserve
Nulls This property is required. bool - [Deprecated] This property is deprecated.
- Priority
This property is required. string - [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
- Query
This property is required. string - [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
- Query
Parameters This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. Query Parameter Response> - Query parameters for standard SQL queries.
- Range
Partitioning This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Range Partitioning Response - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- Schema
Update Options This property is required. List<string> - Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
- Table
Definitions This property is required. Dictionary<string, string> - [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
- Time
Partitioning This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Time Partitioning Response - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- Use
Legacy Sql This property is required. bool - Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
- Use
Query Cache This property is required. bool - [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.
- User
Defined Function Resources This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. User Defined Function Resource Response> - Describes user-defined function resources used in the query.
- Write
Disposition This property is required. string - [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
- Allow
Large Results This property is required. bool - [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.
- Clustering
This property is required. ClusteringResponse - [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
- Connection
Properties This property is required. []ConnectionProperty Response - Connection properties.
- Continuous
This property is required. bool - [Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- Create
Disposition This property is required. 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.
- Create
Session This property is required. bool - If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
- Default
Dataset This property is required. DatasetReference Response - [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.
- Destination
Encryption Configuration This property is required. EncryptionConfiguration Response - Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Table This property is required. TableReference Response - [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size.
- Flatten
Results This property is required. bool - [Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened.
- Maximum
Billing Tier This property is required. int - [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
- Maximum
Bytes Billed This property is required. 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.
- Parameter
Mode This property is required. string - Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
- Preserve
Nulls This property is required. bool - [Deprecated] This property is deprecated.
- Priority
This property is required. string - [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
- Query
This property is required. string - [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
- Query
Parameters This property is required. []QueryParameter Response - Query parameters for standard SQL queries.
- Range
Partitioning This property is required. RangePartitioning Response - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- Schema
Update Options This property is required. []string - Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
- Table
Definitions This property is required. map[string]string - [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
- Time
Partitioning This property is required. TimePartitioning Response - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- Use
Legacy Sql This property is required. bool - Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
- Use
Query Cache This property is required. bool - [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.
- User
Defined Function Resources This property is required. []UserDefined Function Resource Response - Describes user-defined function resources used in the query.
- Write
Disposition This property is required. string - [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
- allow
Large Results This property is required. Boolean - [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.
- clustering
This property is required. ClusteringResponse - [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
- connection
Properties This property is required. List<ConnectionProperty Response> - Connection properties.
- continuous
This property is required. Boolean - [Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- create
Disposition This property is required. String - [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- create
Session This property is required. Boolean - If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
- default
Dataset This property is required. DatasetReference Response - [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.
- destination
Encryption Configuration This property is required. EncryptionConfiguration Response - Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table This property is required. TableReference Response - [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size.
- flatten
Results This property is required. 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.
- maximum
Billing Tier This property is required. Integer - [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
- maximum
Bytes Billed This property is required. String - [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.
- parameter
Mode This property is required. String - Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
- preserve
Nulls This property is required. Boolean - [Deprecated] This property is deprecated.
- priority
This property is required. String - [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
- query
This property is required. String - [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
- query
Parameters This property is required. List<QueryParameter Response> - Query parameters for standard SQL queries.
- range
Partitioning This property is required. RangePartitioning Response - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- schema
Update Options This property is required. List<String> - Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
- table
Definitions This property is required. Map<String,String> - [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
- time
Partitioning This property is required. TimePartitioning Response - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Legacy Sql This property is required. Boolean - Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
- use
Query Cache This property is required. Boolean - [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.
- user
Defined Function Resources This property is required. List<UserDefined Function Resource Response> - Describes user-defined function resources used in the query.
- write
Disposition This property is required. String - [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
- allow
Large Results This property is required. boolean - [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.
- clustering
This property is required. ClusteringResponse - [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
- connection
Properties This property is required. ConnectionProperty Response[] - Connection properties.
- continuous
This property is required. boolean - [Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- create
Disposition This property is required. string - [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- create
Session This property is required. boolean - If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
- default
Dataset This property is required. DatasetReference Response - [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.
- destination
Encryption Configuration This property is required. EncryptionConfiguration Response - Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table This property is required. TableReference Response - [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size.
- flatten
Results This property is required. 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.
- maximum
Billing Tier This property is required. number - [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
- maximum
Bytes Billed This property is required. string - [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.
- parameter
Mode This property is required. string - Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
- preserve
Nulls This property is required. boolean - [Deprecated] This property is deprecated.
- priority
This property is required. string - [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
- query
This property is required. string - [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
- query
Parameters This property is required. QueryParameter Response[] - Query parameters for standard SQL queries.
- range
Partitioning This property is required. RangePartitioning Response - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- schema
Update Options This property is required. string[] - Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
- table
Definitions This property is required. {[key: string]: string} - [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
- time
Partitioning This property is required. TimePartitioning Response - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Legacy Sql This property is required. boolean - Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
- use
Query Cache This property is required. boolean - [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.
- user
Defined Function Resources This property is required. UserDefined Function Resource Response[] - Describes user-defined function resources used in the query.
- write
Disposition This property is required. string - [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
- allow_
large_ results This property is required. bool - [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.
- clustering
This property is required. ClusteringResponse - [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
- connection_
properties This property is required. Sequence[ConnectionProperty Response] - Connection properties.
- continuous
This property is required. bool - [Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- create_
disposition This property is required. str - [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- create_
session This property is required. bool - If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
- default_
dataset This property is required. DatasetReference Response - [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.
- destination_
encryption_ configuration This property is required. EncryptionConfiguration Response - Custom encryption configuration (e.g., Cloud KMS keys).
- destination_
table This property is required. TableReference Response - [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size.
- flatten_
results This property is required. bool - [Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened.
- maximum_
billing_ tier This property is required. int - [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
- maximum_
bytes_ billed This property is required. str - [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.
- parameter_
mode This property is required. str - Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
- preserve_
nulls This property is required. bool - [Deprecated] This property is deprecated.
- priority
This property is required. str - [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
- query
This property is required. str - [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
- query_
parameters This property is required. Sequence[QueryParameter Response] - Query parameters for standard SQL queries.
- range_
partitioning This property is required. RangePartitioning Response - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- schema_
update_ options This property is required. Sequence[str] - Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
- table_
definitions This property is required. Mapping[str, str] - [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
- time_
partitioning This property is required. TimePartitioning Response - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use_
legacy_ sql This property is required. bool - Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
- use_
query_ cache This property is required. bool - [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.
- user_
defined_ function_ resources This property is required. Sequence[UserDefined Function Resource Response] - Describes user-defined function resources used in the query.
- write_
disposition This property is required. str - [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
- allow
Large Results This property is required. Boolean - [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.
- clustering
This property is required. Property Map - [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
- connection
Properties This property is required. List<Property Map> - Connection properties.
- continuous
This property is required. Boolean - [Optional] Specifies whether the query should be executed as a continuous query. The default value is false.
- create
Disposition This property is required. String - [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- create
Session This property is required. Boolean - If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.
- default
Dataset This property is required. Property Map - [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.
- destination
Encryption Configuration This property is required. Property Map - Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Table This property is required. Property Map - [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size.
- flatten
Results This property is required. Boolean - [Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened.
- maximum
Billing Tier This property is required. Number - [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
- maximum
Bytes Billed This property is required. String - [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.
- parameter
Mode This property is required. String - Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
- preserve
Nulls This property is required. Boolean - [Deprecated] This property is deprecated.
- priority
This property is required. String - [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
- query
This property is required. String - [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
- query
Parameters This property is required. List<Property Map> - Query parameters for standard SQL queries.
- range
Partitioning This property is required. Property Map - [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
- schema
Update Options This property is required. List<String> - Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
- table
Definitions This property is required. Map<String> - [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
- time
Partitioning This property is required. Property Map - Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
- use
Legacy Sql This property is required. Boolean - Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
- use
Query Cache This property is required. Boolean - [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.
- user
Defined Function Resources This property is required. List<Property Map> - Describes user-defined function resources used in the query.
- write
Disposition This property is required. String - [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
JobConfigurationResponse, JobConfigurationResponseArgs
- Copy
This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Job Configuration Table Copy Response - [Pick one] Copies a table.
- Dry
Run This property is required. bool - [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- Extract
This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Job Configuration Extract Response - [Pick one] Configures an extract job.
- Job
Timeout Ms This property is required. string - [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- Job
Type This property is required. string - The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
- Labels
This property is required. Dictionary<string, string> - The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
- Load
This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Job Configuration Load Response - [Pick one] Configures a load job.
- Query
This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Job Configuration Query Response - [Pick one] Configures a query job.
- Copy
This property is required. JobConfiguration Table Copy Response - [Pick one] Copies a table.
- Dry
Run This property is required. bool - [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- Extract
This property is required. JobConfiguration Extract Response - [Pick one] Configures an extract job.
- Job
Timeout Ms This property is required. string - [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- Job
Type This property is required. string - The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
- Labels
This property is required. map[string]string - The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
- Load
This property is required. JobConfiguration Load Response - [Pick one] Configures a load job.
- Query
This property is required. JobConfiguration Query Response - [Pick one] Configures a query job.
- copy
This property is required. JobConfiguration Table Copy Response - [Pick one] Copies a table.
- dry
Run This property is required. Boolean - [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- extract
This property is required. JobConfiguration Extract Response - [Pick one] Configures an extract job.
- job
Timeout Ms This property is required. String - [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- job
Type This property is required. String - The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
- labels
This property is required. Map<String,String> - The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
- load
This property is required. JobConfiguration Load Response - [Pick one] Configures a load job.
- query
This property is required. JobConfiguration Query Response - [Pick one] Configures a query job.
- copy
This property is required. JobConfiguration Table Copy Response - [Pick one] Copies a table.
- dry
Run This property is required. boolean - [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- extract
This property is required. JobConfiguration Extract Response - [Pick one] Configures an extract job.
- job
Timeout Ms This property is required. string - [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- job
Type This property is required. string - The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
- labels
This property is required. {[key: string]: string} - The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
- load
This property is required. JobConfiguration Load Response - [Pick one] Configures a load job.
- query
This property is required. JobConfiguration Query Response - [Pick one] Configures a query job.
- copy
This property is required. JobConfiguration Table Copy Response - [Pick one] Copies a table.
- dry_
run This property is required. bool - [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- extract
This property is required. JobConfiguration Extract Response - [Pick one] Configures an extract job.
- job_
timeout_ ms This property is required. str - [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- job_
type This property is required. str - The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
- labels
This property is required. Mapping[str, str] - The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
- load
This property is required. JobConfiguration Load Response - [Pick one] Configures a load job.
- query
This property is required. JobConfiguration Query Response - [Pick one] Configures a query job.
- copy
This property is required. Property Map - [Pick one] Copies a table.
- dry
Run This property is required. Boolean - [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.
- extract
This property is required. Property Map - [Pick one] Configures an extract job.
- job
Timeout Ms This property is required. String - [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
- job
Type This property is required. String - The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
- labels
This property is required. Map<String> - The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
- load
This property is required. Property Map - [Pick one] Configures a load job.
- query
This property is required. Property Map - [Pick one] Configures a query job.
JobConfigurationTableCopy, JobConfigurationTableCopyArgs
- Create
Disposition 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.
- Destination
Encryption Pulumi.Configuration Google Native. Big Query. V2. Inputs. Encryption Configuration - Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Expiration objectTime - [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- Destination
Table Pulumi.Google Native. Big Query. V2. Inputs. Table Reference - [Required] The destination table
- Operation
Type string - [Optional] Supported operation types in table copy job.
- Source
Table Pulumi.Google Native. Big Query. V2. Inputs. Table Reference - [Pick one] Source table to copy.
- Source
Tables List<Pulumi.Google Native. Big Query. V2. Inputs. Table Reference> - [Pick one] Source tables to copy.
- Write
Disposition 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 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.
- Destination
Encryption EncryptionConfiguration Configuration - Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Expiration interface{}Time - [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- Destination
Table TableReference - [Required] The destination table
- Operation
Type string - [Optional] Supported operation types in table copy job.
- Source
Table TableReference - [Pick one] Source table to copy.
- Source
Tables []TableReference - [Pick one] Source tables to copy.
- Write
Disposition 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 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.
- destination
Encryption EncryptionConfiguration Configuration - Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Expiration ObjectTime - [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- destination
Table TableReference - [Required] The destination table
- operation
Type String - [Optional] Supported operation types in table copy job.
- source
Table TableReference - [Pick one] Source table to copy.
- source
Tables List<TableReference> - [Pick one] Source tables to copy.
- write
Disposition 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 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.
- destination
Encryption EncryptionConfiguration Configuration - Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Expiration anyTime - [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- destination
Table TableReference - [Required] The destination table
- operation
Type string - [Optional] Supported operation types in table copy job.
- source
Table TableReference - [Pick one] Source table to copy.
- source
Tables TableReference[] - [Pick one] Source tables to copy.
- write
Disposition 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_ Encryptionconfiguration Configuration - Custom encryption configuration (e.g., Cloud KMS keys).
- destination_
expiration_ Anytime - [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- destination_
table TableReference - [Required] The destination table
- operation_
type str - [Optional] Supported operation types in table copy job.
- source_
table TableReference - [Pick one] Source table to copy.
- source_
tables Sequence[TableReference] - [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.
- create
Disposition 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.
- destination
Encryption Property MapConfiguration - Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Expiration AnyTime - [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- destination
Table Property Map - [Required] The destination table
- operation
Type String - [Optional] Supported operation types in table copy job.
- source
Table Property Map - [Pick one] Source table to copy.
- source
Tables List<Property Map> - [Pick one] Source tables to copy.
- write
Disposition 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.
JobConfigurationTableCopyResponse, JobConfigurationTableCopyResponseArgs
- Create
Disposition This property is required. string - [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- Destination
Encryption Configuration This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Encryption Configuration Response - Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Expiration Time This property is required. object - [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- Destination
Table This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Table Reference Response - [Required] The destination table
- Operation
Type This property is required. string - [Optional] Supported operation types in table copy job.
- Source
Table This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Table Reference Response - [Pick one] Source table to copy.
- Source
Tables This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. Table Reference Response> - [Pick one] Source tables to copy.
- Write
Disposition This property is required. string - [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
- Create
Disposition This property is required. 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.
- Destination
Encryption Configuration This property is required. EncryptionConfiguration Response - Custom encryption configuration (e.g., Cloud KMS keys).
- Destination
Expiration Time This property is required. interface{} - [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- Destination
Table This property is required. TableReference Response - [Required] The destination table
- Operation
Type This property is required. string - [Optional] Supported operation types in table copy job.
- Source
Table This property is required. TableReference Response - [Pick one] Source table to copy.
- Source
Tables This property is required. []TableReference Response - [Pick one] Source tables to copy.
- Write
Disposition This property is required. string - [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
- create
Disposition This property is required. 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.
- destination
Encryption Configuration This property is required. EncryptionConfiguration Response - Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Expiration Time This property is required. Object - [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- destination
Table This property is required. TableReference Response - [Required] The destination table
- operation
Type This property is required. String - [Optional] Supported operation types in table copy job.
- source
Table This property is required. TableReference Response - [Pick one] Source table to copy.
- source
Tables This property is required. List<TableReference Response> - [Pick one] Source tables to copy.
- write
Disposition This property is required. String - [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
- create
Disposition This property is required. 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.
- destination
Encryption Configuration This property is required. EncryptionConfiguration Response - Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Expiration Time This property is required. any - [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- destination
Table This property is required. TableReference Response - [Required] The destination table
- operation
Type This property is required. string - [Optional] Supported operation types in table copy job.
- source
Table This property is required. TableReference Response - [Pick one] Source table to copy.
- source
Tables This property is required. TableReference Response[] - [Pick one] Source tables to copy.
- write
Disposition This property is required. string - [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
- create_
disposition This property is required. str - [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- destination_
encryption_ configuration This property is required. EncryptionConfiguration Response - Custom encryption configuration (e.g., Cloud KMS keys).
- destination_
expiration_ time This property is required. Any - [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- destination_
table This property is required. TableReference Response - [Required] The destination table
- operation_
type This property is required. str - [Optional] Supported operation types in table copy job.
- source_
table This property is required. TableReference Response - [Pick one] Source table to copy.
- source_
tables This property is required. Sequence[TableReference Response] - [Pick one] Source tables to copy.
- write_
disposition This property is required. str - [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
- create
Disposition This property is required. String - [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
- destination
Encryption Configuration This property is required. Property Map - Custom encryption configuration (e.g., Cloud KMS keys).
- destination
Expiration Time This property is required. Any - [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
- destination
Table This property is required. Property Map - [Required] The destination table
- operation
Type This property is required. String - [Optional] Supported operation types in table copy job.
- source
Table This property is required. Property Map - [Pick one] Source table to copy.
- source
Tables This property is required. List<Property Map> - [Pick one] Source tables to copy.
- write
Disposition This property is required. String - [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
JobReference, JobReferenceArgs
- Job
Id 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 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 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 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.
- job
Id 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.
JobReferenceResponse, JobReferenceResponseArgs
- Job
Id This property is required. string - [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
- Location
This property is required. string - The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
- Project
This property is required. string - [Required] The ID of the project containing this job.
- Job
Id This property is required. string - [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
- Location
This property is required. string - The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
- Project
This property is required. string - [Required] The ID of the project containing this job.
- job
Id This property is required. String - [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
- location
This property is required. String - The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
- project
This property is required. String - [Required] The ID of the project containing this job.
- job
Id This property is required. string - [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
- location
This property is required. string - The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
- project
This property is required. string - [Required] The ID of the project containing this job.
- job_
id This property is required. str - [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
- location
This property is required. str - The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
- project
This property is required. str - [Required] The ID of the project containing this job.
- job
Id This property is required. String - [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
- location
This property is required. String - The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
- project
This property is required. String - [Required] The ID of the project containing this job.
JobStatistics2ReservationUsageItemResponse, JobStatistics2ReservationUsageItemResponseArgs
JobStatistics2Response, JobStatistics2ResponseArgs
- Bi
Engine Statistics This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Bi Engine Statistics Response - BI Engine specific Statistics. [Output only] BI Engine specific Statistics.
- Billing
Tier This property is required. int - [Output only] Billing tier for the job.
- Cache
Hit This property is required. bool - [Output only] Whether the query result was fetched from the query cache.
- Ddl
Affected Row Access Policy Count This property is required. string - [Output only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
- Ddl
Destination Table This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Table Reference Response - [Output only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information.
- Ddl
Operation Performed This property is required. 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.
- Ddl
Target Dataset This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Dataset Reference Response - [Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP/UNDROP SCHEMA queries.
- Ddl
Target Routine This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Routine Reference Response - The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
- Ddl
Target Row Access Policy This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Row Access Policy Reference Response - [Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
- Ddl
Target Table This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Table Reference Response - [Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
- Dml
Stats This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Dml Statistics Response - [Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.
- Estimated
Bytes Processed This property is required. string - [Output only] The original estimate of bytes processed for the job.
- Ml
Statistics This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Ml Statistics Response - [Output only] Statistics of a BigQuery ML training job.
- Model
Training This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Big Query Model Training Response - [Output only, Beta] Information about create model query job progress.
- Model
Training Current Iteration This property is required. int - [Output only, Beta] Deprecated; do not use.
- Model
Training Expected Total Iteration This property is required. string - [Output only, Beta] Deprecated; do not use.
- Num
Dml Affected Rows This property is required. string - [Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
- Query
Plan This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. Explain Query Stage Response> - [Output only] Describes execution plan for the query.
- Referenced
Routines This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. Routine Reference Response> - [Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
- Referenced
Tables This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. Table Reference Response> - [Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
- Reservation
Usage This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. Job Statistics2Reservation Usage Item Response> - [Output only] Job resource usage breakdown by reservation.
- Schema
This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Table Schema Response - [Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
- Search
Statistics This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Search Statistics Response - [Output only] Search query specific statistics.
- Spark
Statistics This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Spark Statistics Response - [Output only] Statistics of a Spark procedure job.
- Statement
Type This property is required. string - The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.
- Timeline
This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. Query Timeline Sample Response> - [Output only] [Beta] Describes a timeline of job execution.
- Total
Bytes Billed This property is required. string - [Output only] Total bytes billed for the job.
- Total
Bytes Processed This property is required. string - [Output only] Total bytes processed for the job.
- Total
Bytes Processed Accuracy This property is required. string - [Output only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
- Total
Partitions Processed This property is required. string - [Output only] Total number of partitions processed from all partitioned tables referenced in the job.
- Total
Slot Ms This property is required. string - [Output only] Slot-milliseconds for the job.
- Transferred
Bytes This property is required. string - Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
- Undeclared
Query Parameters This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. Query Parameter Response> - Standard SQL only: list of undeclared query parameters detected during a dry run validation.
- Bi
Engine Statistics This property is required. BiEngine Statistics Response - BI Engine specific Statistics. [Output only] BI Engine specific Statistics.
- Billing
Tier This property is required. int - [Output only] Billing tier for the job.
- Cache
Hit This property is required. bool - [Output only] Whether the query result was fetched from the query cache.
- Ddl
Affected Row Access Policy Count This property is required. string - [Output only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
- Ddl
Destination Table This property is required. TableReference Response - [Output only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information.
- Ddl
Operation Performed This property is required. 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.
- Ddl
Target Dataset This property is required. DatasetReference Response - [Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP/UNDROP SCHEMA queries.
- Ddl
Target Routine This property is required. RoutineReference Response - The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
- Ddl
Target Row Access Policy This property is required. RowAccess Policy Reference Response - [Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
- Ddl
Target Table This property is required. TableReference Response - [Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
- Dml
Stats This property is required. DmlStatistics Response - [Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.
- Estimated
Bytes Processed This property is required. string - [Output only] The original estimate of bytes processed for the job.
- Ml
Statistics This property is required. MlStatistics Response - [Output only] Statistics of a BigQuery ML training job.
- Model
Training This property is required. BigQuery Model Training Response - [Output only, Beta] Information about create model query job progress.
- Model
Training Current Iteration This property is required. int - [Output only, Beta] Deprecated; do not use.
- Model
Training Expected Total Iteration This property is required. string - [Output only, Beta] Deprecated; do not use.
- Num
Dml Affected Rows This property is required. string - [Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
- Query
Plan This property is required. []ExplainQuery Stage Response - [Output only] Describes execution plan for the query.
- Referenced
Routines This property is required. []RoutineReference Response - [Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
- Referenced
Tables This property is required. []TableReference Response - [Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
- Reservation
Usage This property is required. []JobStatistics2Reservation Usage Item Response - [Output only] Job resource usage breakdown by reservation.
- Schema
This property is required. TableSchema Response - [Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
- Search
Statistics This property is required. SearchStatistics Response - [Output only] Search query specific statistics.
- Spark
Statistics This property is required. SparkStatistics Response - [Output only] Statistics of a Spark procedure job.
- Statement
Type This property is required. string - The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.
- Timeline
This property is required. []QueryTimeline Sample Response - [Output only] [Beta] Describes a timeline of job execution.
- Total
Bytes Billed This property is required. string - [Output only] Total bytes billed for the job.
- Total
Bytes Processed This property is required. string - [Output only] Total bytes processed for the job.
- Total
Bytes Processed Accuracy This property is required. string - [Output only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
- Total
Partitions Processed This property is required. string - [Output only] Total number of partitions processed from all partitioned tables referenced in the job.
- Total
Slot Ms This property is required. string - [Output only] Slot-milliseconds for the job.
- Transferred
Bytes This property is required. string - Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
- Undeclared
Query Parameters This property is required. []QueryParameter Response - Standard SQL only: list of undeclared query parameters detected during a dry run validation.
- bi
Engine Statistics This property is required. BiEngine Statistics Response - BI Engine specific Statistics. [Output only] BI Engine specific Statistics.
- billing
Tier This property is required. Integer - [Output only] Billing tier for the job.
- cache
Hit This property is required. Boolean - [Output only] Whether the query result was fetched from the query cache.
- ddl
Affected Row Access Policy Count This property is required. String - [Output only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
- ddl
Destination Table This property is required. TableReference Response - [Output only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information.
- ddl
Operation Performed This property is required. 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.
- ddl
Target Dataset This property is required. DatasetReference Response - [Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP/UNDROP SCHEMA queries.
- ddl
Target Routine This property is required. RoutineReference Response - The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
- ddl
Target Row Access Policy This property is required. RowAccess Policy Reference Response - [Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
- ddl
Target Table This property is required. TableReference Response - [Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
- dml
Stats This property is required. DmlStatistics Response - [Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.
- estimated
Bytes Processed This property is required. String - [Output only] The original estimate of bytes processed for the job.
- ml
Statistics This property is required. MlStatistics Response - [Output only] Statistics of a BigQuery ML training job.
- model
Training This property is required. BigQuery Model Training Response - [Output only, Beta] Information about create model query job progress.
- model
Training Current Iteration This property is required. Integer - [Output only, Beta] Deprecated; do not use.
- model
Training Expected Total Iteration This property is required. String - [Output only, Beta] Deprecated; do not use.
- num
Dml Affected Rows This property is required. String - [Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
- query
Plan This property is required. List<ExplainQuery Stage Response> - [Output only] Describes execution plan for the query.
- referenced
Routines This property is required. List<RoutineReference Response> - [Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
- referenced
Tables This property is required. List<TableReference Response> - [Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
- reservation
Usage This property is required. List<JobStatistics2Reservation Usage Item Response> - [Output only] Job resource usage breakdown by reservation.
- schema
This property is required. TableSchema Response - [Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
- search
Statistics This property is required. SearchStatistics Response - [Output only] Search query specific statistics.
- spark
Statistics This property is required. SparkStatistics Response - [Output only] Statistics of a Spark procedure job.
- statement
Type This property is required. String - The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.
- timeline
This property is required. List<QueryTimeline Sample Response> - [Output only] [Beta] Describes a timeline of job execution.
- total
Bytes Billed This property is required. String - [Output only] Total bytes billed for the job.
- total
Bytes Processed This property is required. String - [Output only] Total bytes processed for the job.
- total
Bytes Processed Accuracy This property is required. String - [Output only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
- total
Partitions Processed This property is required. String - [Output only] Total number of partitions processed from all partitioned tables referenced in the job.
- total
Slot Ms This property is required. String - [Output only] Slot-milliseconds for the job.
- transferred
Bytes This property is required. String - Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
- undeclared
Query Parameters This property is required. List<QueryParameter Response> - Standard SQL only: list of undeclared query parameters detected during a dry run validation.
- bi
Engine Statistics This property is required. BiEngine Statistics Response - BI Engine specific Statistics. [Output only] BI Engine specific Statistics.
- billing
Tier This property is required. number - [Output only] Billing tier for the job.
- cache
Hit This property is required. boolean - [Output only] Whether the query result was fetched from the query cache.
- ddl
Affected Row Access Policy Count This property is required. string - [Output only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
- ddl
Destination Table This property is required. TableReference Response - [Output only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information.
- ddl
Operation Performed This property is required. 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.
- ddl
Target Dataset This property is required. DatasetReference Response - [Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP/UNDROP SCHEMA queries.
- ddl
Target Routine This property is required. RoutineReference Response - The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
- ddl
Target Row Access Policy This property is required. RowAccess Policy Reference Response - [Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
- ddl
Target Table This property is required. TableReference Response - [Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
- dml
Stats This property is required. DmlStatistics Response - [Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.
- estimated
Bytes Processed This property is required. string - [Output only] The original estimate of bytes processed for the job.
- ml
Statistics This property is required. MlStatistics Response - [Output only] Statistics of a BigQuery ML training job.
- model
Training This property is required. BigQuery Model Training Response - [Output only, Beta] Information about create model query job progress.
- model
Training Current Iteration This property is required. number - [Output only, Beta] Deprecated; do not use.
- model
Training Expected Total Iteration This property is required. string - [Output only, Beta] Deprecated; do not use.
- num
Dml Affected Rows This property is required. string - [Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
- query
Plan This property is required. ExplainQuery Stage Response[] - [Output only] Describes execution plan for the query.
- referenced
Routines This property is required. RoutineReference Response[] - [Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
- referenced
Tables This property is required. TableReference Response[] - [Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
- reservation
Usage This property is required. JobStatistics2Reservation Usage Item Response[] - [Output only] Job resource usage breakdown by reservation.
- schema
This property is required. TableSchema Response - [Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
- search
Statistics This property is required. SearchStatistics Response - [Output only] Search query specific statistics.
- spark
Statistics This property is required. SparkStatistics Response - [Output only] Statistics of a Spark procedure job.
- statement
Type This property is required. string - The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.
- timeline
This property is required. QueryTimeline Sample Response[] - [Output only] [Beta] Describes a timeline of job execution.
- total
Bytes Billed This property is required. string - [Output only] Total bytes billed for the job.
- total
Bytes Processed This property is required. string - [Output only] Total bytes processed for the job.
- total
Bytes Processed Accuracy This property is required. string - [Output only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
- total
Partitions Processed This property is required. string - [Output only] Total number of partitions processed from all partitioned tables referenced in the job.
- total
Slot Ms This property is required. string - [Output only] Slot-milliseconds for the job.
- transferred
Bytes This property is required. string - Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
- undeclared
Query Parameters This property is required. QueryParameter Response[] - Standard SQL only: list of undeclared query parameters detected during a dry run validation.
- bi_
engine_ statistics This property is required. BiEngine Statistics Response - BI Engine specific Statistics. [Output only] BI Engine specific Statistics.
- billing_
tier This property is required. int - [Output only] Billing tier for the job.
- cache_
hit This property is required. bool - [Output only] Whether the query result was fetched from the query cache.
- ddl_
affected_ row_ access_ policy_ count This property is required. str - [Output only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
- ddl_
destination_ table This property is required. TableReference Response - [Output only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information.
- ddl_
operation_ performed This property is required. str - The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.
- ddl_
target_ dataset This property is required. DatasetReference Response - [Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP/UNDROP SCHEMA queries.
- ddl_
target_ routine This property is required. RoutineReference Response - The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
- ddl_
target_ row_ access_ policy This property is required. RowAccess Policy Reference Response - [Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
- ddl_
target_ table This property is required. TableReference Response - [Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
- dml_
stats This property is required. DmlStatistics Response - [Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.
- estimated_
bytes_ processed This property is required. str - [Output only] The original estimate of bytes processed for the job.
- ml_
statistics This property is required. MlStatistics Response - [Output only] Statistics of a BigQuery ML training job.
- model_
training This property is required. BigQuery Model Training Response - [Output only, Beta] Information about create model query job progress.
- model_
training_ current_ iteration This property is required. int - [Output only, Beta] Deprecated; do not use.
- model_
training_ expected_ total_ iteration This property is required. str - [Output only, Beta] Deprecated; do not use.
- num_
dml_ affected_ rows This property is required. str - [Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
- query_
plan This property is required. Sequence[ExplainQuery Stage Response] - [Output only] Describes execution plan for the query.
- referenced_
routines This property is required. Sequence[RoutineReference Response] - [Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
- referenced_
tables This property is required. Sequence[TableReference Response] - [Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
- reservation_
usage This property is required. Sequence[JobStatistics2Reservation Usage Item Response] - [Output only] Job resource usage breakdown by reservation.
- schema
This property is required. TableSchema Response - [Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
- search_
statistics This property is required. SearchStatistics Response - [Output only] Search query specific statistics.
- spark_
statistics This property is required. SparkStatistics Response - [Output only] Statistics of a Spark procedure job.
- statement_
type This property is required. str - The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.
- timeline
This property is required. Sequence[QueryTimeline Sample Response] - [Output only] [Beta] Describes a timeline of job execution.
- total_
bytes_ billed This property is required. str - [Output only] Total bytes billed for the job.
- total_
bytes_ processed This property is required. str - [Output only] Total bytes processed for the job.
- total_
bytes_ processed_ accuracy This property is required. str - [Output only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
- total_
partitions_ processed This property is required. str - [Output only] Total number of partitions processed from all partitioned tables referenced in the job.
- total_
slot_ ms This property is required. str - [Output only] Slot-milliseconds for the job.
- transferred_
bytes This property is required. str - Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
- undeclared_
query_ parameters This property is required. Sequence[QueryParameter Response] - Standard SQL only: list of undeclared query parameters detected during a dry run validation.
- bi
Engine Statistics This property is required. Property Map - BI Engine specific Statistics. [Output only] BI Engine specific Statistics.
- billing
Tier This property is required. Number - [Output only] Billing tier for the job.
- cache
Hit This property is required. Boolean - [Output only] Whether the query result was fetched from the query cache.
- ddl
Affected Row Access Policy Count This property is required. String - [Output only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
- ddl
Destination Table This property is required. Property Map - [Output only] The DDL destination table. Present only for ALTER TABLE RENAME TO queries. Note that ddl_target_table is used just for its type information.
- ddl
Operation Performed This property is required. String - The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.
- ddl
Target Dataset This property is required. Property Map - [Output only] The DDL target dataset. Present only for CREATE/ALTER/DROP/UNDROP SCHEMA queries.
- ddl
Target Routine This property is required. Property Map - The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
- ddl
Target Row Access Policy This property is required. Property Map - [Output only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
- ddl
Target Table This property is required. Property Map - [Output only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
- dml
Stats This property is required. Property Map - [Output only] Detailed statistics for DML statements Present only for DML statements INSERT, UPDATE, DELETE or TRUNCATE.
- estimated
Bytes Processed This property is required. String - [Output only] The original estimate of bytes processed for the job.
- ml
Statistics This property is required. Property Map - [Output only] Statistics of a BigQuery ML training job.
- model
Training This property is required. Property Map - [Output only, Beta] Information about create model query job progress.
- model
Training Current Iteration This property is required. Number - [Output only, Beta] Deprecated; do not use.
- model
Training Expected Total Iteration This property is required. String - [Output only, Beta] Deprecated; do not use.
- num
Dml Affected Rows This property is required. String - [Output only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
- query
Plan This property is required. List<Property Map> - [Output only] Describes execution plan for the query.
- referenced
Routines This property is required. List<Property Map> - [Output only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
- referenced
Tables This property is required. List<Property Map> - [Output only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
- reservation
Usage This property is required. List<Property Map> - [Output only] Job resource usage breakdown by reservation.
- schema
This property is required. Property Map - [Output only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
- search
Statistics This property is required. Property Map - [Output only] Search query specific statistics.
- spark
Statistics This property is required. Property Map - [Output only] Statistics of a Spark procedure job.
- statement
Type This property is required. String - The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.
- timeline
This property is required. List<Property Map> - [Output only] [Beta] Describes a timeline of job execution.
- total
Bytes Billed This property is required. String - [Output only] Total bytes billed for the job.
- total
Bytes Processed This property is required. String - [Output only] Total bytes processed for the job.
- total
Bytes Processed Accuracy This property is required. String - [Output only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
- total
Partitions Processed This property is required. String - [Output only] Total number of partitions processed from all partitioned tables referenced in the job.
- total
Slot Ms This property is required. String - [Output only] Slot-milliseconds for the job.
- transferred
Bytes This property is required. String - Total bytes transferred for cross-cloud queries such as Cross Cloud Transfer and CREATE TABLE AS SELECT (CTAS).
- undeclared
Query Parameters This property is required. List<Property Map> - Standard SQL only: list of undeclared query parameters detected during a dry run validation.
JobStatistics3Response, JobStatistics3ResponseArgs
- Bad
Records This property is required. string - The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
- Input
File Bytes This property is required. string - Number of bytes of source data in a load job.
- Input
Files This property is required. string - Number of source files in a load job.
- Output
Bytes This property is required. string - Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
- Output
Rows This property is required. string - Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
- Bad
Records This property is required. 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.
- Input
File Bytes This property is required. string - Number of bytes of source data in a load job.
- Input
Files This property is required. string - Number of source files in a load job.
- Output
Bytes This property is required. string - Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
- Output
Rows This property is required. string - Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
- bad
Records This property is required. 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.
- input
File Bytes This property is required. String - Number of bytes of source data in a load job.
- input
Files This property is required. String - Number of source files in a load job.
- output
Bytes This property is required. String - Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
- output
Rows This property is required. String - Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
- bad
Records This property is required. 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.
- input
File Bytes This property is required. string - Number of bytes of source data in a load job.
- input
Files This property is required. string - Number of source files in a load job.
- output
Bytes This property is required. string - Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
- output
Rows This property is required. string - Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
- bad_
records This property is required. str - The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
- input_
file_ bytes This property is required. str - Number of bytes of source data in a load job.
- input_
files This property is required. str - Number of source files in a load job.
- output_
bytes This property is required. str - Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
- output_
rows This property is required. str - Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
- bad
Records This property is required. String - The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
- input
File Bytes This property is required. String - Number of bytes of source data in a load job.
- input
Files This property is required. String - Number of source files in a load job.
- output
Bytes This property is required. String - Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
- output
Rows This property is required. String - Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
JobStatistics4Response, JobStatistics4ResponseArgs
- Destination
Uri File Counts This property is required. List<string> - Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
- Input
Bytes This property is required. string - Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.
- Destination
Uri File Counts This property is required. []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.
- Input
Bytes This property is required. string - Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.
- destination
Uri File Counts This property is required. 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.
- input
Bytes This property is required. String - Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.
- destination
Uri File Counts This property is required. 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.
- input
Bytes This property is required. string - Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.
- destination_
uri_ file_ counts This property is required. Sequence[str] - Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
- input_
bytes This property is required. str - Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.
- destination
Uri File Counts This property is required. List<String> - Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
- input
Bytes This property is required. String - Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.
JobStatistics5Response, JobStatistics5ResponseArgs
- Copied
Logical Bytes This property is required. string - Number of logical bytes copied to the destination table.
- Copied
Rows This property is required. string - Number of rows copied to the destination table.
- Copied
Logical Bytes This property is required. string - Number of logical bytes copied to the destination table.
- Copied
Rows This property is required. string - Number of rows copied to the destination table.
- copied
Logical Bytes This property is required. String - Number of logical bytes copied to the destination table.
- copied
Rows This property is required. String - Number of rows copied to the destination table.
- copied
Logical Bytes This property is required. string - Number of logical bytes copied to the destination table.
- copied
Rows This property is required. string - Number of rows copied to the destination table.
- copied_
logical_ bytes This property is required. str - Number of logical bytes copied to the destination table.
- copied_
rows This property is required. str - Number of rows copied to the destination table.
- copied
Logical Bytes This property is required. String - Number of logical bytes copied to the destination table.
- copied
Rows This property is required. String - Number of rows copied to the destination table.
JobStatisticsReservationUsageItemResponse, JobStatisticsReservationUsageItemResponseArgs
JobStatisticsResponse, JobStatisticsResponseArgs
- Completion
Ratio This property is required. double - [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
- Copy
This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Job Statistics5Response - Statistics for a copy job.
- Creation
Time This property is required. string - Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
- Data
Masking Statistics This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Data Masking Statistics Response - Statistics for data masking. Present only for query and extract jobs.
- End
Time This property is required. string - End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
- Extract
This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Job Statistics4Response - Statistics for an extract job.
- Load
This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Job Statistics3Response - Statistics for a load job.
- Num
Child Jobs This property is required. string - Number of child jobs executed.
- Parent
Job Id This property is required. string - If this is a child job, the id of the parent.
- Query
This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Job Statistics2Response - Statistics for a query job.
- Quota
Deferments This property is required. List<string> - Quotas which delayed this job's start time.
- Reservation
Id This property is required. string - Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
- Reservation
Usage This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. Job Statistics Reservation Usage Item Response> - Job resource usage breakdown by reservation.
- Row
Level Security Statistics This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Row Level Security Statistics Response - [Preview] Statistics for row-level security. Present only for query and extract jobs.
- Script
Statistics This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Script Statistics Response - Statistics for a child job of a script.
- Session
Info This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Session Info Response - [Preview] Information of the session if this job is part of one.
- Start
Time This property is required. string - Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
- Total
Bytes Processed This property is required. string - [Deprecated] Use the bytes processed in the query statistics instead.
- Total
Slot Ms This property is required. string - Slot-milliseconds for the job.
- Transaction
Info This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Transaction Info Response - [Alpha] Information of the multi-statement transaction if this job is part of one.
- Completion
Ratio This property is required. float64 - [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
- Copy
This property is required. JobStatistics5Response - Statistics for a copy job.
- Creation
Time This property is required. string - Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
- Data
Masking Statistics This property is required. DataMasking Statistics Response - Statistics for data masking. Present only for query and extract jobs.
- End
Time This property is required. string - End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
- Extract
This property is required. JobStatistics4Response - Statistics for an extract job.
- Load
This property is required. JobStatistics3Response - Statistics for a load job.
- Num
Child Jobs This property is required. string - Number of child jobs executed.
- Parent
Job Id This property is required. string - If this is a child job, the id of the parent.
- Query
This property is required. JobStatistics2Response - Statistics for a query job.
- Quota
Deferments This property is required. []string - Quotas which delayed this job's start time.
- Reservation
Id This property is required. string - Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
- Reservation
Usage This property is required. []JobStatistics Reservation Usage Item Response - Job resource usage breakdown by reservation.
- Row
Level Security Statistics This property is required. RowLevel Security Statistics Response - [Preview] Statistics for row-level security. Present only for query and extract jobs.
- Script
Statistics This property is required. ScriptStatistics Response - Statistics for a child job of a script.
- Session
Info This property is required. SessionInfo Response - [Preview] Information of the session if this job is part of one.
- Start
Time This property is required. string - Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
- Total
Bytes Processed This property is required. string - [Deprecated] Use the bytes processed in the query statistics instead.
- Total
Slot Ms This property is required. string - Slot-milliseconds for the job.
- Transaction
Info This property is required. TransactionInfo Response - [Alpha] Information of the multi-statement transaction if this job is part of one.
- completion
Ratio This property is required. Double - [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
- copy
This property is required. JobStatistics5Response - Statistics for a copy job.
- creation
Time This property is required. String - Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
- data
Masking Statistics This property is required. DataMasking Statistics Response - Statistics for data masking. Present only for query and extract jobs.
- end
Time This property is required. String - End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
- extract
This property is required. JobStatistics4Response - Statistics for an extract job.
- load
This property is required. JobStatistics3Response - Statistics for a load job.
- num
Child Jobs This property is required. String - Number of child jobs executed.
- parent
Job Id This property is required. String - If this is a child job, the id of the parent.
- query
This property is required. JobStatistics2Response - Statistics for a query job.
- quota
Deferments This property is required. List<String> - Quotas which delayed this job's start time.
- reservation
Id This property is required. String - Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
- reservation
Usage This property is required. List<JobStatistics Reservation Usage Item Response> - Job resource usage breakdown by reservation.
- row
Level Security Statistics This property is required. RowLevel Security Statistics Response - [Preview] Statistics for row-level security. Present only for query and extract jobs.
- script
Statistics This property is required. ScriptStatistics Response - Statistics for a child job of a script.
- session
Info This property is required. SessionInfo Response - [Preview] Information of the session if this job is part of one.
- start
Time This property is required. String - Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
- total
Bytes Processed This property is required. String - [Deprecated] Use the bytes processed in the query statistics instead.
- total
Slot Ms This property is required. String - Slot-milliseconds for the job.
- transaction
Info This property is required. TransactionInfo Response - [Alpha] Information of the multi-statement transaction if this job is part of one.
- completion
Ratio This property is required. number - [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
- copy
This property is required. JobStatistics5Response - Statistics for a copy job.
- creation
Time This property is required. string - Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
- data
Masking Statistics This property is required. DataMasking Statistics Response - Statistics for data masking. Present only for query and extract jobs.
- end
Time This property is required. string - End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
- extract
This property is required. JobStatistics4Response - Statistics for an extract job.
- load
This property is required. JobStatistics3Response - Statistics for a load job.
- num
Child Jobs This property is required. string - Number of child jobs executed.
- parent
Job Id This property is required. string - If this is a child job, the id of the parent.
- query
This property is required. JobStatistics2Response - Statistics for a query job.
- quota
Deferments This property is required. string[] - Quotas which delayed this job's start time.
- reservation
Id This property is required. string - Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
- reservation
Usage This property is required. JobStatistics Reservation Usage Item Response[] - Job resource usage breakdown by reservation.
- row
Level Security Statistics This property is required. RowLevel Security Statistics Response - [Preview] Statistics for row-level security. Present only for query and extract jobs.
- script
Statistics This property is required. ScriptStatistics Response - Statistics for a child job of a script.
- session
Info This property is required. SessionInfo Response - [Preview] Information of the session if this job is part of one.
- start
Time This property is required. string - Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
- total
Bytes Processed This property is required. string - [Deprecated] Use the bytes processed in the query statistics instead.
- total
Slot Ms This property is required. string - Slot-milliseconds for the job.
- transaction
Info This property is required. TransactionInfo Response - [Alpha] Information of the multi-statement transaction if this job is part of one.
- completion_
ratio This property is required. float - [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
- copy
This property is required. JobStatistics5Response - Statistics for a copy job.
- creation_
time This property is required. str - Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
- data_
masking_ statistics This property is required. DataMasking Statistics Response - Statistics for data masking. Present only for query and extract jobs.
- end_
time This property is required. str - End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
- extract
This property is required. JobStatistics4Response - Statistics for an extract job.
- load
This property is required. JobStatistics3Response - Statistics for a load job.
- num_
child_ jobs This property is required. str - Number of child jobs executed.
- parent_
job_ id This property is required. str - If this is a child job, the id of the parent.
- query
This property is required. JobStatistics2Response - Statistics for a query job.
- quota_
deferments This property is required. Sequence[str] - Quotas which delayed this job's start time.
- reservation_
id This property is required. str - Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
- reservation_
usage This property is required. Sequence[JobStatistics Reservation Usage Item Response] - Job resource usage breakdown by reservation.
- row_
level_ security_ statistics This property is required. RowLevel Security Statistics Response - [Preview] Statistics for row-level security. Present only for query and extract jobs.
- script_
statistics This property is required. ScriptStatistics Response - Statistics for a child job of a script.
- session_
info This property is required. SessionInfo Response - [Preview] Information of the session if this job is part of one.
- start_
time This property is required. str - Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
- total_
bytes_ processed This property is required. str - [Deprecated] Use the bytes processed in the query statistics instead.
- total_
slot_ ms This property is required. str - Slot-milliseconds for the job.
- transaction_
info This property is required. TransactionInfo Response - [Alpha] Information of the multi-statement transaction if this job is part of one.
- completion
Ratio This property is required. Number - [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.
- copy
This property is required. Property Map - Statistics for a copy job.
- creation
Time This property is required. String - Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
- data
Masking Statistics This property is required. Property Map - Statistics for data masking. Present only for query and extract jobs.
- end
Time This property is required. String - End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
- extract
This property is required. Property Map - Statistics for an extract job.
- load
This property is required. Property Map - Statistics for a load job.
- num
Child Jobs This property is required. String - Number of child jobs executed.
- parent
Job Id This property is required. String - If this is a child job, the id of the parent.
- query
This property is required. Property Map - Statistics for a query job.
- quota
Deferments This property is required. List<String> - Quotas which delayed this job's start time.
- reservation
Id This property is required. String - Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
- reservation
Usage This property is required. List<Property Map> - Job resource usage breakdown by reservation.
- row
Level Security Statistics This property is required. Property Map - [Preview] Statistics for row-level security. Present only for query and extract jobs.
- script
Statistics This property is required. Property Map - Statistics for a child job of a script.
- session
Info This property is required. Property Map - [Preview] Information of the session if this job is part of one.
- start
Time This property is required. String - Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
- total
Bytes Processed This property is required. String - [Deprecated] Use the bytes processed in the query statistics instead.
- total
Slot Ms This property is required. String - Slot-milliseconds for the job.
- transaction
Info This property is required. Property Map - [Alpha] Information of the multi-statement transaction if this job is part of one.
JobStatusResponse, JobStatusResponseArgs
- Error
Result This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Error Proto Response - Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
- Errors
This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. Error Proto Response> - The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
- State
This property is required. string - Running state of the job.
- Error
Result This property is required. ErrorProto Response - Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
- Errors
This property is required. []ErrorProto Response - The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
- State
This property is required. string - Running state of the job.
- error
Result This property is required. ErrorProto Response - Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
- errors
This property is required. List<ErrorProto Response> - The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
- state
This property is required. String - Running state of the job.
- error
Result This property is required. ErrorProto Response - Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
- errors
This property is required. ErrorProto Response[] - The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
- state
This property is required. string - Running state of the job.
- error_
result This property is required. ErrorProto Response - Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
- errors
This property is required. Sequence[ErrorProto Response] - The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
- state
This property is required. str - Running state of the job.
- error
Result This property is required. Property Map - Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
- errors
This property is required. List<Property Map> - The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
- state
This property is required. String - Running state of the job.
MlStatisticsResponse, MlStatisticsResponseArgs
- Iteration
Results This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. Iteration Result Response> - Results for all completed iterations.
- Max
Iterations This property is required. string - Maximum number of iterations specified as max_iterations in the 'CREATE MODEL' query. The actual number of iterations may be less than this number due to early stop.
- Iteration
Results This property is required. []IterationResult Response - Results for all completed iterations.
- Max
Iterations This property is required. string - Maximum number of iterations specified as max_iterations in the 'CREATE MODEL' query. The actual number of iterations may be less than this number due to early stop.
- iteration
Results This property is required. List<IterationResult Response> - Results for all completed iterations.
- max
Iterations This property is required. String - Maximum number of iterations specified as max_iterations in the 'CREATE MODEL' query. The actual number of iterations may be less than this number due to early stop.
- iteration
Results This property is required. IterationResult Response[] - Results for all completed iterations.
- max
Iterations This property is required. string - Maximum number of iterations specified as max_iterations in the 'CREATE MODEL' query. The actual number of iterations may be less than this number due to early stop.
- iteration_
results This property is required. Sequence[IterationResult Response] - Results for all completed iterations.
- max_
iterations This property is required. str - Maximum number of iterations specified as max_iterations in the 'CREATE MODEL' query. The actual number of iterations may be less than this number due to early stop.
- iteration
Results This property is required. List<Property Map> - Results for all completed iterations.
- max
Iterations This property is required. String - Maximum number of iterations specified as max_iterations in the 'CREATE MODEL' query. The actual number of iterations may be less than this number due to early stop.
ModelReference, ModelReferenceArgs
- Dataset
Id This property is required. string - The ID of the dataset containing this model.
- Model
Id This property is required. string - The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- Project
This property is required. string - The ID of the project containing this model.
- Dataset
Id This property is required. string - The ID of the dataset containing this model.
- Model
Id This property is required. string - The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- Project
This property is required. string - The ID of the project containing this model.
- dataset
Id This property is required. String - The ID of the dataset containing this model.
- model
Id This property is required. String - The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- project
This property is required. String - The ID of the project containing this model.
- dataset
Id This property is required. string - The ID of the dataset containing this model.
- model
Id This property is required. string - The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- project
This property is required. string - The ID of the project containing this model.
- dataset_
id This property is required. str - The ID of the dataset containing this model.
- model_
id This property is required. str - The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- project
This property is required. str - The ID of the project containing this model.
- dataset
Id This property is required. String - The ID of the dataset containing this model.
- model
Id This property is required. String - The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- project
This property is required. String - The ID of the project containing this model.
ModelReferenceResponse, ModelReferenceResponseArgs
- Dataset
Id This property is required. string - The ID of the dataset containing this model.
- Model
Id This property is required. string - The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- Project
This property is required. string - The ID of the project containing this model.
- Dataset
Id This property is required. string - The ID of the dataset containing this model.
- Model
Id This property is required. string - The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- Project
This property is required. string - The ID of the project containing this model.
- dataset
Id This property is required. String - The ID of the dataset containing this model.
- model
Id This property is required. String - The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- project
This property is required. String - The ID of the project containing this model.
- dataset
Id This property is required. string - The ID of the dataset containing this model.
- model
Id This property is required. string - The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- project
This property is required. string - The ID of the project containing this model.
- dataset_
id This property is required. str - The ID of the dataset containing this model.
- model_
id This property is required. str - The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- project
This property is required. str - The ID of the project containing this model.
- dataset
Id This property is required. String - The ID of the dataset containing this model.
- model
Id This property is required. String - The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- project
This property is required. String - The ID of the project containing this model.
ParquetOptions, ParquetOptionsArgs
- Enable
List boolInference - [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.
- Enum
As boolString - [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
- Enable
List boolInference - [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.
- Enum
As boolString - [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
- enable
List BooleanInference - [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.
- enum
As BooleanString - [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
- enable
List booleanInference - [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.
- enum
As booleanString - [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
- enable_
list_ boolinference - [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.
- enum_
as_ boolstring - [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
- enable
List BooleanInference - [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.
- enum
As BooleanString - [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
ParquetOptionsResponse, ParquetOptionsResponseArgs
- Enable
List Inference This property is required. bool - [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.
- Enum
As String This property is required. bool - [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
- Enable
List Inference This property is required. bool - [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.
- Enum
As String This property is required. bool - [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
- enable
List Inference This property is required. Boolean - [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.
- enum
As String This property is required. Boolean - [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
- enable
List Inference This property is required. boolean - [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.
- enum
As String This property is required. boolean - [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
- enable_
list_ inference This property is required. bool - [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.
- enum_
as_ string This property is required. bool - [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
- enable
List Inference This property is required. Boolean - [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.
- enum
As String This property is required. Boolean - [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.
QueryParameter, QueryParameterArgs
- Name string
- [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
- Parameter
Type Pulumi.Google Native. Big Query. V2. Inputs. Query Parameter Type - [Required] The type of this parameter.
- Parameter
Value Pulumi.Google Native. Big Query. V2. Inputs. Query Parameter Value - [Required] The value of this parameter.
- Name string
- [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
- Parameter
Type QueryParameter Type - [Required] The type of this parameter.
- Parameter
Value QueryParameter Value - [Required] The value of this parameter.
- name String
- [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
- parameter
Type QueryParameter Type - [Required] The type of this parameter.
- parameter
Value QueryParameter Value - [Required] The value of this parameter.
- name string
- [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
- parameter
Type QueryParameter Type - [Required] The type of this parameter.
- parameter
Value QueryParameter Value - [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 QueryParameter Type - [Required] The type of this parameter.
- parameter_
value QueryParameter Value - [Required] The value of this parameter.
- name String
- [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
- parameter
Type Property Map - [Required] The type of this parameter.
- parameter
Value Property Map - [Required] The value of this parameter.
QueryParameterResponse, QueryParameterResponseArgs
- Name
This property is required. string - [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
- Parameter
Type This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Query Parameter Type Response - [Required] The type of this parameter.
- Parameter
Value This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Query Parameter Value Response - [Required] The value of this parameter.
- Name
This property is required. string - [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
- Parameter
Type This property is required. QueryParameter Type Response - [Required] The type of this parameter.
- Parameter
Value This property is required. QueryParameter Value Response - [Required] The value of this parameter.
- name
This property is required. String - [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
- parameter
Type This property is required. QueryParameter Type Response - [Required] The type of this parameter.
- parameter
Value This property is required. QueryParameter Value Response - [Required] The value of this parameter.
- name
This property is required. string - [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
- parameter
Type This property is required. QueryParameter Type Response - [Required] The type of this parameter.
- parameter
Value This property is required. QueryParameter Value Response - [Required] The value of this parameter.
- name
This property is required. str - [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
- parameter_
type This property is required. QueryParameter Type Response - [Required] The type of this parameter.
- parameter_
value This property is required. QueryParameter Value Response - [Required] The value of this parameter.
- name
This property is required. String - [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
- parameter
Type This property is required. Property Map - [Required] The type of this parameter.
- parameter
Value This property is required. Property Map - [Required] The value of this parameter.
QueryParameterType, QueryParameterTypeArgs
- Array
Type Pulumi.Google Native. Big Query. V2. Inputs. Query Parameter Type - [Optional] The type of the array's elements, if this is an array.
- Struct
Types List<Pulumi.Google Native. Big Query. V2. Inputs. Query Parameter Type Struct Types Item> - [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.
- Array
Type QueryParameter Type - [Optional] The type of the array's elements, if this is an array.
- Struct
Types []QueryParameter Type Struct Types Item - [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.
- array
Type QueryParameter Type - [Optional] The type of the array's elements, if this is an array.
- struct
Types List<QueryParameter Type Struct Types Item> - [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.
- array
Type QueryParameter Type - [Optional] The type of the array's elements, if this is an array.
- struct
Types QueryParameter Type Struct Types Item[] - [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.
- array_
type QueryParameter Type - [Optional] The type of the array's elements, if this is an array.
- struct_
types Sequence[QueryParameter Type Struct Types Item] - [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 Property Map - [Optional] The type of the array's elements, if this is an array.
- struct
Types 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.
QueryParameterTypeResponse, QueryParameterTypeResponseArgs
- Struct
Types This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. Query Parameter Type Struct Types Item Response> - [Optional] The types of the fields of this struct, in order, if this is a struct.
- Type
This property is required. string - [Required] The top level type of this field.
- Array
Type Pulumi.Google Native. Big Query. V2. Inputs. Query Parameter Type Response - [Optional] The type of the array's elements, if this is an array.
- Struct
Types This property is required. []QueryParameter Type Struct Types Item Response - [Optional] The types of the fields of this struct, in order, if this is a struct.
- Type
This property is required. string - [Required] The top level type of this field.
- Array
Type QueryParameter Type Response - [Optional] The type of the array's elements, if this is an array.
- struct
Types This property is required. List<QueryParameter Type Struct Types Item Response> - [Optional] The types of the fields of this struct, in order, if this is a struct.
- type
This property is required. String - [Required] The top level type of this field.
- array
Type QueryParameter Type Response - [Optional] The type of the array's elements, if this is an array.
- struct
Types This property is required. QueryParameter Type Struct Types Item Response[] - [Optional] The types of the fields of this struct, in order, if this is a struct.
- type
This property is required. string - [Required] The top level type of this field.
- array
Type QueryParameter Type Response - [Optional] The type of the array's elements, if this is an array.
- struct_
types This property is required. Sequence[QueryParameter Type Struct Types Item Response] - [Optional] The types of the fields of this struct, in order, if this is a struct.
- type
This property is required. str - [Required] The top level type of this field.
- array_
type QueryParameter Type Response - [Optional] The type of the array's elements, if this is an array.
- struct
Types This property is required. List<Property Map> - [Optional] The types of the fields of this struct, in order, if this is a struct.
- type
This property is required. String - [Required] The top level type of this field.
- array
Type Property Map - [Optional] The type of the array's elements, if this is an array.
QueryParameterTypeStructTypesItem, QueryParameterTypeStructTypesItemArgs
- Description string
- [Optional] Human-oriented description of the field.
- Name string
- [Optional] The name of this field.
- Type
Pulumi.
Google Native. Big Query. V2. Inputs. Query Parameter Type - [Required] The type of this field.
- Description string
- [Optional] Human-oriented description of the field.
- Name string
- [Optional] The name of this field.
- Type
Query
Parameter Type - [Required] The type of this field.
- description String
- [Optional] Human-oriented description of the field.
- name String
- [Optional] The name of this field.
- type
Query
Parameter Type - [Required] The type of this field.
- description string
- [Optional] Human-oriented description of the field.
- name string
- [Optional] The name of this field.
- type
Query
Parameter Type - [Required] The type of this field.
- description str
- [Optional] Human-oriented description of the field.
- name str
- [Optional] The name of this field.
- type
Query
Parameter Type - [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.
QueryParameterTypeStructTypesItemResponse, QueryParameterTypeStructTypesItemResponseArgs
- Description
This property is required. string - [Optional] Human-oriented description of the field.
- Name
This property is required. string - [Optional] The name of this field.
- Type
This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Query Parameter Type Response - [Required] The type of this field.
- Description
This property is required. string - [Optional] Human-oriented description of the field.
- Name
This property is required. string - [Optional] The name of this field.
- Type
This property is required. QueryParameter Type Response - [Required] The type of this field.
- description
This property is required. String - [Optional] Human-oriented description of the field.
- name
This property is required. String - [Optional] The name of this field.
- type
This property is required. QueryParameter Type Response - [Required] The type of this field.
- description
This property is required. string - [Optional] Human-oriented description of the field.
- name
This property is required. string - [Optional] The name of this field.
- type
This property is required. QueryParameter Type Response - [Required] The type of this field.
- description
This property is required. str - [Optional] Human-oriented description of the field.
- name
This property is required. str - [Optional] The name of this field.
- type
This property is required. QueryParameter Type Response - [Required] The type of this field.
- description
This property is required. String - [Optional] Human-oriented description of the field.
- name
This property is required. String - [Optional] The name of this field.
- type
This property is required. Property Map - [Required] The type of this field.
QueryParameterValue, QueryParameterValueArgs
- Array
Values List<Pulumi.Google Native. Big Query. V2. Inputs. Query Parameter Value> - [Optional] The array values, if this is an array type.
- Struct
Values 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.
- Array
Values []QueryParameter Value - [Optional] The array values, if this is an array type.
- Struct
Values 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.
- array
Values List<QueryParameter Value> - [Optional] The array values, if this is an array type.
- struct
Values 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.
- array
Values QueryParameter Value[] - [Optional] The array values, if this is an array type.
- struct
Values {[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[QueryParameter Value] - [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.
- array
Values List<Property Map> - [Optional] The array values, if this is an array type.
- struct
Values 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.
QueryParameterValueResponse, QueryParameterValueResponseArgs
- Array
Values This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. Query Parameter Value Response> - [Optional] The array values, if this is an array type.
- Struct
Values This property is required. Dictionary<string, string> - [Optional] The struct field values, in order of the struct type's declaration.
- Value
This property is required. string - [Optional] The value of this value, if a simple scalar type.
- Array
Values This property is required. []QueryParameter Value Response - [Optional] The array values, if this is an array type.
- Struct
Values This property is required. map[string]string - [Optional] The struct field values, in order of the struct type's declaration.
- Value
This property is required. string - [Optional] The value of this value, if a simple scalar type.
- array
Values This property is required. List<QueryParameter Value Response> - [Optional] The array values, if this is an array type.
- struct
Values This property is required. Map<String,String> - [Optional] The struct field values, in order of the struct type's declaration.
- value
This property is required. String - [Optional] The value of this value, if a simple scalar type.
- array
Values This property is required. QueryParameter Value Response[] - [Optional] The array values, if this is an array type.
- struct
Values This property is required. {[key: string]: string} - [Optional] The struct field values, in order of the struct type's declaration.
- value
This property is required. string - [Optional] The value of this value, if a simple scalar type.
- array_
values This property is required. Sequence[QueryParameter Value Response] - [Optional] The array values, if this is an array type.
- struct_
values This property is required. Mapping[str, str] - [Optional] The struct field values, in order of the struct type's declaration.
- value
This property is required. str - [Optional] The value of this value, if a simple scalar type.
- array
Values This property is required. List<Property Map> - [Optional] The array values, if this is an array type.
- struct
Values This property is required. Map<String> - [Optional] The struct field values, in order of the struct type's declaration.
- value
This property is required. String - [Optional] The value of this value, if a simple scalar type.
QueryTimelineSampleResponse, QueryTimelineSampleResponseArgs
- Active
Units This property is required. string - Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
- Completed
Units This property is required. string - Total parallel units of work completed by this query.
- Elapsed
Ms This property is required. string - Milliseconds elapsed since the start of query execution.
- Estimated
Runnable Units This property is required. string - Units of work that can be scheduled immediately. Providing additional slots for these units of work will speed up the query, provided no other query in the reservation needs additional slots.
- Pending
Units This property is required. string - Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
- Total
Slot Ms This property is required. string - Cumulative slot-ms consumed by the query.
- Active
Units This property is required. string - Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
- Completed
Units This property is required. string - Total parallel units of work completed by this query.
- Elapsed
Ms This property is required. string - Milliseconds elapsed since the start of query execution.
- Estimated
Runnable Units This property is required. string - Units of work that can be scheduled immediately. Providing additional slots for these units of work will speed up the query, provided no other query in the reservation needs additional slots.
- Pending
Units This property is required. string - Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
- Total
Slot Ms This property is required. string - Cumulative slot-ms consumed by the query.
- active
Units This property is required. String - Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
- completed
Units This property is required. String - Total parallel units of work completed by this query.
- elapsed
Ms This property is required. String - Milliseconds elapsed since the start of query execution.
- estimated
Runnable Units This property is required. String - Units of work that can be scheduled immediately. Providing additional slots for these units of work will speed up the query, provided no other query in the reservation needs additional slots.
- pending
Units This property is required. String - Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
- total
Slot Ms This property is required. String - Cumulative slot-ms consumed by the query.
- active
Units This property is required. string - Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
- completed
Units This property is required. string - Total parallel units of work completed by this query.
- elapsed
Ms This property is required. string - Milliseconds elapsed since the start of query execution.
- estimated
Runnable Units This property is required. string - Units of work that can be scheduled immediately. Providing additional slots for these units of work will speed up the query, provided no other query in the reservation needs additional slots.
- pending
Units This property is required. string - Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
- total
Slot Ms This property is required. string - Cumulative slot-ms consumed by the query.
- active_
units This property is required. str - Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
- completed_
units This property is required. str - Total parallel units of work completed by this query.
- elapsed_
ms This property is required. str - Milliseconds elapsed since the start of query execution.
- estimated_
runnable_ units This property is required. str - Units of work that can be scheduled immediately. Providing additional slots for these units of work will speed up the query, provided no other query in the reservation needs additional slots.
- pending_
units This property is required. str - Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
- total_
slot_ ms This property is required. str - Cumulative slot-ms consumed by the query.
- active
Units This property is required. String - Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
- completed
Units This property is required. String - Total parallel units of work completed by this query.
- elapsed
Ms This property is required. String - Milliseconds elapsed since the start of query execution.
- estimated
Runnable Units This property is required. String - Units of work that can be scheduled immediately. Providing additional slots for these units of work will speed up the query, provided no other query in the reservation needs additional slots.
- pending
Units This property is required. String - Total units of work remaining for the query. This number can be revised (increased or decreased) while the query is running.
- total
Slot Ms This property is required. String - Cumulative slot-ms consumed by the query.
RangePartitioning, RangePartitioningArgs
- 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.
Google Native. Big Query. V2. Inputs. Range Partitioning Range - [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
Range
Partitioning Range - [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
Range
Partitioning Range - [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
Range
Partitioning Range - [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
Range
Partitioning Range - [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.
RangePartitioningRange, RangePartitioningRangeArgs
RangePartitioningRangeResponse, RangePartitioningRangeResponseArgs
- End
This property is required. string - [TrustedTester] [Required] The end of range partitioning, exclusive.
- Interval
This property is required. string - [TrustedTester] [Required] The width of each interval.
- Start
This property is required. string - [TrustedTester] [Required] The start of range partitioning, inclusive.
- End
This property is required. string - [TrustedTester] [Required] The end of range partitioning, exclusive.
- Interval
This property is required. string - [TrustedTester] [Required] The width of each interval.
- Start
This property is required. string - [TrustedTester] [Required] The start of range partitioning, inclusive.
- end
This property is required. String - [TrustedTester] [Required] The end of range partitioning, exclusive.
- interval
This property is required. String - [TrustedTester] [Required] The width of each interval.
- start
This property is required. String - [TrustedTester] [Required] The start of range partitioning, inclusive.
- end
This property is required. string - [TrustedTester] [Required] The end of range partitioning, exclusive.
- interval
This property is required. string - [TrustedTester] [Required] The width of each interval.
- start
This property is required. string - [TrustedTester] [Required] The start of range partitioning, inclusive.
- end
This property is required. str - [TrustedTester] [Required] The end of range partitioning, exclusive.
- interval
This property is required. str - [TrustedTester] [Required] The width of each interval.
- start
This property is required. str - [TrustedTester] [Required] The start of range partitioning, inclusive.
- end
This property is required. String - [TrustedTester] [Required] The end of range partitioning, exclusive.
- interval
This property is required. String - [TrustedTester] [Required] The width of each interval.
- start
This property is required. String - [TrustedTester] [Required] The start of range partitioning, inclusive.
RangePartitioningResponse, RangePartitioningResponseArgs
- Field
This property is required. string - [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
- Range
This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Range Partitioning Range Response - [TrustedTester] [Required] Defines the ranges for range partitioning.
- Field
This property is required. string - [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
- Range
This property is required. RangePartitioning Range Response - [TrustedTester] [Required] Defines the ranges for range partitioning.
- field
This property is required. String - [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
- range
This property is required. RangePartitioning Range Response - [TrustedTester] [Required] Defines the ranges for range partitioning.
- field
This property is required. string - [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
- range
This property is required. RangePartitioning Range Response - [TrustedTester] [Required] Defines the ranges for range partitioning.
- field
This property is required. str - [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
- range
This property is required. RangePartitioning Range Response - [TrustedTester] [Required] Defines the ranges for range partitioning.
- field
This property is required. String - [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
- range
This property is required. Property Map - [TrustedTester] [Required] Defines the ranges for range partitioning.
RoutineReferenceResponse, RoutineReferenceResponseArgs
- Dataset
Id This property is required. string - The ID of the dataset containing this routine.
- Project
This property is required. string - The ID of the project containing this routine.
- Routine
Id This property is required. string - The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
- Dataset
Id This property is required. string - The ID of the dataset containing this routine.
- Project
This property is required. string - The ID of the project containing this routine.
- Routine
Id This property is required. string - The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
- dataset
Id This property is required. String - The ID of the dataset containing this routine.
- project
This property is required. String - The ID of the project containing this routine.
- routine
Id This property is required. String - The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
- dataset
Id This property is required. string - The ID of the dataset containing this routine.
- project
This property is required. string - The ID of the project containing this routine.
- routine
Id This property is required. string - The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
- dataset_
id This property is required. str - The ID of the dataset containing this routine.
- project
This property is required. str - The ID of the project containing this routine.
- routine_
id This property is required. str - The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
- dataset
Id This property is required. String - The ID of the dataset containing this routine.
- project
This property is required. String - The ID of the project containing this routine.
- routine
Id This property is required. String - The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
RowAccessPolicyReferenceResponse, RowAccessPolicyReferenceResponseArgs
- Dataset
Id This property is required. string - The ID of the dataset containing this row access policy.
- Policy
Id This property is required. string - The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
- Project
This property is required. string - The ID of the project containing this row access policy.
- Table
Id This property is required. string - The ID of the table containing this row access policy.
- Dataset
Id This property is required. string - The ID of the dataset containing this row access policy.
- Policy
Id This property is required. string - The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
- Project
This property is required. string - The ID of the project containing this row access policy.
- Table
Id This property is required. string - The ID of the table containing this row access policy.
- dataset
Id This property is required. String - The ID of the dataset containing this row access policy.
- policy
Id This property is required. String - The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
- project
This property is required. String - The ID of the project containing this row access policy.
- table
Id This property is required. String - The ID of the table containing this row access policy.
- dataset
Id This property is required. string - The ID of the dataset containing this row access policy.
- policy
Id This property is required. string - The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
- project
This property is required. string - The ID of the project containing this row access policy.
- table
Id This property is required. string - The ID of the table containing this row access policy.
- dataset_
id This property is required. str - The ID of the dataset containing this row access policy.
- policy_
id This property is required. str - The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
- project
This property is required. str - The ID of the project containing this row access policy.
- table_
id This property is required. str - The ID of the table containing this row access policy.
- dataset
Id This property is required. String - The ID of the dataset containing this row access policy.
- policy
Id This property is required. String - The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
- project
This property is required. String - The ID of the project containing this row access policy.
- table
Id This property is required. String - The ID of the table containing this row access policy.
RowLevelSecurityStatisticsResponse, RowLevelSecurityStatisticsResponseArgs
- Row
Level Security Applied This property is required. bool - [Preview] Whether any accessed data was protected by row access policies.
- Row
Level Security Applied This property is required. bool - [Preview] Whether any accessed data was protected by row access policies.
- row
Level Security Applied This property is required. Boolean - [Preview] Whether any accessed data was protected by row access policies.
- row
Level Security Applied This property is required. boolean - [Preview] Whether any accessed data was protected by row access policies.
- row_
level_ security_ applied This property is required. bool - [Preview] Whether any accessed data was protected by row access policies.
- row
Level Security Applied This property is required. Boolean - [Preview] Whether any accessed data was protected by row access policies.
ScriptStackFrameResponse, ScriptStackFrameResponseArgs
- End
Column This property is required. int - One-based end column.
- End
Line This property is required. int - One-based end line.
- Procedure
Id This property is required. string - Name of the active procedure, empty if in a top-level script.
- Start
Column This property is required. int - One-based start column.
- Start
Line This property is required. int - One-based start line.
- Text
This property is required. string - Text of the current statement/expression.
- End
Column This property is required. int - One-based end column.
- End
Line This property is required. int - One-based end line.
- Procedure
Id This property is required. string - Name of the active procedure, empty if in a top-level script.
- Start
Column This property is required. int - One-based start column.
- Start
Line This property is required. int - One-based start line.
- Text
This property is required. string - Text of the current statement/expression.
- end
Column This property is required. Integer - One-based end column.
- end
Line This property is required. Integer - One-based end line.
- procedure
Id This property is required. String - Name of the active procedure, empty if in a top-level script.
- start
Column This property is required. Integer - One-based start column.
- start
Line This property is required. Integer - One-based start line.
- text
This property is required. String - Text of the current statement/expression.
- end
Column This property is required. number - One-based end column.
- end
Line This property is required. number - One-based end line.
- procedure
Id This property is required. string - Name of the active procedure, empty if in a top-level script.
- start
Column This property is required. number - One-based start column.
- start
Line This property is required. number - One-based start line.
- text
This property is required. string - Text of the current statement/expression.
- end_
column This property is required. int - One-based end column.
- end_
line This property is required. int - One-based end line.
- procedure_
id This property is required. str - Name of the active procedure, empty if in a top-level script.
- start_
column This property is required. int - One-based start column.
- start_
line This property is required. int - One-based start line.
- text
This property is required. str - Text of the current statement/expression.
- end
Column This property is required. Number - One-based end column.
- end
Line This property is required. Number - One-based end line.
- procedure
Id This property is required. String - Name of the active procedure, empty if in a top-level script.
- start
Column This property is required. Number - One-based start column.
- start
Line This property is required. Number - One-based start line.
- text
This property is required. String - Text of the current statement/expression.
ScriptStatisticsResponse, ScriptStatisticsResponseArgs
- Evaluation
Kind This property is required. string - Whether this child job was a statement or expression.
- Stack
Frames This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. Script Stack Frame Response> - Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.
- Evaluation
Kind This property is required. string - Whether this child job was a statement or expression.
- Stack
Frames This property is required. []ScriptStack Frame Response - Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.
- evaluation
Kind This property is required. String - Whether this child job was a statement or expression.
- stack
Frames This property is required. List<ScriptStack Frame Response> - Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.
- evaluation
Kind This property is required. string - Whether this child job was a statement or expression.
- stack
Frames This property is required. ScriptStack Frame Response[] - Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.
- evaluation_
kind This property is required. str - Whether this child job was a statement or expression.
- stack_
frames This property is required. Sequence[ScriptStack Frame Response] - Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.
- evaluation
Kind This property is required. String - Whether this child job was a statement or expression.
- stack
Frames This property is required. List<Property Map> - Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.
SearchStatisticsResponse, SearchStatisticsResponseArgs
- Index
Unused Reasons This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. Index Unused Reason Response> - When index_usage_mode is UNUSED or PARTIALLY_USED, this field explains why index was not used in all or part of the search query. If index_usage_mode is FULLLY_USED, this field is not populated.
- Index
Usage Mode This property is required. string - Specifies index usage mode for the query.
- Index
Unused Reasons This property is required. []IndexUnused Reason Response - When index_usage_mode is UNUSED or PARTIALLY_USED, this field explains why index was not used in all or part of the search query. If index_usage_mode is FULLLY_USED, this field is not populated.
- Index
Usage Mode This property is required. string - Specifies index usage mode for the query.
- index
Unused Reasons This property is required. List<IndexUnused Reason Response> - When index_usage_mode is UNUSED or PARTIALLY_USED, this field explains why index was not used in all or part of the search query. If index_usage_mode is FULLLY_USED, this field is not populated.
- index
Usage Mode This property is required. String - Specifies index usage mode for the query.
- index
Unused Reasons This property is required. IndexUnused Reason Response[] - When index_usage_mode is UNUSED or PARTIALLY_USED, this field explains why index was not used in all or part of the search query. If index_usage_mode is FULLLY_USED, this field is not populated.
- index
Usage Mode This property is required. string - Specifies index usage mode for the query.
- index_
unused_ reasons This property is required. Sequence[IndexUnused Reason Response] - When index_usage_mode is UNUSED or PARTIALLY_USED, this field explains why index was not used in all or part of the search query. If index_usage_mode is FULLLY_USED, this field is not populated.
- index_
usage_ mode This property is required. str - Specifies index usage mode for the query.
- index
Unused Reasons This property is required. List<Property Map> - When index_usage_mode is UNUSED or PARTIALLY_USED, this field explains why index was not used in all or part of the search query. If index_usage_mode is FULLLY_USED, this field is not populated.
- index
Usage Mode This property is required. String - Specifies index usage mode for the query.
SessionInfoResponse, SessionInfoResponseArgs
- Session
Id This property is required. string - // [Preview] Id of the session.
- Session
Id This property is required. string - // [Preview] Id of the session.
- session
Id This property is required. String - // [Preview] Id of the session.
- session
Id This property is required. string - // [Preview] Id of the session.
- session_
id This property is required. str - // [Preview] Id of the session.
- session
Id This property is required. String - // [Preview] Id of the session.
SparkLoggingInfoResponse, SparkLoggingInfoResponseArgs
- Project
This property is required. string - Project ID used for logging
- Resource
Type This property is required. string - Resource type used for logging
- Project
This property is required. string - Project ID used for logging
- Resource
Type This property is required. string - Resource type used for logging
- project
This property is required. String - Project ID used for logging
- resource
Type This property is required. String - Resource type used for logging
- project
This property is required. string - Project ID used for logging
- resource
Type This property is required. string - Resource type used for logging
- project
This property is required. str - Project ID used for logging
- resource_
type This property is required. str - Resource type used for logging
- project
This property is required. String - Project ID used for logging
- resource
Type This property is required. String - Resource type used for logging
SparkStatisticsResponse, SparkStatisticsResponseArgs
- Endpoints
This property is required. Dictionary<string, string> - Endpoints generated for the Spark job.
- Logging
Info This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Spark Logging Info Response - Logging info is used to generate a link to Cloud Logging.
- Spark
Job Id This property is required. string - Spark job id if a Spark job is created successfully.
- Spark
Job Location This property is required. string - Location where the Spark job is executed.
- Endpoints
This property is required. map[string]string - Endpoints generated for the Spark job.
- Logging
Info This property is required. SparkLogging Info Response - Logging info is used to generate a link to Cloud Logging.
- Spark
Job Id This property is required. string - Spark job id if a Spark job is created successfully.
- Spark
Job Location This property is required. string - Location where the Spark job is executed.
- endpoints
This property is required. Map<String,String> - Endpoints generated for the Spark job.
- logging
Info This property is required. SparkLogging Info Response - Logging info is used to generate a link to Cloud Logging.
- spark
Job Id This property is required. String - Spark job id if a Spark job is created successfully.
- spark
Job Location This property is required. String - Location where the Spark job is executed.
- endpoints
This property is required. {[key: string]: string} - Endpoints generated for the Spark job.
- logging
Info This property is required. SparkLogging Info Response - Logging info is used to generate a link to Cloud Logging.
- spark
Job Id This property is required. string - Spark job id if a Spark job is created successfully.
- spark
Job Location This property is required. string - Location where the Spark job is executed.
- endpoints
This property is required. Mapping[str, str] - Endpoints generated for the Spark job.
- logging_
info This property is required. SparkLogging Info Response - Logging info is used to generate a link to Cloud Logging.
- spark_
job_ id This property is required. str - Spark job id if a Spark job is created successfully.
- spark_
job_ location This property is required. str - Location where the Spark job is executed.
- endpoints
This property is required. Map<String> - Endpoints generated for the Spark job.
- logging
Info This property is required. Property Map - Logging info is used to generate a link to Cloud Logging.
- spark
Job Id This property is required. String - Spark job id if a Spark job is created successfully.
- spark
Job Location This property is required. String - Location where the Spark job is executed.
TableFieldSchema, TableFieldSchemaArgs
- Categories
Pulumi.
Google Native. Big Query. V2. Inputs. Table Field Schema Categories - [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.
- Default
Value stringExpression - 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.
Google Native. Big Query. V2. Inputs. Table Field Schema> - [Optional] Describes the nested schema fields if the type property is set to RECORD.
- Max
Length 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.
- Pulumi.
Google Native. Big Query. V2. Inputs. Table Field Schema Policy Tags - 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.
- Range
Element Pulumi.Type Google Native. Big Query. V2. Inputs. Table Field Schema Range Element Type - Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP
- Rounding
Mode string - Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields.
- 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
Table
Field Schema Categories - [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.
- Default
Value stringExpression - 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
[]Table
Field Schema - [Optional] Describes the nested schema fields if the type property is set to RECORD.
- Max
Length 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.
- Table
Field Schema Policy Tags - 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.
- Range
Element TableType Field Schema Range Element Type - Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP
- Rounding
Mode string - Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields.
- 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
Table
Field Schema Categories - [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.
- default
Value StringExpression - 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<Table
Field Schema> - [Optional] Describes the nested schema fields if the type property is set to RECORD.
- max
Length 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.
- Table
Field Schema Policy Tags - 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.
- range
Element TableType Field Schema Range Element Type - Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP
- rounding
Mode String - Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields.
- 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
Table
Field Schema Categories - [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.
- default
Value stringExpression - 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
Table
Field Schema[] - [Optional] Describes the nested schema fields if the type property is set to RECORD.
- max
Length 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.
- Table
Field Schema Policy Tags - 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.
- range
Element TableType Field Schema Range Element Type - Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP
- rounding
Mode string - Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields.
- 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
Table
Field Schema Categories - [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_ strexpression - 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[Table
Field Schema] - [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.
- Table
Field Schema Policy Tags - 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.
- range_
element_ Tabletype Field Schema Range Element Type - Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP
- rounding_
mode str - Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields.
- 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.
- default
Value StringExpression - 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.
- max
Length 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.
- 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.
- range
Element Property MapType - Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP
- rounding
Mode String - Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields.
- 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).
TableFieldSchemaCategories, TableFieldSchemaCategoriesArgs
- 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.
TableFieldSchemaCategoriesResponse, TableFieldSchemaCategoriesResponseArgs
- Names
This property is required. List<string> - A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.
- Names
This property is required. []string - A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.
- names
This property is required. List<String> - A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.
- names
This property is required. string[] - A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.
- names
This property is required. Sequence[str] - A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.
- names
This property is required. List<String> - A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.
TableFieldSchemaPolicyTags, TableFieldSchemaPolicyTagsArgs
- 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.
TableFieldSchemaPolicyTagsResponse, TableFieldSchemaPolicyTagsResponseArgs
- Names
This property is required. List<string> - A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.
- Names
This property is required. []string - A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.
- names
This property is required. List<String> - A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.
- names
This property is required. string[] - A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.
- names
This property is required. Sequence[str] - A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.
- names
This property is required. List<String> - A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.
TableFieldSchemaRangeElementType, TableFieldSchemaRangeElementTypeArgs
- Type string
- The field element type of a RANGE
- Type string
- The field element type of a RANGE
- type String
- The field element type of a RANGE
- type string
- The field element type of a RANGE
- type str
- The field element type of a RANGE
- type String
- The field element type of a RANGE
TableFieldSchemaRangeElementTypeResponse, TableFieldSchemaRangeElementTypeResponseArgs
- Type
This property is required. string - The field element type of a RANGE
- Type
This property is required. string - The field element type of a RANGE
- type
This property is required. String - The field element type of a RANGE
- type
This property is required. string - The field element type of a RANGE
- type
This property is required. str - The field element type of a RANGE
- type
This property is required. String - The field element type of a RANGE
TableFieldSchemaResponse, TableFieldSchemaResponseArgs
- Categories
This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Table Field Schema Categories Response - [Optional] The categories attached to this field, used for field-level access control.
- Collation
This property is required. string - Optional. Collation specification of the field. It only can be set on string type field.
- Default
Value Expression This property is required. string - Optional. A SQL expression to specify the default value for this field. It can only be set for top level fields (columns). You can use struct or array expression to specify default value for the entire struct or array. The valid SQL expressions are: - Literals for all data types, including STRUCT and ARRAY. - Following functions: - CURRENT_TIMESTAMP - CURRENT_TIME - CURRENT_DATE - CURRENT_DATETIME - GENERATE_UUID - RAND - SESSION_USER - ST_GEOGPOINT - Struct or array composed with the above allowed functions, for example, [CURRENT_DATE(), DATE '2020-01-01']
- Description
This property is required. string - [Optional] The field description. The maximum length is 1,024 characters.
- Fields
This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. Table Field Schema Response> - [Optional] Describes the nested schema fields if the type property is set to RECORD.
- Max
Length This property is required. string - [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES".
- Mode
This property is required. string - [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
- Name
This property is required. string - [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Table Field Schema Policy Tags Response - Precision
This property is required. string - [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid.
- Range
Element Type This property is required. Pulumi.Google Native. Big Query. V2. Inputs. Table Field Schema Range Element Type Response - Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP
- Rounding
Mode This property is required. string - Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields.
- Scale
This property is required. string - [Optional] See documentation for precision.
- Type
This property is required. string - [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
- Categories
This property is required. TableField Schema Categories Response - [Optional] The categories attached to this field, used for field-level access control.
- Collation
This property is required. string - Optional. Collation specification of the field. It only can be set on string type field.
- Default
Value Expression This property is required. string - Optional. A SQL expression to specify the default value for this field. It can only be set for top level fields (columns). You can use struct or array expression to specify default value for the entire struct or array. The valid SQL expressions are: - Literals for all data types, including STRUCT and ARRAY. - Following functions: - CURRENT_TIMESTAMP - CURRENT_TIME - CURRENT_DATE - CURRENT_DATETIME - GENERATE_UUID - RAND - SESSION_USER - ST_GEOGPOINT - Struct or array composed with the above allowed functions, for example, [CURRENT_DATE(), DATE '2020-01-01']
- Description
This property is required. string - [Optional] The field description. The maximum length is 1,024 characters.
- Fields
This property is required. []TableField Schema Response - [Optional] Describes the nested schema fields if the type property is set to RECORD.
- Max
Length This property is required. string - [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES".
- Mode
This property is required. string - [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
- Name
This property is required. string - [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
This property is required. TableField Schema Policy Tags Response - Precision
This property is required. string - [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid.
- Range
Element Type This property is required. TableField Schema Range Element Type Response - Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP
- Rounding
Mode This property is required. string - Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields.
- Scale
This property is required. string - [Optional] See documentation for precision.
- Type
This property is required. string - [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
- categories
This property is required. TableField Schema Categories Response - [Optional] The categories attached to this field, used for field-level access control.
- collation
This property is required. String - Optional. Collation specification of the field. It only can be set on string type field.
- default
Value Expression This property is required. String - Optional. A SQL expression to specify the default value for this field. It can only be set for top level fields (columns). You can use struct or array expression to specify default value for the entire struct or array. The valid SQL expressions are: - Literals for all data types, including STRUCT and ARRAY. - Following functions: - CURRENT_TIMESTAMP - CURRENT_TIME - CURRENT_DATE - CURRENT_DATETIME - GENERATE_UUID - RAND - SESSION_USER - ST_GEOGPOINT - Struct or array composed with the above allowed functions, for example, [CURRENT_DATE(), DATE '2020-01-01']
- description
This property is required. String - [Optional] The field description. The maximum length is 1,024 characters.
- fields
This property is required. List<TableField Schema Response> - [Optional] Describes the nested schema fields if the type property is set to RECORD.
- max
Length This property is required. String - [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES".
- mode
This property is required. String - [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
- name
This property is required. String - [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
This property is required. TableField Schema Policy Tags Response - precision
This property is required. String - [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid.
- range
Element Type This property is required. TableField Schema Range Element Type Response - Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP
- rounding
Mode This property is required. String - Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields.
- scale
This property is required. String - [Optional] See documentation for precision.
- type
This property is required. String - [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
- categories
This property is required. TableField Schema Categories Response - [Optional] The categories attached to this field, used for field-level access control.
- collation
This property is required. string - Optional. Collation specification of the field. It only can be set on string type field.
- default
Value Expression This property is required. string - Optional. A SQL expression to specify the default value for this field. It can only be set for top level fields (columns). You can use struct or array expression to specify default value for the entire struct or array. The valid SQL expressions are: - Literals for all data types, including STRUCT and ARRAY. - Following functions: - CURRENT_TIMESTAMP - CURRENT_TIME - CURRENT_DATE - CURRENT_DATETIME - GENERATE_UUID - RAND - SESSION_USER - ST_GEOGPOINT - Struct or array composed with the above allowed functions, for example, [CURRENT_DATE(), DATE '2020-01-01']
- description
This property is required. string - [Optional] The field description. The maximum length is 1,024 characters.
- fields
This property is required. TableField Schema Response[] - [Optional] Describes the nested schema fields if the type property is set to RECORD.
- max
Length This property is required. string - [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES".
- mode
This property is required. string - [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
- name
This property is required. string - [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
This property is required. TableField Schema Policy Tags Response - precision
This property is required. string - [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid.
- range
Element Type This property is required. TableField Schema Range Element Type Response - Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP
- rounding
Mode This property is required. string - Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields.
- scale
This property is required. string - [Optional] See documentation for precision.
- type
This property is required. string - [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
- categories
This property is required. TableField Schema Categories Response - [Optional] The categories attached to this field, used for field-level access control.
- collation
This property is required. str - Optional. Collation specification of the field. It only can be set on string type field.
- default_
value_ expression This property is required. str - Optional. A SQL expression to specify the default value for this field. It can only be set for top level fields (columns). You can use struct or array expression to specify default value for the entire struct or array. The valid SQL expressions are: - Literals for all data types, including STRUCT and ARRAY. - Following functions: - CURRENT_TIMESTAMP - CURRENT_TIME - CURRENT_DATE - CURRENT_DATETIME - GENERATE_UUID - RAND - SESSION_USER - ST_GEOGPOINT - Struct or array composed with the above allowed functions, for example, [CURRENT_DATE(), DATE '2020-01-01']
- description
This property is required. str - [Optional] The field description. The maximum length is 1,024 characters.
- fields
This property is required. Sequence[TableField Schema Response] - [Optional] Describes the nested schema fields if the type property is set to RECORD.
- max_
length This property is required. str - [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES".
- mode
This property is required. str - [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
- name
This property is required. str - [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
This property is required. TableField Schema Policy Tags Response - precision
This property is required. str - [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid.
- range_
element_ type This property is required. TableField Schema Range Element Type Response - Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP
- rounding_
mode This property is required. str - Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields.
- scale
This property is required. str - [Optional] See documentation for precision.
- type
This property is required. str - [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
- categories
This property is required. Property Map - [Optional] The categories attached to this field, used for field-level access control.
- collation
This property is required. String - Optional. Collation specification of the field. It only can be set on string type field.
- default
Value Expression This property is required. String - Optional. A SQL expression to specify the default value for this field. It can only be set for top level fields (columns). You can use struct or array expression to specify default value for the entire struct or array. The valid SQL expressions are: - Literals for all data types, including STRUCT and ARRAY. - Following functions: - CURRENT_TIMESTAMP - CURRENT_TIME - CURRENT_DATE - CURRENT_DATETIME - GENERATE_UUID - RAND - SESSION_USER - ST_GEOGPOINT - Struct or array composed with the above allowed functions, for example, [CURRENT_DATE(), DATE '2020-01-01']
- description
This property is required. String - [Optional] The field description. The maximum length is 1,024 characters.
- fields
This property is required. List<Property Map> - [Optional] Describes the nested schema fields if the type property is set to RECORD.
- max
Length This property is required. String - [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES".
- mode
This property is required. String - [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
- name
This property is required. String - [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.
This property is required. Property Map- precision
This property is required. String - [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid.
- range
Element Type This property is required. Property Map - Optional. The subtype of the RANGE, if the type of this field is RANGE. If the type is RANGE, this field is required. Possible values for the field element type of a RANGE include: - DATE - DATETIME - TIMESTAMP
- rounding
Mode This property is required. String - Optional. Rounding Mode specification of the field. It only can be set on NUMERIC or BIGNUMERIC type fields.
- scale
This property is required. String - [Optional] See documentation for precision.
- type
This property is required. String - [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
TableReference, TableReferenceArgs
- Dataset
Id string - [Required] The ID of the dataset containing this table.
- Project string
- [Required] The ID of the project containing this table.
- Table
Id 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 string - [Required] The ID of the dataset containing this table.
- Project string
- [Required] The ID of the project containing this table.
- Table
Id 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 String - [Required] The ID of the dataset containing this table.
- project String
- [Required] The ID of the project containing this table.
- table
Id 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 string - [Required] The ID of the dataset containing this table.
- project string
- [Required] The ID of the project containing this table.
- table
Id 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.
- dataset
Id String - [Required] The ID of the dataset containing this table.
- project String
- [Required] The ID of the project containing this table.
- table
Id 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.
TableReferenceResponse, TableReferenceResponseArgs
- Dataset
Id This property is required. string - [Required] The ID of the dataset containing this table.
- Project
This property is required. string - [Required] The ID of the project containing this table.
- Table
Id This property is required. string - [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- Dataset
Id This property is required. string - [Required] The ID of the dataset containing this table.
- Project
This property is required. string - [Required] The ID of the project containing this table.
- Table
Id This property is required. string - [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- dataset
Id This property is required. String - [Required] The ID of the dataset containing this table.
- project
This property is required. String - [Required] The ID of the project containing this table.
- table
Id This property is required. String - [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- dataset
Id This property is required. string - [Required] The ID of the dataset containing this table.
- project
This property is required. string - [Required] The ID of the project containing this table.
- table
Id This property is required. string - [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- dataset_
id This property is required. str - [Required] The ID of the dataset containing this table.
- project
This property is required. str - [Required] The ID of the project containing this table.
- table_
id This property is required. str - [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
- dataset
Id This property is required. String - [Required] The ID of the dataset containing this table.
- project
This property is required. String - [Required] The ID of the project containing this table.
- table
Id This property is required. String - [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
TableSchema, TableSchemaArgs
- Fields
List<Pulumi.
Google Native. Big Query. V2. Inputs. Table Field Schema> - Describes the fields in a table.
- Fields
[]Table
Field Schema - Describes the fields in a table.
- fields
List<Table
Field Schema> - Describes the fields in a table.
- fields
Table
Field Schema[] - Describes the fields in a table.
- fields
Sequence[Table
Field Schema] - Describes the fields in a table.
- fields List<Property Map>
- Describes the fields in a table.
TableSchemaResponse, TableSchemaResponseArgs
- Fields
This property is required. List<Pulumi.Google Native. Big Query. V2. Inputs. Table Field Schema Response> - Describes the fields in a table.
- Fields
This property is required. []TableField Schema Response - Describes the fields in a table.
- fields
This property is required. List<TableField Schema Response> - Describes the fields in a table.
- fields
This property is required. TableField Schema Response[] - Describes the fields in a table.
- fields
This property is required. Sequence[TableField Schema Response] - Describes the fields in a table.
- fields
This property is required. List<Property Map> - Describes the fields in a table.
TimePartitioning, TimePartitioningArgs
- Expiration
Ms 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.
- Require
Partition boolFilter - 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 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.
- Require
Partition boolFilter - 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 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.
- require
Partition BooleanFilter - 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 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.
- require
Partition booleanFilter - 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_ boolfilter - 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.
- expiration
Ms 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.
- require
Partition BooleanFilter - 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.
TimePartitioningResponse, TimePartitioningResponseArgs
- Expiration
Ms This property is required. string - [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
- Field
This property is required. string - [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
- Require
Partition Filter This property is required. bool - Type
This property is required. string - [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
- Expiration
Ms This property is required. string - [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
- Field
This property is required. string - [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
- Require
Partition Filter This property is required. bool - Type
This property is required. string - [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
- expiration
Ms This property is required. String - [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
- field
This property is required. String - [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
- require
Partition Filter This property is required. Boolean - type
This property is required. String - [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
- expiration
Ms This property is required. string - [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
- field
This property is required. string - [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
- require
Partition Filter This property is required. boolean - type
This property is required. string - [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
- expiration_
ms This property is required. str - [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
- field
This property is required. str - [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
- require_
partition_ filter This property is required. bool - type
This property is required. str - [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
- expiration
Ms This property is required. String - [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
- field
This property is required. String - [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
- require
Partition Filter This property is required. Boolean - type
This property is required. String - [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
TransactionInfoResponse, TransactionInfoResponseArgs
- Transaction
Id This property is required. string - // [Alpha] Id of the transaction.
- Transaction
Id This property is required. string - // [Alpha] Id of the transaction.
- transaction
Id This property is required. String - // [Alpha] Id of the transaction.
- transaction
Id This property is required. string - // [Alpha] Id of the transaction.
- transaction_
id This property is required. str - // [Alpha] Id of the transaction.
- transaction
Id This property is required. String - // [Alpha] Id of the transaction.
UserDefinedFunctionResource, UserDefinedFunctionResourceArgs
- Inline
Code 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.
- Resource
Uri string - [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
- Inline
Code 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.
- Resource
Uri string - [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
- inline
Code 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.
- resource
Uri String - [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
- inline
Code 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.
- resource
Uri 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).
- inline
Code 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.
- resource
Uri String - [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
UserDefinedFunctionResourceResponse, UserDefinedFunctionResourceResponseArgs
- Inline
Code This property is required. string - [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
- Resource
Uri This property is required. string - [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
- Inline
Code This property is required. 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.
- Resource
Uri This property is required. string - [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
- inline
Code This property is required. 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.
- resource
Uri This property is required. String - [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
- inline
Code This property is required. 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.
- resource
Uri This property is required. string - [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
- inline_
code This property is required. str - [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
- resource_
uri This property is required. str - [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
- inline
Code This property is required. String - [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
- resource
Uri This property is required. String - [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.