Class WriteChannelConfiguration.Builder (2.33.2)

public static final class WriteChannelConfiguration.Builder implements LoadConfiguration.Builder

Inheritance

java.lang.Object > WriteChannelConfiguration.Builder

Methods

build()

public WriteChannelConfiguration build()
Returns
TypeDescription
WriteChannelConfiguration

setAutodetect(Boolean autodetect)

public WriteChannelConfiguration.Builder setAutodetect(Boolean autodetect)

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

Parameter
NameDescription
autodetectBoolean
Returns
TypeDescription
WriteChannelConfiguration.Builder

setClustering(Clustering clustering)

public WriteChannelConfiguration.Builder setClustering(Clustering clustering)

Sets the clustering specification for the destination table.

Parameter
NameDescription
clusteringClustering
Returns
TypeDescription
WriteChannelConfiguration.Builder

setConnectionProperties(List<ConnectionProperty> connectionProperties)

public WriteChannelConfiguration.Builder setConnectionProperties(List<ConnectionProperty> connectionProperties)
Parameter
NameDescription
connectionPropertiesList<ConnectionProperty>
Returns
TypeDescription
WriteChannelConfiguration.Builder

setCreateDisposition(JobInfo.CreateDisposition createDisposition)

public WriteChannelConfiguration.Builder setCreateDisposition(JobInfo.CreateDisposition createDisposition)

Sets whether the job is allowed to create new tables.

Parameter
NameDescription
createDispositionJobInfo.CreateDisposition
Returns
TypeDescription
WriteChannelConfiguration.Builder

setCreateSession(Boolean createSession)

public WriteChannelConfiguration.Builder setCreateSession(Boolean createSession)
Parameter
NameDescription
createSessionBoolean
Returns
TypeDescription
WriteChannelConfiguration.Builder

setDecimalTargetTypes(List<String> decimalTargetTypes)

public WriteChannelConfiguration.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
NameDescription
decimalTargetTypesList<String>
Returns
TypeDescription
WriteChannelConfiguration.Builder

setDestinationEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)

public LoadConfiguration.Builder setDestinationEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
Parameter
NameDescription
encryptionConfigurationEncryptionConfiguration
Returns
TypeDescription
LoadConfiguration.Builder

setDestinationTable(TableId destinationTable)

public WriteChannelConfiguration.Builder setDestinationTable(TableId destinationTable)

Sets the destination table to load the data into.

Parameter
NameDescription
destinationTableTableId
Returns
TypeDescription
WriteChannelConfiguration.Builder

setFormatOptions(FormatOptions formatOptions)

public WriteChannelConfiguration.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
NameDescription
formatOptionsFormatOptions
Returns
TypeDescription
WriteChannelConfiguration.Builder

setIgnoreUnknownValues(Boolean ignoreUnknownValues)

public WriteChannelConfiguration.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
NameDescription
ignoreUnknownValuesBoolean
Returns
TypeDescription
WriteChannelConfiguration.Builder

setLabels(Map<String,String> labels)

public WriteChannelConfiguration.Builder setLabels(Map<String,String> labels)
Parameter
NameDescription
labelsMap<String,String>
Returns
TypeDescription
WriteChannelConfiguration.Builder

setMaxBadRecords(Integer maxBadRecords)

public WriteChannelConfiguration.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
NameDescription
maxBadRecordsInteger
Returns
TypeDescription
WriteChannelConfiguration.Builder

setNullMarker(String nullMarker)

public WriteChannelConfiguration.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
NameDescription
nullMarkerString
Returns
TypeDescription
WriteChannelConfiguration.Builder

setSchema(Schema schema)

public WriteChannelConfiguration.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
NameDescription
schemaSchema
Returns
TypeDescription
WriteChannelConfiguration.Builder

setSchemaUpdateOptions(List<JobInfo.SchemaUpdateOption> schemaUpdateOptions)

public WriteChannelConfiguration.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
NameDescription
schemaUpdateOptionsList<SchemaUpdateOption>
Returns
TypeDescription
WriteChannelConfiguration.Builder

setTimePartitioning(TimePartitioning timePartitioning)

public WriteChannelConfiguration.Builder setTimePartitioning(TimePartitioning timePartitioning)

Sets the time partitioning specification for the destination table.

Parameter
NameDescription
timePartitioningTimePartitioning
Returns
TypeDescription
WriteChannelConfiguration.Builder

setUseAvroLogicalTypes(Boolean useAvroLogicalTypes)

public WriteChannelConfiguration.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
NameDescription
useAvroLogicalTypesBoolean
Returns
TypeDescription
WriteChannelConfiguration.Builder

setWriteDisposition(JobInfo.WriteDisposition writeDisposition)

public WriteChannelConfiguration.Builder setWriteDisposition(JobInfo.WriteDisposition writeDisposition)

Sets the action that should occur if the destination table already exists.

Parameter
NameDescription
writeDispositionJobInfo.WriteDisposition
Returns
TypeDescription
WriteChannelConfiguration.Builder