TableExternalDataConfigurationArgs

data class TableExternalDataConfigurationArgs(val autodetect: Output<Boolean>, val avroOptions: Output<TableExternalDataConfigurationAvroOptionsArgs>? = null, val bigtableOptions: Output<TableExternalDataConfigurationBigtableOptionsArgs>? = null, val compression: Output<String>? = null, val connectionId: Output<String>? = null, val csvOptions: Output<TableExternalDataConfigurationCsvOptionsArgs>? = null, val fileSetSpecType: Output<String>? = null, val googleSheetsOptions: Output<TableExternalDataConfigurationGoogleSheetsOptionsArgs>? = null, val hivePartitioningOptions: Output<TableExternalDataConfigurationHivePartitioningOptionsArgs>? = null, val ignoreUnknownValues: Output<Boolean>? = null, val jsonExtension: Output<String>? = null, val jsonOptions: Output<TableExternalDataConfigurationJsonOptionsArgs>? = null, val maxBadRecords: Output<Int>? = null, val metadataCacheMode: Output<String>? = null, val objectMetadata: Output<String>? = null, val parquetOptions: Output<TableExternalDataConfigurationParquetOptionsArgs>? = null, val referenceFileSchemaUri: Output<String>? = null, val schema: Output<String>? = null, val sourceFormat: Output<String>? = null, val sourceUris: Output<List<String>>) : ConvertibleToJava<TableExternalDataConfigurationArgs>

Constructors

Link copied to clipboard
constructor(autodetect: Output<Boolean>, avroOptions: Output<TableExternalDataConfigurationAvroOptionsArgs>? = null, bigtableOptions: Output<TableExternalDataConfigurationBigtableOptionsArgs>? = null, compression: Output<String>? = null, connectionId: Output<String>? = null, csvOptions: Output<TableExternalDataConfigurationCsvOptionsArgs>? = null, fileSetSpecType: Output<String>? = null, googleSheetsOptions: Output<TableExternalDataConfigurationGoogleSheetsOptionsArgs>? = null, hivePartitioningOptions: Output<TableExternalDataConfigurationHivePartitioningOptionsArgs>? = null, ignoreUnknownValues: Output<Boolean>? = null, jsonExtension: Output<String>? = null, jsonOptions: Output<TableExternalDataConfigurationJsonOptionsArgs>? = null, maxBadRecords: Output<Int>? = null, metadataCacheMode: Output<String>? = null, objectMetadata: Output<String>? = null, parquetOptions: Output<TableExternalDataConfigurationParquetOptionsArgs>? = null, referenceFileSchemaUri: Output<String>? = null, schema: Output<String>? = null, sourceFormat: Output<String>? = null, sourceUris: Output<List<String>>)

Properties

Link copied to clipboard
val autodetect: Output<Boolean>

Let BigQuery try to autodetect the schema and format of the table.

Link copied to clipboard

Additional options if source_format is set to "AVRO". Structure is documented below.

Link copied to clipboard

Additional properties to set if source_format is set to "BIGTABLE". Structure is documented below.

Link copied to clipboard
val compression: Output<String>? = null

The compression type of the data source. Valid values are "NONE" or "GZIP".

Link copied to clipboard
val connectionId: Output<String>? = null

The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connection_id can have the form {{project}}.{{location}}.{{connection_id}} or projects/{{project}}/locations/{{location}}/connections/{{connection_id}}. ~>NOTE: If you set external_data_configuration.connection_id, the table schema must be specified using the top-level schema field documented above.

Link copied to clipboard

Additional properties to set if source_format is set to "CSV". Structure is documented below.

Link copied to clipboard
val fileSetSpecType: Output<String>? = null

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

Link copied to clipboard

Additional options if source_format is set to "GOOGLE_SHEETS". Structure is documented below.

Link copied to clipboard

When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification. Structure is documented below.

Link copied to clipboard
val ignoreUnknownValues: Output<Boolean>? = null

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.

Link copied to clipboard
val jsonExtension: Output<String>? = null

Used to indicate that a JSON variant, rather than normal JSON, is being used as the sourceFormat. This should only be used in combination with the JSON source format. Valid values are: GEOJSON.

Link copied to clipboard

Additional properties to set if source_format is set to "JSON". Structure is documented below.

Link copied to clipboard
val maxBadRecords: Output<Int>? = null

The maximum number of bad records that BigQuery can ignore when reading data.

Link copied to clipboard
val metadataCacheMode: Output<String>? = null

Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source. Valid values are AUTOMATIC and MANUAL.

Link copied to clipboard
val objectMetadata: Output<String>? = null

Object Metadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the sourceUris. If object_metadata is set, source_format should be omitted.

Link copied to clipboard

Additional properties to set if source_format is set to "PARQUET". Structure is documented below.

Link copied to clipboard
val referenceFileSchemaUri: Output<String>? = null

When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC.

Link copied to clipboard
val schema: Output<String>? = null

A JSON schema for the external table. Schema is required for CSV and JSON formats if autodetect is not on. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, Avro, Iceberg, ORC and Parquet formats. ~>NOTE: Because this field expects a JSON string, any changes to the string will create a diff, even if the JSON itself hasn't changed. Furthermore drift for this field cannot not be detected because BigQuery only uses this schema to compute the effective schema for the table, therefore any changes on the configured value will force the table to be recreated. This schema is effectively only applied when creating a table from an external datasource, after creation the computed schema will be stored in google_bigquery_table.schema ~>NOTE: If you set external_data_configuration.connection_id, the table schema must be specified using the top-level schema field documented above.

Link copied to clipboard
val sourceFormat: Output<String>? = null

The data format. Please see sourceFormat under ExternalDataConfiguration in Bigquery's public API documentation for supported formats. To use "GOOGLE_SHEETS" the scopes must include "https://www.googleapis.com/auth/drive.readonly".

Link copied to clipboard
val sourceUris: Output<List<String>>

A list of the fully-qualified URIs that point to your data in Google Cloud.

Functions

Link copied to clipboard
open override fun toJava(): TableExternalDataConfigurationArgs