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

Class BigqueryTableExternalDataConfiguration.Builder

java.lang.Object

com.hashicorp.cdktf.providers.google.bigquery_table.BigqueryTableExternalDataConfiguration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<BigqueryTableExternalDataConfiguration>

Enclosing interface:

BigqueryTableExternalDataConfiguration

@Stability(Stable)
public static final class BigqueryTableExternalDataConfiguration.Builder
extends Object
implements software.amazon.jsii.Builder<BigqueryTableExternalDataConfiguration>

A builder for BigqueryTableExternalDataConfiguration

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
BigqueryTableExternalDataConfiguration.Builder	autodetect(com.hashicorp.cdktf.IResolvable autodetect)	Sets the value of BigqueryTableExternalDataConfiguration.getAutodetect()
BigqueryTableExternalDataConfiguration.Builder	autodetect(Boolean autodetect)	Sets the value of BigqueryTableExternalDataConfiguration.getAutodetect()
BigqueryTableExternalDataConfiguration.Builder	avroOptions(BigqueryTableExternalDataConfigurationAvroOptions avroOptions)	Sets the value of BigqueryTableExternalDataConfiguration.getAvroOptions()
BigqueryTableExternalDataConfiguration.Builder	bigtableOptions(BigqueryTableExternalDataConfigurationBigtableOptions bigtableOptions)	Sets the value of BigqueryTableExternalDataConfiguration.getBigtableOptions()
BigqueryTableExternalDataConfiguration	build()	Builds the configured instance.
BigqueryTableExternalDataConfiguration.Builder	compression(String compression)	Sets the value of BigqueryTableExternalDataConfiguration.getCompression()
BigqueryTableExternalDataConfiguration.Builder	connectionId(String connectionId)	Sets the value of BigqueryTableExternalDataConfiguration.getConnectionId()
BigqueryTableExternalDataConfiguration.Builder	csvOptions(BigqueryTableExternalDataConfigurationCsvOptions csvOptions)	Sets the value of BigqueryTableExternalDataConfiguration.getCsvOptions()
BigqueryTableExternalDataConfiguration.Builder	fileSetSpecType(String fileSetSpecType)	Sets the value of BigqueryTableExternalDataConfiguration.getFileSetSpecType()
BigqueryTableExternalDataConfiguration.Builder	googleSheetsOptions(BigqueryTableExternalDataConfigurationGoogleSheetsOptions googleSheetsOptions)	Sets the value of BigqueryTableExternalDataConfiguration.getGoogleSheetsOptions()
BigqueryTableExternalDataConfiguration.Builder	hivePartitioningOptions(BigqueryTableExternalDataConfigurationHivePartitioningOptions hivePartitioningOptions)	Sets the value of BigqueryTableExternalDataConfiguration.getHivePartitioningOptions()
BigqueryTableExternalDataConfiguration.Builder	ignoreUnknownValues(com.hashicorp.cdktf.IResolvable ignoreUnknownValues)	Sets the value of BigqueryTableExternalDataConfiguration.getIgnoreUnknownValues()
BigqueryTableExternalDataConfiguration.Builder	ignoreUnknownValues(Boolean ignoreUnknownValues)	Sets the value of BigqueryTableExternalDataConfiguration.getIgnoreUnknownValues()
BigqueryTableExternalDataConfiguration.Builder	jsonExtension(String jsonExtension)	Sets the value of BigqueryTableExternalDataConfiguration.getJsonExtension()
BigqueryTableExternalDataConfiguration.Builder	jsonOptions(BigqueryTableExternalDataConfigurationJsonOptions jsonOptions)	Sets the value of BigqueryTableExternalDataConfiguration.getJsonOptions()
BigqueryTableExternalDataConfiguration.Builder	maxBadRecords(Number maxBadRecords)	Sets the value of BigqueryTableExternalDataConfiguration.getMaxBadRecords()
BigqueryTableExternalDataConfiguration.Builder	metadataCacheMode(String metadataCacheMode)	Sets the value of BigqueryTableExternalDataConfiguration.getMetadataCacheMode()
BigqueryTableExternalDataConfiguration.Builder	objectMetadata(String objectMetadata)	Sets the value of BigqueryTableExternalDataConfiguration.getObjectMetadata()
BigqueryTableExternalDataConfiguration.Builder	parquetOptions(BigqueryTableExternalDataConfigurationParquetOptions parquetOptions)	Sets the value of BigqueryTableExternalDataConfiguration.getParquetOptions()
BigqueryTableExternalDataConfiguration.Builder	referenceFileSchemaUri(String referenceFileSchemaUri)	Sets the value of BigqueryTableExternalDataConfiguration.getReferenceFileSchemaUri()
BigqueryTableExternalDataConfiguration.Builder	schema(String schema)	Sets the value of BigqueryTableExternalDataConfiguration.getSchema()
BigqueryTableExternalDataConfiguration.Builder	sourceFormat(String sourceFormat)	Sets the value of BigqueryTableExternalDataConfiguration.getSourceFormat()
BigqueryTableExternalDataConfiguration.Builder	sourceUris(List<String> sourceUris)	Sets the value of BigqueryTableExternalDataConfiguration.getSourceUris()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

autodetect

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder autodetect(Boolean autodetect)

Sets the value of BigqueryTableExternalDataConfiguration.getAutodetect()

Parameters:

autodetect - Let BigQuery try to autodetect the schema and format of the table. This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#autodetect BigqueryTable#autodetect}

