Interface LoadConfiguration.Builder (2.43.0)

public static interface LoadConfiguration.Builder

Methods

build()

public abstract LoadConfiguration build()
Returns
Type Description
LoadConfiguration

setAutodetect(Boolean autodetect)

public abstract LoadConfiguration.Builder setAutodetect(Boolean autodetect)

[Experimental] Sets automatic inference of the options and schema for CSV and JSON sources.

Parameter
Name Description
autodetect Boolean
Returns
Type Description
LoadConfiguration.Builder

setClustering(Clustering clustering)

public abstract LoadConfiguration.Builder setClustering(Clustering clustering)

Sets the clustering specification for the destination table.

Parameter
Name Description
clustering Clustering
Returns
Type Description
LoadConfiguration.Builder

setCreateDisposition(JobInfo.CreateDisposition createDisposition)

public abstract LoadConfiguration.Builder setCreateDisposition(JobInfo.CreateDisposition createDisposition)

Sets whether the job is allowed to create new tables. See Also: Create Disposition

Parameter
Name Description
createDisposition JobInfo.CreateDisposition
Returns
Type Description
LoadConfiguration.Builder

setDecimalTargetTypes(List<String> decimalTargetTypes)

public abstract LoadConfiguration.Builder setDecimalTargetTypes(List<String> decimalTargetTypes)

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.

Parameter
Name Description
decimalTargetTypes List<String>

decimalTargetType or null for none

Returns
Type Description
LoadConfiguration.Builder

setDestinationEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

public abstract LoadConfiguration.Builder setDestinationEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
Parameter
Name Description
encryptionConfiguration EncryptionConfiguration
Returns
Type Description
LoadConfiguration.Builder

setDestinationTable(TableId destinationTable)

public abstract LoadConfiguration.Builder setDestinationTable(TableId destinationTable)

Sets the destination table to load the data into.

Parameter
Name Description
destinationTable TableId
Returns
Type Description
LoadConfiguration.Builder

setFormatOptions(FormatOptions formatOptions)

public abstract LoadConfiguration.Builder setFormatOptions(FormatOptions formatOptions)

Sets the source format, and possibly some parsing options, of the external data. Supported formats are CSV, NEWLINE_DELIMITED_JSON and DATASTORE_BACKUP. If not specified, CSV format is assumed.

Source Format

Parameter
Name Description
formatOptions FormatOptions
Returns
Type Description
LoadConfiguration.Builder

setIgnoreUnknownValues(Boolean ignoreUnknownValues)

public abstract LoadConfiguration.Builder setIgnoreUnknownValues(Boolean ignoreUnknownValues)

Sets whether 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. By default unknown values are not allowed.

Parameter
Name Description
ignoreUnknownValues Boolean
Returns
Type Description
LoadConfiguration.Builder

setMaxBadRecords(Integer maxBadRecords)

public abstract LoadConfiguration.Builder setMaxBadRecords(Integer maxBadRecords)

Sets 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. By default no bad record is ignored.

Parameter
Name Description
maxBadRecords Integer
Returns
Type Description
LoadConfiguration.Builder

setNullMarker(String nullMarker)

public abstract LoadConfiguration.Builder setNullMarker(String nullMarker)

Sets the 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.

Parameter
Name Description
nullMarker String
Returns
Type Description
LoadConfiguration.Builder

setSchema(Schema schema)

public abstract LoadConfiguration.Builder setSchema(Schema schema)

Sets the schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from a Google Cloud Datastore backup (i.e. DATASTORE_BACKUP format option).

Parameter
Name Description
schema Schema
Returns
Type Description
LoadConfiguration.Builder

setSchemaUpdateOptions(List<JobInfo.SchemaUpdateOption> schemaUpdateOptions)

public abstract LoadConfiguration.Builder setSchemaUpdateOptions(List<JobInfo.SchemaUpdateOption> schemaUpdateOptions)

[Experimental] Sets options allowing the schema of the destination table to be updated as a side effect of the load 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.

Parameter
Name Description
schemaUpdateOptions List<SchemaUpdateOption>
Returns
Type Description
LoadConfiguration.Builder

setTimePartitioning(TimePartitioning timePartitioning)

public abstract LoadConfiguration.Builder setTimePartitioning(TimePartitioning timePartitioning)

Sets the time partitioning specification for the destination table.

Parameter
Name Description
timePartitioning TimePartitioning
Returns
Type Description
LoadConfiguration.Builder

setUseAvroLogicalTypes(Boolean useAvroLogicalTypes)

public abstract LoadConfiguration.Builder setUseAvroLogicalTypes(Boolean useAvroLogicalTypes)

If FormatOptions is set to AVRO, you can interpret logical types into their corresponding types (such as TIMESTAMP) instead of only using their raw types (such as INTEGER). The value may be null.

Parameter
Name Description
useAvroLogicalTypes Boolean
Returns
Type Description
LoadConfiguration.Builder

setWriteDisposition(JobInfo.WriteDisposition writeDisposition)

public abstract LoadConfiguration.Builder setWriteDisposition(JobInfo.WriteDisposition writeDisposition)

Sets the action that should occur if the destination table already exists. See Also: Write Disposition

Parameter
Name Description
writeDisposition JobInfo.WriteDisposition
Returns
Type Description
LoadConfiguration.Builder