com.google.cloud.bigquery

Class WriteChannelConfiguration

java.lang.Object

com.google.cloud.bigquery.WriteChannelConfiguration

All Implemented Interfaces:

LoadConfiguration, Serializable

public final class WriteChannelConfiguration
extends Object
implements LoadConfiguration, Serializable

Google BigQuery Configuration for a load operation. A load configuration can be used to load data into a table with a WriteChannel (BigQuery.writer(WriteChannelConfiguration)).

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WriteChannelConfiguration.Builder

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WriteChannelConfiguration(WriteChannelConfiguration.Builder builder)

Method Summary

Methods

Modifier and Type	Method and Description
static WriteChannelConfiguration.Builder	builder(TableId destinationTable) Creates a builder for a BigQuery Load Configuration given the destination table.
static WriteChannelConfiguration.Builder	builder(TableId destinationTable, FormatOptions format) Creates a builder for a BigQuery Load Configuration given the destination table and format.
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 LoadConfiguration.format() is set to CSV).
TableId	destinationTable() Returns the destination table to load the data into.
boolean	equals(Object obj)
String	format() Returns the format of the data files.
int	hashCode()
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.
static WriteChannelConfiguration	of(TableId destinationTable) Returns a BigQuery Load Configuration for the given destination table.
static WriteChannelConfiguration	of(TableId destinationTable, FormatOptions format) Returns a BigQuery Load Configuration for the given destination table and format.
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.
WriteChannelConfiguration.Builder	toBuilder() Returns a builder for the load configuration object.
String	toString()
JobInfo.WriteDisposition	writeDisposition() Returns the action that should occur if the destination table already exists.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WriteChannelConfiguration

protected WriteChannelConfiguration(WriteChannelConfiguration.Builder builder)

Method Detail

destinationTable

public TableId destinationTable()

Description copied from interface: LoadConfiguration

Returns the destination table to load the data into.

Specified by:

destinationTable in interface LoadConfiguration

createDisposition

public JobInfo.CreateDisposition createDisposition()

Description copied from interface: LoadConfiguration

Returns whether the job is allowed to create new tables.

Specified by:

createDisposition in interface LoadConfiguration

See Also:

Create Disposition

writeDisposition

public JobInfo.WriteDisposition writeDisposition()

Description copied from interface: LoadConfiguration

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

Specified by:

writeDisposition in interface LoadConfiguration

See Also:

Write Disposition

csvOptions

public CsvOptions csvOptions()

Description copied from interface: LoadConfiguration

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

Specified by:

csvOptions in interface LoadConfiguration

maxBadRecords

public Integer maxBadRecords()

Description copied from interface: LoadConfiguration

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.

Specified by:

maxBadRecords in interface LoadConfiguration

schema

public Schema schema()

Description copied from interface: LoadConfiguration

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

Specified by:

schema in interface LoadConfiguration

format

public String format()

Description copied from interface: LoadConfiguration

Returns the format of the data files.

Specified by:

format in interface LoadConfiguration

ignoreUnknownValues

public Boolean ignoreUnknownValues()

Description copied from interface: LoadConfiguration

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.

Specified by:

ignoreUnknownValues in interface LoadConfiguration

projectionFields

public List<String> projectionFields()

Description copied from interface: LoadConfiguration

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.

Specified by:

projectionFields in interface LoadConfiguration

toBuilder

public WriteChannelConfiguration.Builder toBuilder()

Description copied from interface: LoadConfiguration

Returns a builder for the load configuration object.

Specified by:

toBuilder in interface LoadConfiguration

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

builder

public static WriteChannelConfiguration.Builder builder(TableId destinationTable)

Creates a builder for a BigQuery Load Configuration given the destination table.

builder

public static WriteChannelConfiguration.Builder builder(TableId destinationTable,
                                        FormatOptions format)

Creates a builder for a BigQuery Load Configuration given the destination table and format.

of

public static WriteChannelConfiguration of(TableId destinationTable)

Returns a BigQuery Load Configuration for the given destination table.

of

public static WriteChannelConfiguration of(TableId destinationTable,
                           FormatOptions format)

Returns a BigQuery Load Configuration for the given destination table and format.