com.google.cloud.bigquery

Interface LoadConfiguration

All Known Implementing Classes:

LoadJobConfiguration, WriteChannelConfiguration

public interface LoadConfiguration

Common interface for a load configuration. A load configuration (WriteChannelConfiguration) can be used to load data into a table with a WriteChannel (BigQuery.writer(WriteChannelConfiguration)). A load configuration (LoadJobConfiguration) can also be used to create a load job (JobInfo.of(JobConfiguration)).

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	LoadConfiguration.Builder

Method Summary

Methods

Modifier and Type	Method and Description
JobInfo.CreateDisposition	createDisposition() Returns whether the job is allowed to create new tables.
CsvOptions	csvOptions() Returns additional properties used to parse CSV data (used when format() is set to CSV).
TableId	destinationTable() Returns the destination table to load the data into.
String	format() Returns the format of the data files.
Boolean	ignoreUnknownValues() Returns whether BigQuery should allow extra values that are not represented in the table schema.
Integer	maxBadRecords() Returns the maximum number of bad records that BigQuery can ignore when running the job.
List<String>	projectionFields() Returns which entity properties to load into BigQuery from a Cloud Datastore backup.
Schema	schema() Returns the schema for the destination table, if set.
LoadConfiguration.Builder	toBuilder() Returns a builder for the load configuration object.
JobInfo.WriteDisposition	writeDisposition() Returns the action that should occur if the destination table already exists.

Method Detail

destinationTable

TableId destinationTable()

Returns the destination table to load the data into.

createDisposition

JobInfo.CreateDisposition createDisposition()

Returns whether the job is allowed to create new tables.

See Also:

Create Disposition

writeDisposition

JobInfo.WriteDisposition writeDisposition()

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

See Also:

Write Disposition

csvOptions

CsvOptions csvOptions()

Returns additional properties used to parse CSV data (used when format() is set to CSV). Returns null if not set.

maxBadRecords

Integer maxBadRecords()

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

schema

Schema schema()

Returns the schema for the destination table, if set. Returns null otherwise.

format

String format()

Returns the format of the data files.

ignoreUnknownValues

Boolean ignoreUnknownValues()

Returns whether BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If true, 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.

projectionFields

List<String> projectionFields()

Returns which entity properties to load into BigQuery from a Cloud Datastore backup. This field is only used if the source format is set to DATASTORE_BACKUP. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.

toBuilder

LoadConfiguration.Builder toBuilder()

Returns a builder for the load configuration object.