com.google.api.services.bigquery.model

Class ExternalDataConfiguration

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.bigquery.model.ExternalDataConfiguration

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class ExternalDataConfiguration
extends com.google.api.client.json.GenericJson

Model definition for ExternalDataConfiguration.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the BigQuery API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
ExternalDataConfiguration()

Method Summary

Methods

Modifier and Type	Method and Description
ExternalDataConfiguration	clone()
java.lang.String	getCompression() [Optional] The compression type of the data source.
CsvOptions	getCsvOptions() Additional properties to set if sourceFormat is set to CSV.
java.lang.Boolean	getIgnoreUnknownValues() [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema.
java.lang.Integer	getMaxBadRecords() [Optional] The maximum number of bad records that BigQuery can ignore when reading data.
TableSchema	getSchema() [Optional] The schema for the data.
java.lang.String	getSourceFormat() [Required] The data format.
java.util.List<java.lang.String>	getSourceUris() [Required] The fully-qualified URIs that point to your data in Google Cloud Storage.
ExternalDataConfiguration	set(java.lang.String fieldName, java.lang.Object value)
ExternalDataConfiguration	setCompression(java.lang.String compression) [Optional] The compression type of the data source.
ExternalDataConfiguration	setCsvOptions(CsvOptions csvOptions) Additional properties to set if sourceFormat is set to CSV.
ExternalDataConfiguration	setIgnoreUnknownValues(java.lang.Boolean ignoreUnknownValues) [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema.
ExternalDataConfiguration	setMaxBadRecords(java.lang.Integer maxBadRecords) [Optional] The maximum number of bad records that BigQuery can ignore when reading data.
ExternalDataConfiguration	setSchema(TableSchema schema) [Optional] The schema for the data.
ExternalDataConfiguration	setSourceFormat(java.lang.String sourceFormat) [Required] The data format.
ExternalDataConfiguration	setSourceUris(java.util.List<java.lang.String> sourceUris) [Required] The fully-qualified URIs that point to your data in Google Cloud Storage.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalDataConfiguration

public ExternalDataConfiguration()

Method Detail

getCompression

public java.lang.String getCompression()

[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Datastore backups.

Returns:

value or null for none

setCompression

public ExternalDataConfiguration setCompression(java.lang.String compression)

[Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Datastore backups.

Parameters:

compression - compression or null for none

getCsvOptions

public CsvOptions getCsvOptions()

Additional properties to set if sourceFormat is set to CSV.

Returns:

value or null for none

setCsvOptions

public ExternalDataConfiguration setCsvOptions(CsvOptions csvOptions)

Additional properties to set if sourceFormat is set to CSV.

Parameters:

csvOptions - csvOptions or null for none

getIgnoreUnknownValues

public java.lang.Boolean getIgnoreUnknownValues()

[Optional] Indicates if 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. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Datastore backups: This setting is ignored.

Returns:

value or null for none

setIgnoreUnknownValues

public ExternalDataConfiguration setIgnoreUnknownValues(java.lang.Boolean ignoreUnknownValues)

[Optional] Indicates if 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. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Datastore backups: This setting is ignored.

Parameters:

ignoreUnknownValues - ignoreUnknownValues or null for none

getMaxBadRecords

public java.lang.Integer getMaxBadRecords()

[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Datastore backups.

Returns:

value or null for none

setMaxBadRecords

public ExternalDataConfiguration setMaxBadRecords(java.lang.Integer maxBadRecords)

[Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Datastore backups.

Parameters:

maxBadRecords - maxBadRecords or null for none

getSchema

public TableSchema getSchema()

[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Datastore backups.

Returns:

value or null for none

setSchema

public ExternalDataConfiguration setSchema(TableSchema schema)

[Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Datastore backups.

Parameters:

schema - schema or null for none

getSourceFormat

public java.lang.String getSourceFormat()

[Required] The data format. For CSV files, specify "CSV". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP".

Returns:

value or null for none

setSourceFormat

public ExternalDataConfiguration setSourceFormat(java.lang.String sourceFormat)

[Required] The data format. For CSV files, specify "CSV". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP".

Parameters:

sourceFormat - sourceFormat or null for none

getSourceUris

public java.util.List<java.lang.String> getSourceUris()

[Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources, plus an additional limit of 10 GB maximum size across all URIs. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.

Returns:

value or null for none

setSourceUris

public ExternalDataConfiguration setSourceUris(java.util.List<java.lang.String> sourceUris)

[Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources, plus an additional limit of 10 GB maximum size across all URIs. For Google Cloud Datastore backups, exactly one URI can be specified, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.

Parameters:

sourceUris - sourceUris or null for none

set

public ExternalDataConfiguration set(java.lang.String fieldName,
                            java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public ExternalDataConfiguration clone()

Overrides:

clone in class com.google.api.client.json.GenericJson