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 Description

static class WriteChannelConfiguration.Builder

Constructor Summary

Constructors
Modifier Constructor Description

protected WriteChannelConfiguration(WriteChannelConfiguration.Builder builder)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`Boolean`	`getAutodetect()`	[Experimental] Returns whether automatic inference of the options and schema for CSV and JSON sources is set.
`Clustering`	`getClustering()`	Returns the clustering specification for the definition table.
`List<ConnectionProperty>`	`getConnectionProperties()`
`JobInfo.CreateDisposition`	`getCreateDisposition()`	Returns whether the job is allowed to create new tables.
`Boolean`	`getCreateSession()`
`CsvOptions`	`getCsvOptions()`	Returns additional properties used to parse CSV data (used when `LoadConfiguration.getFormat()` is set to CSV).
`DatastoreBackupOptions`	`getDatastoreBackupOptions()`	Returns additional options used to load from a Cloud datastore backup.
`List<String>`	`getDecimalTargetTypes()`	Returns the list of possible SQL data types to which the source decimal values are converted.
`EncryptionConfiguration`	`getDestinationEncryptionConfiguration()`
`TableId`	`getDestinationTable()`	Returns the destination table to load the data into.
`String`	`getFormat()`	Returns the format of the data files.
`Map<String,String>`	`getLabels()`
`Integer`	`getMaxBadRecords()`	Returns the maximum number of bad records that BigQuery can ignore when running the job.
`String`	`getNullMarker()`	Returns the string that represents a null value in a CSV file.
`Schema`	`getSchema()`	Returns the schema for the destination table, if set.
`List<JobInfo.SchemaUpdateOption>`	`getSchemaUpdateOptions()`	[Experimental] Returns options allowing the schema of the destination table to be updated as a side effect of the load job.
`TimePartitioning`	`getTimePartitioning()`	Returns the time partitioning specification defined for the destination table.
`Boolean`	`getUseAvroLogicalTypes()`	Returns True/False.
`JobInfo.WriteDisposition`	`getWriteDisposition()`	Returns the action that should occur if the destination table already exists.
`int`	`hashCode()`
`Boolean`	`ignoreUnknownValues()`	Returns whether BigQuery should allow extra values that are not represented in the table schema.
`static WriteChannelConfiguration.Builder`	`newBuilder(TableId destinationTable)`	Creates a builder for a BigQuery Load Configuration given the destination table.
`static WriteChannelConfiguration.Builder`	`newBuilder(TableId destinationTable, FormatOptions format)`	Creates a builder for a BigQuery Load Configuration given the destination table and format.
`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.
`WriteChannelConfiguration.Builder`	`toBuilder()`	Returns a builder for the load configuration object.
`String`	`toString()`

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
  - getDestinationTable
```
public TableId getDestinationTable()
```
    Description copied from interface: LoadConfiguration
    
    Returns the destination table to load the data into.
    
    Specified by:
    
    getDestinationTable in interface LoadConfiguration
  - getDestinationEncryptionConfiguration
```
public EncryptionConfiguration getDestinationEncryptionConfiguration()
```
    Specified by:
    
    getDestinationEncryptionConfiguration in interface LoadConfiguration
  - getCreateDisposition
```
public JobInfo.CreateDisposition getCreateDisposition()
```
    Description copied from interface: LoadConfiguration
    
    Returns whether the job is allowed to create new tables.
    
    Specified by:
    
    getCreateDisposition in interface LoadConfiguration
    
    See Also:
    
    Create Disposition
  - getWriteDisposition
```
public JobInfo.WriteDisposition getWriteDisposition()
```
    Description copied from interface: LoadConfiguration
    
    Returns the action that should occur if the destination table already exists.
    
    Specified by:
    
    getWriteDisposition in interface LoadConfiguration
    
    See Also:
    
    Write Disposition
  - getNullMarker
```
public String getNullMarker()
```
    Description copied from interface: LoadConfiguration
    
    Returns the string that represents a null value in a CSV file.
    
    Specified by:
    
    getNullMarker in interface LoadConfiguration
    
    See Also:
    
    Null Marker
  - getCsvOptions
```
public CsvOptions getCsvOptions()
```
    Description copied from interface: LoadConfiguration
    
    Returns additional properties used to parse CSV data (used when LoadConfiguration.getFormat() is set to CSV). Returns null if not set.
    
    Specified by:
    
    getCsvOptions in interface LoadConfiguration
  - getMaxBadRecords
```
public Integer getMaxBadRecords()
```
    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:
    
    getMaxBadRecords in interface LoadConfiguration
  - getSchema
```
public Schema getSchema()
```
    Description copied from interface: LoadConfiguration
    
    Returns the schema for the destination table, if set. Returns null otherwise.
    
    Specified by:
    
    getSchema in interface LoadConfiguration
  - getFormat
```
public String getFormat()
```
    Description copied from interface: LoadConfiguration
    
    Returns the format of the data files.
    
    Specified by:
    
    getFormat 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
  - getDatastoreBackupOptions
```
public DatastoreBackupOptions getDatastoreBackupOptions()
```
    Description copied from interface: LoadConfiguration
    
    Returns additional options used to load from a Cloud datastore backup.
    
    Specified by:
    
    getDatastoreBackupOptions in interface LoadConfiguration
  - getSchemaUpdateOptions
```
public List<JobInfo.SchemaUpdateOption> getSchemaUpdateOptions()
```
    Description copied from interface: LoadConfiguration
    
    [Experimental] Returns 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.
    
    Specified by:
    
    getSchemaUpdateOptions in interface LoadConfiguration
  - getAutodetect
```
public Boolean getAutodetect()
```
    Description copied from interface: LoadConfiguration
    
    [Experimental] Returns whether automatic inference of the options and schema for CSV and JSON sources is set.
    
    Specified by:
    
    getAutodetect in interface LoadConfiguration
  - getTimePartitioning
```
public TimePartitioning getTimePartitioning()
```
    Description copied from interface: LoadConfiguration
    
    Returns the time partitioning specification defined for the destination table.
    
    Specified by:
    
    getTimePartitioning in interface LoadConfiguration
  - getClustering
```
public Clustering getClustering()
```
    Description copied from interface: LoadConfiguration
    
    Returns the clustering specification for the definition table.
    
    Specified by:
    
    getClustering in interface LoadConfiguration
  - getUseAvroLogicalTypes
```
public Boolean getUseAvroLogicalTypes()
```
    Description copied from interface: LoadConfiguration
    
    Returns True/False. Indicates whether the logical type is interpreted.
    
    Specified by:
    
    getUseAvroLogicalTypes in interface LoadConfiguration
  - getLabels
```
public Map<String,String> getLabels()
```
  - getDecimalTargetTypes
```
public List<String> getDecimalTargetTypes()
```
    Description copied from interface: LoadConfiguration
    
    Returns 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.
    
    Specified by:
    
    getDecimalTargetTypes in interface LoadConfiguration
  - getConnectionProperties
```
public List<ConnectionProperty> getConnectionProperties()
```
  - getCreateSession
```
public Boolean getCreateSession()
```
  - 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
  - newBuilder
```
public static WriteChannelConfiguration.Builder newBuilder(TableId destinationTable)
```
    Creates a builder for a BigQuery Load Configuration given the destination table.
  - newBuilder
```
public static WriteChannelConfiguration.Builder newBuilder(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.

Class WriteChannelConfiguration

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WriteChannelConfiguration

Method Detail

getDestinationTable

getDestinationEncryptionConfiguration

getCreateDisposition

getWriteDisposition

getNullMarker

getCsvOptions

getMaxBadRecords

getSchema

getFormat

ignoreUnknownValues

getDatastoreBackupOptions

getSchemaUpdateOptions

getAutodetect

getTimePartitioning

getClustering

getUseAvroLogicalTypes

getLabels

getDecimalTargetTypes

getConnectionProperties

getCreateSession

toBuilder

toString

equals

hashCode

newBuilder

newBuilder

of

of