com.google.api.services.bigquery.model

Class JobConfigurationLoad

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.bigquery.model.JobConfigurationLoad

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class JobConfigurationLoad
extends GenericJson

Model definition for JobConfigurationLoad.

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: http://code.google.com/p/google-api-java-client/wiki/Json

Upgrade warning: starting with version 1.12 getResponseHeaders() is removed, instead use JsonHttpRequest.getLastResponseHeaders()

Author:

Google, Inc.

Nested Class Summary

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

GenericData.Flags

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

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

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

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
JobConfigurationLoad()

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	getAllowJaggedRows() [Optional] Accept rows that are missing trailing optional columns.
Boolean	getAllowQuotedNewlines() Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file.
String	getCreateDisposition() [Optional] Specifies whether the job is allowed to create new tables.
TableReference	getDestinationTable() [Required] The destination table to load the data into.
String	getEncoding() [Optional] The character encoding of the data.
String	getFieldDelimiter() [Optional] The separator for fields in a CSV file.
Integer	getMaxBadRecords() [Optional] The maximum number of bad records that BigQuery can ignore when running the job.
String	getQuote() [Optional] The value that is used to quote data sections in a CSV file.
TableSchema	getSchema() [Optional] The schema for the destination table.
String	getSchemaInline() [Deprecated] The inline schema.
String	getSchemaInlineFormat() [Deprecated] The format of the schemaInline property.
Integer	getSkipLeadingRows() [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data.
String	getSourceFormat() [Optional] The format of the data files.
List<String>	getSourceUris() [Required] The fully-qualified URIs that point to your data on Google Cloud Storage.
String	getWriteDisposition() [Optional] Specifies the action that occurs if the destination table already exists.
JobConfigurationLoad	setAllowJaggedRows(Boolean allowJaggedRows) [Optional] Accept rows that are missing trailing optional columns.
JobConfigurationLoad	setAllowQuotedNewlines(Boolean allowQuotedNewlines) Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file.
JobConfigurationLoad	setCreateDisposition(String createDisposition) [Optional] Specifies whether the job is allowed to create new tables.
JobConfigurationLoad	setDestinationTable(TableReference destinationTable) [Required] The destination table to load the data into.
JobConfigurationLoad	setEncoding(String encoding) [Optional] The character encoding of the data.
JobConfigurationLoad	setFieldDelimiter(String fieldDelimiter) [Optional] The separator for fields in a CSV file.
JobConfigurationLoad	setMaxBadRecords(Integer maxBadRecords) [Optional] The maximum number of bad records that BigQuery can ignore when running the job.
JobConfigurationLoad	setQuote(String quote) [Optional] The value that is used to quote data sections in a CSV file.
JobConfigurationLoad	setSchema(TableSchema schema) [Optional] The schema for the destination table.
JobConfigurationLoad	setSchemaInline(String schemaInline) [Deprecated] The inline schema.
JobConfigurationLoad	setSchemaInlineFormat(String schemaInlineFormat) [Deprecated] The format of the schemaInline property.
JobConfigurationLoad	setSkipLeadingRows(Integer skipLeadingRows) [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data.
JobConfigurationLoad	setSourceFormat(String sourceFormat) [Optional] The format of the data files.
JobConfigurationLoad	setSourceUris(List<String> sourceUris) [Required] The fully-qualified URIs that point to your data on Google Cloud Storage.
JobConfigurationLoad	setWriteDisposition(String writeDisposition) [Optional] Specifies the action that occurs if the destination table already exists.

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

clone, getFactory, setFactory, toPrettyString, toString

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

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, set, 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

JobConfigurationLoad

public JobConfigurationLoad()

Method Detail

getAllowJaggedRows

public Boolean getAllowJaggedRows()

[Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. Default is false which treats short rows as errors. Only applicable to CSV, ignored for other formats. The value returned may be null.

setAllowJaggedRows

public JobConfigurationLoad setAllowJaggedRows(Boolean allowJaggedRows)

[Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. Default is false which treats short rows as errors. Only applicable to CSV, ignored for other formats. The value set may be null.

getAllowQuotedNewlines

public Boolean getAllowQuotedNewlines()

Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. The value returned may be null.

setAllowQuotedNewlines

public JobConfigurationLoad setAllowQuotedNewlines(Boolean allowQuotedNewlines)

Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. The value set may be null.

getCreateDisposition

public String getCreateDisposition()

[Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. The value returned may be null.

setCreateDisposition

public JobConfigurationLoad setCreateDisposition(String createDisposition)

[Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion. The value set may be null.

getDestinationTable

public TableReference getDestinationTable()

[Required] The destination table to load the data into. The value returned may be null.

setDestinationTable

public JobConfigurationLoad setDestinationTable(TableReference destinationTable)

[Required] The destination table to load the data into. The value set may be null.

getEncoding

public String getEncoding()

[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. The value returned may be null.

setEncoding

public JobConfigurationLoad setEncoding(String encoding)

[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties. The value set may be null.

getFieldDelimiter

public String getFieldDelimiter()

[Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). The value returned may be null.

setFieldDelimiter

public JobConfigurationLoad setFieldDelimiter(String fieldDelimiter)

[Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator. The default value is a comma (','). The value set may be null.

getMaxBadRecords

public Integer getMaxBadRecords()

[Optional] 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 and the job fails. The default value is 0, which requires that all records are valid. The value returned may be null.

setMaxBadRecords

public JobConfigurationLoad setMaxBadRecords(Integer maxBadRecords)

[Optional] 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 and the job fails. The default value is 0, which requires that all records are valid. The value set may be null.

getQuote

public String getQuote()

[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. The value returned may be null.

setQuote

public JobConfigurationLoad setQuote(String quote)

[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true. The value set may be null.

getSchema

public TableSchema getSchema()

[Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data. The value returned may be null.

setSchema

public JobConfigurationLoad setSchema(TableSchema schema)

[Optional] The schema for the destination table. The schema can be omitted if the destination table already exists or if the schema can be inferred from the loaded data. The value set may be null.

getSchemaInline

public String getSchemaInline()

[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT". The value returned may be null.

setSchemaInline

public JobConfigurationLoad setSchemaInline(String schemaInline)

[Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT". The value set may be null.

getSchemaInlineFormat

public String getSchemaInlineFormat()

[Deprecated] The format of the schemaInline property. The value returned may be null.

setSchemaInlineFormat

public JobConfigurationLoad setSchemaInlineFormat(String schemaInlineFormat)

[Deprecated] The format of the schemaInline property. The value set may be null.

getSkipLeadingRows

public Integer getSkipLeadingRows()

[Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. The value returned may be null.

setSkipLeadingRows

public JobConfigurationLoad setSkipLeadingRows(Integer skipLeadingRows)

[Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. The value set may be null.

getSourceFormat

public String getSourceFormat()

[Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". The default value is CSV. The value returned may be null.

setSourceFormat

public JobConfigurationLoad setSourceFormat(String sourceFormat)

[Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". The default value is CSV. The value set may be null.

getSourceUris

public List<String> getSourceUris()

[Required] The fully-qualified URIs that point to your data on Google Cloud Storage. The value returned may be null.

setSourceUris

public JobConfigurationLoad setSourceUris(List<String> sourceUris)

[Required] The fully-qualified URIs that point to your data on Google Cloud Storage. The value set may be null.

getWriteDisposition

public String getWriteDisposition()

[Optional] Specifies the action that occurs if the destination table already exists. Each action is atomic and only occurs if BigQuery is able to fully load the data and the load job completes without error. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists, a 'duplicate' error is returned in the job result. Creation, truncation and append actions occur as one atomic update upon job completion. The value returned may be null.

setWriteDisposition

public JobConfigurationLoad setWriteDisposition(String writeDisposition)

[Optional] Specifies the action that occurs if the destination table already exists. Each action is atomic and only occurs if BigQuery is able to fully load the data and the load job completes without error. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists, a 'duplicate' error is returned in the job result. Creation, truncation and append actions occur as one atomic update upon job completion. The value set may be null.