Package com.hashicorp.cdktf.providers.google.bigquery_table

Interface BigqueryTableExternalDataConfiguration

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    BigqueryTableExternalDataConfiguration.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:17.730Z")
@Stability(Stable)
public interface BigqueryTableExternalDataConfiguration
extends software.amazon.jsii.JsiiSerializable

    • Method Detail

      • getAutodetect

        @Stability(Stable)
@NotNull
Object getAutodetect()
        Let BigQuery try to autodetect the schema and format of the table.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#autodetect BigqueryTable#autodetect}

      • getSourceUris

        @Stability(Stable)
@NotNull
List<String> getSourceUris()
        A list of the fully-qualified URIs that point to your data in Google Cloud.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#source_uris BigqueryTable#source_uris}

      • getAvroOptions

        @Stability(Stable)
@Nullable
default BigqueryTableExternalDataConfigurationAvroOptions getAvroOptions()
        avro_options block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#avro_options BigqueryTable#avro_options}

      • getBigtableOptions

        @Stability(Stable)
@Nullable
default BigqueryTableExternalDataConfigurationBigtableOptions getBigtableOptions()
        bigtable_options block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#bigtable_options BigqueryTable#bigtable_options}

      • getCompression

        @Stability(Stable)
@Nullable
default String getCompression()
        The compression type of the data source. Valid values are "NONE" or "GZIP".

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#compression BigqueryTable#compression}

      • getConnectionId

        @Stability(Stable)
@Nullable
default String getConnectionId()
        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}}". Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#connection_id BigqueryTable#connection_id}

      • getCsvOptions

        @Stability(Stable)
@Nullable
default BigqueryTableExternalDataConfigurationCsvOptions getCsvOptions()
        csv_options block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#csv_options BigqueryTable#csv_options}

      • getFileSetSpecType

        @Stability(Stable)
@Nullable
default String getFileSetSpecType()
        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 at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#file_set_spec_type BigqueryTable#file_set_spec_type}

      • getGoogleSheetsOptions

        @Stability(Stable)
@Nullable
default BigqueryTableExternalDataConfigurationGoogleSheetsOptions getGoogleSheetsOptions()
        google_sheets_options block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#google_sheets_options BigqueryTable#google_sheets_options}

      • getHivePartitioningOptions

        @Stability(Stable)
@Nullable
default BigqueryTableExternalDataConfigurationHivePartitioningOptions getHivePartitioningOptions()
        hive_partitioning_options block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#hive_partitioning_options BigqueryTable#hive_partitioning_options}

      • getIgnoreUnknownValues

        @Stability(Stable)
@Nullable
default Object getIgnoreUnknownValues()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#ignore_unknown_values BigqueryTable#ignore_unknown_values}

      • getJsonExtension

        @Stability(Stable)
@Nullable
default String getJsonExtension()
        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). Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#json_extension BigqueryTable#json_extension}

      • getJsonOptions

        @Stability(Stable)
@Nullable
default BigqueryTableExternalDataConfigurationJsonOptions getJsonOptions()
        json_options block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#json_options BigqueryTable#json_options}

      • getMaxBadRecords

        @Stability(Stable)
@Nullable
default Number getMaxBadRecords()
        The maximum number of bad records that BigQuery can ignore when reading data.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#max_bad_records BigqueryTable#max_bad_records}

      • getMetadataCacheMode

        @Stability(Stable)
@Nullable
default String getMetadataCacheMode()
        Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#metadata_cache_mode BigqueryTable#metadata_cache_mode}

      • getObjectMetadata

        @Stability(Stable)
@Nullable
default String getObjectMetadata()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#object_metadata BigqueryTable#object_metadata}

      • getParquetOptions

        @Stability(Stable)
@Nullable
default BigqueryTableExternalDataConfigurationParquetOptions getParquetOptions()
        parquet_options block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#parquet_options BigqueryTable#parquet_options}

      • getReferenceFileSchemaUri

        @Stability(Stable)
@Nullable
default String getReferenceFileSchemaUri()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#reference_file_schema_uri BigqueryTable#reference_file_schema_uri}

      • getSchema

        @Stability(Stable)
@Nullable
default String getSchema()
        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. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#schema BigqueryTable#schema}

      • getSourceFormat

        @Stability(Stable)
@Nullable
default String getSourceFormat()
        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".

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#source_format BigqueryTable#source_format}