target.apidocs.com.google.api.services.bigquery.model.CsvOptions.html Maven / Gradle / Ivy

Go to download







CsvOptions (BigQuery API v2-rev20201022-1.30.10)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








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 GenericJson
Model definition for CsvOptions.

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

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


CsvOptions
clone() 


Boolean
getAllowJaggedRows()
[Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns.



Boolean
getAllowQuotedNewlines()
[Optional] Indicates if BigQuery should allow quoted data sections that contain newline
 characters in a CSV file.



String
getEncoding()
[Optional] The character encoding of the data.



String
getFieldDelimiter()
[Optional] The separator for fields in a CSV file.



String
getQuote()
[Optional] The value that is used to quote data sections in a CSV file.



Long
getSkipLeadingRows()
[Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the
 data.



CsvOptions
set(String fieldName,
   Object value) 


CsvOptions
setAllowJaggedRows(Boolean allowJaggedRows)
[Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns.



CsvOptions
setAllowQuotedNewlines(Boolean allowQuotedNewlines)
[Optional] Indicates if BigQuery should allow quoted data sections that contain newline
 characters in a CSV file.



CsvOptions
setEncoding(String encoding)
[Optional] The character encoding of the data.



CsvOptions
setFieldDelimiter(String fieldDelimiter)
[Optional] The separator for fields in a CSV file.



CsvOptions
setQuote(String quote)
[Optional] The value that is used to quote data sections in a CSV file.



CsvOptions
setSkipLeadingRows(Long skipLeadingRows)
[Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the
 data.







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

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

Parameters:
encoding - encoding or null for none








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 (',').

Returns:
value or null for none








setFieldDelimiter
public CsvOptions 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 (',').

Parameters:
fieldDelimiter - fieldDelimiter 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.

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.

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








set
public CsvOptions set(String fieldName,
                      Object value)

Overrides:
set in class GenericJson








clone
public CsvOptions clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2020 Google. All rights reserved.

Modifier and Type	Method and Description
`CsvOptions`	`clone()`
`Boolean`	`getAllowJaggedRows()` [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns.
`Boolean`	`getAllowQuotedNewlines()` [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file.
`String`	`getEncoding()` [Optional] The character encoding of the data.
`String`	`getFieldDelimiter()` [Optional] The separator for fields in a CSV file.
`String`	`getQuote()` [Optional] The value that is used to quote data sections in a CSV file.
`Long`	`getSkipLeadingRows()` [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data.
`CsvOptions`	`set(String fieldName, Object value)`
`CsvOptions`	`setAllowJaggedRows(Boolean allowJaggedRows)` [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns.
`CsvOptions`	`setAllowQuotedNewlines(Boolean allowQuotedNewlines)` [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file.
`CsvOptions`	`setEncoding(String encoding)` [Optional] The character encoding of the data.
`CsvOptions`	`setFieldDelimiter(String fieldDelimiter)` [Optional] The separator for fields in a CSV file.
`CsvOptions`	`setQuote(String quote)` [Optional] The value that is used to quote data sections in a CSV file.
`CsvOptions`	`setSkipLeadingRows(Long skipLeadingRows)` [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data.