GetTableExternalDataConfiguration class
Constructors
-
GetTableExternalDataConfiguration({required Input<bool> autodetect, required Input<List<GetTableExternalDataConfigurationAvroOption>> avroOptions, required Input<List<GetTableExternalDataConfigurationBigtableOption>> bigtableOptions, required Input<String> compression, required Input<String> connectionId, required Input<List<GetTableExternalDataConfigurationCsvOption>> csvOptions, required Input<List<String>> decimalTargetTypes, required Input<String> fileSetSpecType, required Input<List<GetTableExternalDataConfigurationGoogleSheetsOption>> googleSheetsOptions, required Input<List<GetTableExternalDataConfigurationHivePartitioningOption>> hivePartitioningOptions, required Input<bool> ignoreUnknownValues, required Input<String> jsonExtension, required Input<List<GetTableExternalDataConfigurationJsonOption>> jsonOptions, required Input<int> maxBadRecords, required Input<String> metadataCacheMode, required Input<String> objectMetadata, required Input<List<GetTableExternalDataConfigurationParquetOption>> parquetOptions, required Input<String> referenceFileSchemaUri, required Input<String> schema, required Input<String> sourceFormat, required Input<List<String>> sourceUris})
-
Creates a new GetTableExternalDataConfiguration.
autodetect Let BigQuery try to autodetect the schema and format of the table.
avroOptions Additional options if sourceFormat is set to "AVRO"
bigtableOptions Additional options if sourceFormat is set to BIGTABLE.
compression The compression type of the data source. Valid values are "NONE" or "GZIP".
connectionId The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connectionId can have the form "<project>.<location>.<connection_id>" or "projects/<project>/locations/<location>/connections/<connection_id>".
csvOptions Additional properties to set if sourceFormat is set to "CSV".
decimalTargetTypes The data types that could be used as a target type when converting decimal values.
fileSetSpecType 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.
googleSheetsOptions Additional options if sourceFormat is set to "GOOGLE_SHEETS".
hivePartitioningOptions 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.
ignoreUnknownValues 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.
jsonExtension Load option to be used together with sourceFormat newline-delimited JSON to indicate that a variant of JSON is being loaded. To load newline-delimited GeoJSON, specify GEOJSON (and sourceFormat must be set to NEWLINE_DELIMITED_JSON).
jsonOptions Additional properties to set if sourceFormat is set to JSON.
maxBadRecords The maximum number of bad records that BigQuery can ignore when reading data.
metadataCacheMode Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.
objectMetadata Object Metadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the sourceUris. If ObjectMetadata is set, sourceFormat should be omitted.
parquetOptions Additional properties to set if sourceFormat is set to PARQUET.
referenceFileSchemaUri 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.
schema A JSON schema for the external table. Schema is required for CSV and JSON formats and is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats when using external tables.
sourceFormat Please see sourceFormat under ExternalDataConfiguration in Bigquery's public API documentation (https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externaldataconfiguration) for supported formats. To use "GOOGLE_SHEETS" the scopes must include "googleapis.com/auth/drive.readonly".
sourceUris A list of the fully-qualified URIs that point to your data in Google Cloud.
const
-
GetTableExternalDataConfiguration.fromMap(Map<String, dynamic> map)
-
factory
Properties
-
autodetect
→ Input<bool>
-
Let BigQuery try to autodetect the schema and format of the table.
final
-
avroOptions
→ Input<List<GetTableExternalDataConfigurationAvroOption>>
-
Additional options if sourceFormat is set to "AVRO"
final
-
bigtableOptions
→ Input<List<GetTableExternalDataConfigurationBigtableOption>>
-
Additional options if sourceFormat is set to BIGTABLE.
final
-
compression
→ Input<String>
-
The compression type of the data source. Valid values are "NONE" or "GZIP".
final
-
connectionId
→ Input<String>
-
The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connectionId can have the form "<project>.<location>.<connection_id>" or "projects/<project>/locations/<location>/connections/<connection_id>".
final
-
csvOptions
→ Input<List<GetTableExternalDataConfigurationCsvOption>>
-
Additional properties to set if sourceFormat is set to "CSV".
final
-
decimalTargetTypes
→ Input<List<String>>
-
The data types that could be used as a target type when converting decimal values.
final
-
fileSetSpecType
→ Input<String>
-
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.
final
-
googleSheetsOptions
→ Input<List<GetTableExternalDataConfigurationGoogleSheetsOption>>
-
Additional options if sourceFormat is set to "GOOGLE_SHEETS".
final
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
hivePartitioningOptions
→ Input<List<GetTableExternalDataConfigurationHivePartitioningOption>>
-
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.
final
-
ignoreUnknownValues
→ Input<bool>
-
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.
final
-
jsonExtension
→ Input<String>
-
Load option to be used together with sourceFormat newline-delimited JSON to indicate that a variant of JSON is being loaded. To load newline-delimited GeoJSON, specify GEOJSON (and sourceFormat must be set to NEWLINE_DELIMITED_JSON).
final
-
jsonOptions
→ Input<List<GetTableExternalDataConfigurationJsonOption>>
-
Additional properties to set if sourceFormat is set to JSON.
final
-
maxBadRecords
→ Input<int>
-
The maximum number of bad records that BigQuery can ignore when reading data.
final
-
metadataCacheMode
→ Input<String>
-
Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.
final
-
objectMetadata
→ Input<String>
-
Object Metadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the sourceUris. If ObjectMetadata is set, sourceFormat should be omitted.
final
-
parquetOptions
→ Input<List<GetTableExternalDataConfigurationParquetOption>>
-
Additional properties to set if sourceFormat is set to PARQUET.
final
-
referenceFileSchemaUri
→ Input<String>
-
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.
final
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
-
schema
→ Input<String>
-
A JSON schema for the external table. Schema is required for CSV and JSON formats and is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats when using external tables.
final
-
sourceFormat
→ Input<String>
-
Please see sourceFormat under ExternalDataConfiguration in Bigquery's public API documentation (https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#externaldataconfiguration) for supported formats. To use "GOOGLE_SHEETS" the scopes must include "googleapis.com/auth/drive.readonly".
final
-
sourceUris
→ Input<List<String>>
-
A list of the fully-qualified URIs that point to your data in Google Cloud.
final