Returns:

this

autodetect

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder autodetect(com.hashicorp.cdktf.IResolvable autodetect)

Sets the value of BigqueryTableExternalDataConfiguration.getAutodetect()

Parameters:

autodetect - Let BigQuery try to autodetect the schema and format of the table. This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#autodetect BigqueryTable#autodetect}

Returns:

this

sourceUris

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder sourceUris(List<String> sourceUris)

Sets the value of BigqueryTableExternalDataConfiguration.getSourceUris()

Parameters:

sourceUris - A list of the fully-qualified URIs that point to your data in Google Cloud. This parameter is required. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#source_uris BigqueryTable#source_uris}

Returns:

this

avroOptions

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder avroOptions(BigqueryTableExternalDataConfigurationAvroOptions avroOptions)

Sets the value of BigqueryTableExternalDataConfiguration.getAvroOptions()

Parameters:

avroOptions - 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}

Returns:

this

bigtableOptions

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder bigtableOptions(BigqueryTableExternalDataConfigurationBigtableOptions bigtableOptions)

Sets the value of BigqueryTableExternalDataConfiguration.getBigtableOptions()

Parameters:

bigtableOptions - 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}

Returns:

this

compression

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder compression(String compression)

Sets the value of BigqueryTableExternalDataConfiguration.getCompression()

Parameters:

compression - 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}

Returns:

this

connectionId

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder connectionId(String connectionId)

Sets the value of BigqueryTableExternalDataConfiguration.getConnectionId()

Parameters:

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

Returns:

this

csvOptions

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder csvOptions(BigqueryTableExternalDataConfigurationCsvOptions csvOptions)

Sets the value of BigqueryTableExternalDataConfiguration.getCsvOptions()

Parameters:

csvOptions - 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}

Returns:

this

fileSetSpecType

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder fileSetSpecType(String fileSetSpecType)

Sets the value of BigqueryTableExternalDataConfiguration.getFileSetSpecType()

Parameters:

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

Returns:

this

googleSheetsOptions

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder googleSheetsOptions(BigqueryTableExternalDataConfigurationGoogleSheetsOptions googleSheetsOptions)

Sets the value of BigqueryTableExternalDataConfiguration.getGoogleSheetsOptions()

Parameters:

googleSheetsOptions - 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}

Returns:

this

hivePartitioningOptions

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder hivePartitioningOptions(BigqueryTableExternalDataConfigurationHivePartitioningOptions hivePartitioningOptions)

Sets the value of BigqueryTableExternalDataConfiguration.getHivePartitioningOptions()

Parameters:

hivePartitioningOptions - 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}

Returns:

this

ignoreUnknownValues

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder ignoreUnknownValues(Boolean ignoreUnknownValues)

Sets the value of BigqueryTableExternalDataConfiguration.getIgnoreUnknownValues()

Parameters:

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

Returns:

this

ignoreUnknownValues

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder ignoreUnknownValues(com.hashicorp.cdktf.IResolvable ignoreUnknownValues)

Sets the value of BigqueryTableExternalDataConfiguration.getIgnoreUnknownValues()

Parameters:

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

Returns:

this

jsonExtension

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder jsonExtension(String jsonExtension)

Sets the value of BigqueryTableExternalDataConfiguration.getJsonExtension()

Parameters:

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

Returns:

this

jsonOptions

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder jsonOptions(BigqueryTableExternalDataConfigurationJsonOptions jsonOptions)

Sets the value of BigqueryTableExternalDataConfiguration.getJsonOptions()

Parameters:

jsonOptions - 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}

Returns:

this

maxBadRecords

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder maxBadRecords(Number maxBadRecords)

Sets the value of BigqueryTableExternalDataConfiguration.getMaxBadRecords()

Parameters:

maxBadRecords - 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}

Returns:

this

metadataCacheMode

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder metadataCacheMode(String metadataCacheMode)

Sets the value of BigqueryTableExternalDataConfiguration.getMetadataCacheMode()

Parameters:

metadataCacheMode - 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}

Returns:

this

objectMetadata

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder objectMetadata(String objectMetadata)

Sets the value of BigqueryTableExternalDataConfiguration.getObjectMetadata()

Parameters:

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

Returns:

this

parquetOptions

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder parquetOptions(BigqueryTableExternalDataConfigurationParquetOptions parquetOptions)

Sets the value of BigqueryTableExternalDataConfiguration.getParquetOptions()

Parameters:

parquetOptions - 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}

Returns:

this

referenceFileSchemaUri

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder referenceFileSchemaUri(String referenceFileSchemaUri)

Sets the value of BigqueryTableExternalDataConfiguration.getReferenceFileSchemaUri()

Parameters:

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

Returns:

this

schema

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder schema(String schema)

Sets the value of BigqueryTableExternalDataConfiguration.getSchema()

Parameters:

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

Returns:

this

sourceFormat

@Stability(Stable)
public BigqueryTableExternalDataConfiguration.Builder sourceFormat(String sourceFormat)

Sets the value of BigqueryTableExternalDataConfiguration.getSourceFormat()

Parameters:

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". Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/bigquery_table#source_format BigqueryTable#source_format}

Returns:

this

build

@Stability(Stable)
public BigqueryTableExternalDataConfiguration build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<BigqueryTableExternalDataConfiguration>

Returns:

a new instance of BigqueryTableExternalDataConfiguration

Throws:

NullPointerException - if any required attribute was not provided