com.google.cloud.bigquery

Class LoadJobConfiguration.Builder

java.lang.Object

com.google.cloud.bigquery.JobConfiguration.Builder<LoadJobConfiguration,LoadJobConfiguration.Builder>

com.google.cloud.bigquery.LoadJobConfiguration.Builder

All Implemented Interfaces:

LoadConfiguration.Builder

Enclosing class:

LoadJobConfiguration

public static final class LoadJobConfiguration.Builder
extends JobConfiguration.Builder<LoadJobConfiguration,LoadJobConfiguration.Builder>
implements LoadConfiguration.Builder

Method Summary

Methods

Modifier and Type	Method and Description
LoadJobConfiguration	build() Creates an object.
LoadJobConfiguration.Builder	createDisposition(JobInfo.CreateDisposition createDisposition) Sets whether the job is allowed to create new tables.
LoadJobConfiguration.Builder	destinationTable(TableId destinationTable) Sets the destination table to load the data into.
LoadJobConfiguration.Builder	formatOptions(FormatOptions formatOptions) Sets the source format, and possibly some parsing options, of the external data.
LoadJobConfiguration.Builder	ignoreUnknownValues(Boolean ignoreUnknownValues) Sets whether BigQuery should allow extra values that are not represented in the table schema.
LoadJobConfiguration.Builder	maxBadRecords(Integer maxBadRecords) Sets the maximum number of bad records that BigQuery can ignore when running the job.
LoadJobConfiguration.Builder	projectionFields(List<String> projectionFields) Sets which entity properties to load into BigQuery from a Cloud Datastore backup.
LoadJobConfiguration.Builder	schema(Schema schema) Sets the schema for the destination table.
LoadJobConfiguration.Builder	sourceUris(List<String> sourceUris) Sets the fully-qualified URIs that point to source data in Google Cloud Storage (e.g.
LoadJobConfiguration.Builder	writeDisposition(JobInfo.WriteDisposition writeDisposition) Sets the action that should occur if the destination table already exists.

Methods inherited from class java.lang.Object

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

Method Detail

destinationTable

public LoadJobConfiguration.Builder destinationTable(TableId destinationTable)

Description copied from interface: LoadConfiguration.Builder

Sets the destination table to load the data into.

Specified by:

destinationTable in interface LoadConfiguration.Builder

createDisposition

public LoadJobConfiguration.Builder createDisposition(JobInfo.CreateDisposition createDisposition)

Description copied from interface: LoadConfiguration.Builder

Sets whether the job is allowed to create new tables.

Specified by:

createDisposition in interface LoadConfiguration.Builder

See Also:

Create Disposition

writeDisposition

public LoadJobConfiguration.Builder writeDisposition(JobInfo.WriteDisposition writeDisposition)

Description copied from interface: LoadConfiguration.Builder

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

Specified by:

writeDisposition in interface LoadConfiguration.Builder

See Also:

Write Disposition

formatOptions

public LoadJobConfiguration.Builder formatOptions(FormatOptions formatOptions)

Description copied from interface: LoadConfiguration.Builder

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

Specified by:

formatOptions in interface LoadConfiguration.Builder

maxBadRecords

public LoadJobConfiguration.Builder maxBadRecords(Integer maxBadRecords)

Description copied from interface: LoadConfiguration.Builder

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.

Specified by:

maxBadRecords in interface LoadConfiguration.Builder

schema

public LoadJobConfiguration.Builder schema(Schema schema)

Description copied from interface: LoadConfiguration.Builder

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

Specified by:

schema in interface LoadConfiguration.Builder

ignoreUnknownValues

public LoadJobConfiguration.Builder ignoreUnknownValues(Boolean ignoreUnknownValues)

Description copied from interface: LoadConfiguration.Builder

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.

Specified by:

ignoreUnknownValues in interface LoadConfiguration.Builder

projectionFields

public LoadJobConfiguration.Builder projectionFields(List<String> projectionFields)

Description copied from interface: LoadConfiguration.Builder

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

Specified by:

projectionFields in interface LoadConfiguration.Builder

sourceUris

public LoadJobConfiguration.Builder sourceUris(List<String> sourceUris)

Sets the fully-qualified URIs that point to source data in Google Cloud Storage (e.g. gs://bucket/path). Each URI can contain one '*' wildcard character and it must come after the 'bucket' name.

build

public LoadJobConfiguration build()

Description copied from class: JobConfiguration.Builder

Creates an object.

Specified by:

build in interface LoadConfiguration.Builder

Specified by:

build in class JobConfiguration.Builder<LoadJobConfiguration,LoadJobConfiguration.Builder>