Class CsvOptions (2.42.1)

public final class CsvOptions extends FormatOptions

Google BigQuery options for CSV format. This class wraps some properties of CSV files used by BigQuery to parse external data.

Inheritance

Object > FormatOptions > CsvOptions

Inherited Members

FormatOptions.avro()

FormatOptions.bigtable()

FormatOptions.csv()

FormatOptions.datastoreBackup()

FormatOptions.equals(Object)

FormatOptions.getType()

FormatOptions.googleSheets()

FormatOptions.hashCode()

FormatOptions.iceberg()

FormatOptions.json()

FormatOptions.of(String)

FormatOptions.orc()

FormatOptions.parquet()

FormatOptions.toString()

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

newBuilder()

public static CsvOptions.Builder newBuilder()

Returns a builder for a CsvOptions object.

Returns
Type	Description
`CsvOptions.Builder`

Methods

allowJaggedRows()

public Boolean allowJaggedRows()

Returns whether 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 the number of bad records exceeds ExternalTableDefinition#getMaxBadRecords(), an invalid error is returned in the job result.

Returns
Type	Description
`Boolean`

allowQuotedNewLines()

public Boolean allowQuotedNewLines()

Returns whether BigQuery should allow quoted data sections that contain newline characters in a CSV file.

Returns
Type	Description
`Boolean`

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

FormatOptions.equals(Object obj)

getEncoding()

public String getEncoding()

Returns the character encoding of the data. The supported values are UTF-8 or ISO-8859-1. If not set, UTF-8 is used. BigQuery decodes the data after the raw, binary data has been split using the values set in #getQuote() and #getFieldDelimiter().

Returns
Type	Description
`String`

getFieldDelimiter()

public String getFieldDelimiter()

Returns the separator for fields in a CSV file.

Returns
Type	Description
`String`

getNullMarker()

public String getNullMarker()

Returns the string that represents a null value in a CSV file.

Returns
Type	Description
`String`

getPreserveAsciiControlCharacters()

public Boolean getPreserveAsciiControlCharacters()

Returns whether BigQuery should allow ascii control characters in a CSV file. By default ascii control characters are not allowed.

Returns
Type	Description
`Boolean`

getQuote()

public String getQuote()

Returns the value that is used to quote data sections in a CSV file.

Returns
Type	Description
`String`

getSkipLeadingRows()

public Long getSkipLeadingRows()

Returns the number of rows at the top of a CSV file that BigQuery will skip when reading the data.

Returns
Type	Description
`Long`

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

FormatOptions.hashCode()

toBuilder()

public CsvOptions.Builder toBuilder()

Returns a builder for the CsvOptions object.

Returns
Type	Description
`CsvOptions.Builder`

toString()

public String toString()

Returns
Type	Description
`String`

Overrides

FormatOptions.toString()