com.google.api.services.bigquery.model

Class CsvOptions

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.CsvOptions

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Information related to a CSV data source.

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

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
CsvOptions()

Method Summary

Modifier and Type	Method and Description
CsvOptions	clone()
Boolean	getAllowJaggedRows() Optional.
Boolean	getAllowQuotedNewlines() Optional.
String	getEncoding() Optional.
String	getFieldDelimiter() Optional.
String	getNullMarker() Optional.
List<String>	getNullMarkers() Optional.
Boolean	getPreserveAsciiControlCharacters() Optional.
String	getQuote() Optional.
Long	getSkipLeadingRows() Optional.
String	getSourceColumnMatch() Optional.
CsvOptions	set(String fieldName, Object value)
CsvOptions	setAllowJaggedRows(Boolean allowJaggedRows) Optional.
CsvOptions	setAllowQuotedNewlines(Boolean allowQuotedNewlines) Optional.
CsvOptions	setEncoding(String encoding) Optional.
CsvOptions	setFieldDelimiter(String fieldDelimiter) Optional.
CsvOptions	setNullMarker(String nullMarker) Optional.
CsvOptions	setNullMarkers(List<String> nullMarkers) Optional.
CsvOptions	setPreserveAsciiControlCharacters(Boolean preserveAsciiControlCharacters) Optional.
CsvOptions	setQuote(String quote) Optional.
CsvOptions	setSkipLeadingRows(Long skipLeadingRows) Optional.
CsvOptions	setSourceColumnMatch(String sourceColumnMatch) Optional.

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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

CsvOptions

public CsvOptions()

Method Detail

getAllowJaggedRows

public Boolean getAllowJaggedRows()

Optional. Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing 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.

Returns:

value or null for none

setAllowJaggedRows

public CsvOptions setAllowJaggedRows(Boolean allowJaggedRows)

Optional. Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing 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.

Parameters:

allowJaggedRows - allowJaggedRows or null for none

getAllowQuotedNewlines

public Boolean getAllowQuotedNewlines()

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

Returns:

value or null for none

setAllowQuotedNewlines

public CsvOptions setAllowQuotedNewlines(Boolean allowQuotedNewlines)

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

Parameters:

allowQuotedNewlines - allowQuotedNewlines or null for none

getEncoding

public String getEncoding()

Optional. The character encoding of the data. The supported values are UTF-8, ISO-8859-1, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. 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.

Returns:

value or null for none

setEncoding

public CsvOptions setEncoding(String encoding)

Optional. The character encoding of the data. The supported values are UTF-8, ISO-8859-1, UTF-16BE, UTF-16LE, UTF-32BE, and UTF-32LE. 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.

Parameters:

encoding - encoding or null for none

getFieldDelimiter

public String getFieldDelimiter()

Optional. The separator character for fields in a CSV file. The separator is interpreted as a single byte. For files encoded in ISO-8859-1, any single character can be used as a separator. For files encoded in UTF-8, characters represented in decimal range 1-127 (U+0001-U+007F) can be used without any modification. UTF-8 characters encoded with multiple bytes (i.e. U+0080 and above) will have only the first byte used for separating fields. The remaining bytes will be treated as a part of the field. BigQuery also supports the escape sequence "\t" (U+0009) to specify a tab separator. The default value is comma (",", U+002C).

Returns:

value or null for none

setFieldDelimiter

public CsvOptions setFieldDelimiter(String fieldDelimiter)

Optional. The separator character for fields in a CSV file. The separator is interpreted as a single byte. For files encoded in ISO-8859-1, any single character can be used as a separator. For files encoded in UTF-8, characters represented in decimal range 1-127 (U+0001-U+007F) can be used without any modification. UTF-8 characters encoded with multiple bytes (i.e. U+0080 and above) will have only the first byte used for separating fields. The remaining bytes will be treated as a part of the field. BigQuery also supports the escape sequence "\t" (U+0009) to specify a tab separator. The default value is comma (",", U+002C).

Parameters:

fieldDelimiter - fieldDelimiter or null for none

getNullMarker

public String getNullMarker()

Optional. Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when querying a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.

Returns:

value or null for none

setNullMarker

public CsvOptions setNullMarker(String nullMarker)

Optional. Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when querying a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.

Parameters:

nullMarker - nullMarker or null for none

getNullMarkers

public List<String> getNullMarkers()

Optional. A list of strings represented as SQL NULL value in a CSV file. null_marker and null_markers can't be set at the same time. If null_marker is set, null_markers has to be not set. If null_markers is set, null_marker has to be not set. If both null_marker and null_markers are set at the same time, a user error would be thrown. Any strings listed in null_markers, including empty string would be interpreted as SQL NULL. This applies to all column types.

Returns:

value or null for none

setNullMarkers

public CsvOptions setNullMarkers(List<String> nullMarkers)

Optional. A list of strings represented as SQL NULL value in a CSV file. null_marker and null_markers can't be set at the same time. If null_marker is set, null_markers has to be not set. If null_markers is set, null_marker has to be not set. If both null_marker and null_markers are set at the same time, a user error would be thrown. Any strings listed in null_markers, including empty string would be interpreted as SQL NULL. This applies to all column types.

Parameters:

nullMarkers - nullMarkers or null for none

getPreserveAsciiControlCharacters

public Boolean getPreserveAsciiControlCharacters()

Optional. Indicates if the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') are preserved.

Returns:

value or null for none

setPreserveAsciiControlCharacters

public CsvOptions setPreserveAsciiControlCharacters(Boolean preserveAsciiControlCharacters)

Optional. Indicates if the embedded ASCII control characters (the first 32 characters in the ASCII-table, from '\x00' to '\x1F') are preserved.

Parameters:

preserveAsciiControlCharacters - preserveAsciiControlCharacters or null for none

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. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '.

Returns:

value or null for none

setQuote

public CsvOptions 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. To include the specific quote character within a quoted value, precede it with an additional matching quote character. For example, if you want to escape the default character ' " ', use ' "" '.

Parameters:

quote - quote or null for none

getSkipLeadingRows

public Long getSkipLeadingRows()

Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

Returns:

value or null for none

setSkipLeadingRows

public CsvOptions setSkipLeadingRows(Long skipLeadingRows)

Optional. The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

Parameters:

skipLeadingRows - skipLeadingRows or null for none

getSourceColumnMatch

public String getSourceColumnMatch()

Optional. Controls the strategy used to match loaded columns to the schema. If not set, a sensible default is chosen based on how the schema is provided. If autodetect is used, then columns are matched by name. Otherwise, columns are matched by position. This is done to keep the behavior backward-compatible. Acceptable values are: POSITION - matches by position. This assumes that the columns are ordered the same way as the schema. NAME - matches by name. This reads the header row as column names and reorders columns to match the field names in the schema.

Returns:

value or null for none

setSourceColumnMatch

public CsvOptions setSourceColumnMatch(String sourceColumnMatch)

Optional. Controls the strategy used to match loaded columns to the schema. If not set, a sensible default is chosen based on how the schema is provided. If autodetect is used, then columns are matched by name. Otherwise, columns are matched by position. This is done to keep the behavior backward-compatible. Acceptable values are: POSITION - matches by position. This assumes that the columns are ordered the same way as the schema. NAME - matches by name. This reads the header row as column names and reorders columns to match the field names in the schema.

Parameters:

sourceColumnMatch - sourceColumnMatch or null for none

set

public CsvOptions set(String fieldName,
                      Object value)

Overrides:

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

clone

public CsvOptions clone()

Overrides:

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