Interface LoadConfiguration (2.23.0)

public interface LoadConfiguration

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

Methods

getAutodetect()

public abstract Boolean getAutodetect()

[Experimental] Returns whether automatic inference of the options and schema for CSV and JSON sources is set.

Returns
TypeDescription
Boolean

getClustering()

public abstract Clustering getClustering()

Returns the clustering specification for the definition table.

Returns
TypeDescription
Clustering

getCreateDisposition()

public abstract JobInfo.CreateDisposition getCreateDisposition()

Returns whether the job is allowed to create new tables. See Also: Create Disposition

Returns
TypeDescription
JobInfo.CreateDisposition

getCsvOptions()

public abstract CsvOptions getCsvOptions()

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

Returns
TypeDescription
CsvOptions

getDatastoreBackupOptions()

public abstract DatastoreBackupOptions getDatastoreBackupOptions()

Returns additional options used to load from a Cloud datastore backup.

Returns
TypeDescription
DatastoreBackupOptions

getDecimalTargetTypes()

public abstract List<String> getDecimalTargetTypes()

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.

Returns
TypeDescription
List<String>

getDestinationEncryptionConfiguration()

public abstract EncryptionConfiguration getDestinationEncryptionConfiguration()
Returns
TypeDescription
EncryptionConfiguration

getDestinationTable()

public abstract TableId getDestinationTable()

Returns the destination table to load the data into.

Returns
TypeDescription
TableId

getFormat()

public abstract String getFormat()

Returns the format of the data files.

Returns
TypeDescription
String

getMaxBadRecords()

public abstract Integer getMaxBadRecords()

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.

Returns
TypeDescription
Integer

getNullMarker()

public abstract String getNullMarker()

Returns the string that represents a null value in a CSV file. See Also: Null Marker

Returns
TypeDescription
String

getSchema()

public abstract Schema getSchema()

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

Returns
TypeDescription
Schema

getSchemaUpdateOptions()

public abstract 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. 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.

Returns
TypeDescription
List<SchemaUpdateOption>

getTimePartitioning()

public abstract TimePartitioning getTimePartitioning()

Returns the time partitioning specification defined for the destination table.

Returns
TypeDescription
TimePartitioning

getUseAvroLogicalTypes()

public abstract Boolean getUseAvroLogicalTypes()

Returns True/False. Indicates whether the logical type is interpreted.

Returns
TypeDescription
Boolean

getWriteDisposition()

public abstract JobInfo.WriteDisposition getWriteDisposition()

Returns the action that should occur if the destination table already exists. See Also: Write Disposition

Returns
TypeDescription
JobInfo.WriteDisposition

ignoreUnknownValues()

public abstract 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.

Returns
TypeDescription
Boolean

toBuilder()

public abstract LoadConfiguration.Builder toBuilder()

Returns a builder for the load configuration object.

Returns
TypeDescription
LoadConfiguration.Builder