Interface LoadConfiguration (2.35.0)
Stay organized with collections
Save and categorize content based on your preferences.
publicinterface LoadConfigurationCommon 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()
publicabstractBooleangetAutodetect()[Experimental] Returns whether automatic inference of the options and schema for CSV and JSON sources is set.
| Returns | |
|---|---|
| Type | Description |
Boolean |
|
getClustering()
publicabstractClusteringgetClustering()Returns the clustering specification for the definition table.
| Returns | |
|---|---|
| Type | Description |
Clustering |
|
getCreateDisposition()
publicabstractJobInfo.CreateDispositiongetCreateDisposition()Returns whether the job is allowed to create new tables. See Also: Create Disposition
| Returns | |
|---|---|
| Type | Description |
JobInfo.CreateDisposition |
|
getCsvOptions()
publicabstractCsvOptionsgetCsvOptions()Returns additional properties used to parse CSV data (used when #getFormat() is set to
CSV). Returns null if not set.
| Returns | |
|---|---|
| Type | Description |
CsvOptions |
|
getDatastoreBackupOptions()
publicabstractDatastoreBackupOptionsgetDatastoreBackupOptions()Returns additional options used to load from a Cloud datastore backup.
| Returns | |
|---|---|
| Type | Description |
DatastoreBackupOptions |
|
getDecimalTargetTypes()
publicabstractList<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 | |
|---|---|
| Type | Description |
List<String> |
|
getDestinationEncryptionConfiguration()
publicabstractEncryptionConfigurationgetDestinationEncryptionConfiguration()| Returns | |
|---|---|
| Type | Description |
EncryptionConfiguration |
|
getDestinationTable()
publicabstractTableIdgetDestinationTable()Returns the destination table to load the data into.
| Returns | |
|---|---|
| Type | Description |
TableId |
|
getFormat()
publicabstractStringgetFormat()Returns the format of the data files.
| Returns | |
|---|---|
| Type | Description |
String |
|
getMaxBadRecords()
publicabstractIntegergetMaxBadRecords()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 | |
|---|---|
| Type | Description |
Integer |
|
getNullMarker()
publicabstractStringgetNullMarker()Returns the string that represents a null value in a CSV file. See Also: Null Marker
| Returns | |
|---|---|
| Type | Description |
String |
|
getSchema()
publicabstractSchemagetSchema()Returns the schema for the destination table, if set. Returns null otherwise.
| Returns | |
|---|---|
| Type | Description |
Schema |
|
getSchemaUpdateOptions()
publicabstractList<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 | |
|---|---|
| Type | Description |
List<SchemaUpdateOption> |
|
getTimePartitioning()
publicabstractTimePartitioninggetTimePartitioning()Returns the time partitioning specification defined for the destination table.
| Returns | |
|---|---|
| Type | Description |
TimePartitioning |
|
getUseAvroLogicalTypes()
publicabstractBooleangetUseAvroLogicalTypes()Returns True/False. Indicates whether the logical type is interpreted.
| Returns | |
|---|---|
| Type | Description |
Boolean |
|
getWriteDisposition()
publicabstractJobInfo.WriteDispositiongetWriteDisposition()Returns the action that should occur if the destination table already exists. See Also: Write Disposition
| Returns | |
|---|---|
| Type | Description |
JobInfo.WriteDisposition |
|
ignoreUnknownValues()
publicabstractBooleanignoreUnknownValues()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 | |
|---|---|
| Type | Description |
Boolean |
|
toBuilder()
publicabstractLoadConfiguration.BuildertoBuilder()Returns a builder for the load configuration object.
| Returns | |
|---|---|
| Type | Description |
LoadConfiguration.Builder |
|