bigquery  v2
Public Member Functions | Static Public Member Functions | List of all members
google_bigquery_api::CsvOptions Class Reference

#include <csv_options.h>

Inheritance diagram for google_bigquery_api::CsvOptions:

Public Member Functions

 CsvOptions (const Json::Value &storage)
 
 CsvOptions (Json::Value *storage)
 
virtual ~CsvOptions ()
 
const StringPiece GetTypeName () const
 
bool has_allow_jagged_rows () const
 
void clear_allow_jagged_rows ()
 
bool get_allow_jagged_rows () const
 
void set_allow_jagged_rows (bool value)
 
bool has_allow_quoted_newlines () const
 
void clear_allow_quoted_newlines ()
 
bool get_allow_quoted_newlines () const
 
void set_allow_quoted_newlines (bool value)
 
bool has_encoding () const
 
void clear_encoding ()
 
const StringPiece get_encoding () const
 
void set_encoding (const StringPiece &value)
 
bool has_field_delimiter () const
 
void clear_field_delimiter ()
 
const StringPiece get_field_delimiter () const
 
void set_field_delimiter (const StringPiece &value)
 
bool has_quote () const
 
void clear_quote ()
 
const StringPiece get_quote () const
 
void set_quote (const StringPiece &value)
 
bool has_skip_leading_rows () const
 
void clear_skip_leading_rows ()
 
int64 get_skip_leading_rows () const
 
void set_skip_leading_rows (int64 value)
 

Static Public Member Functions

static CsvOptionsNew ()
 

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ CsvOptions() [1/2]

google_bigquery_api::CsvOptions::CsvOptions ( const Json::Value &  storage)
explicit

Standard constructor for an immutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ CsvOptions() [2/2]

google_bigquery_api::CsvOptions::CsvOptions ( Json::Value *  storage)
explicit

Standard constructor for a mutable data object instance.

Parameters
[in]storageThe underlying data storage for this instance.

◆ ~CsvOptions()

google_bigquery_api::CsvOptions::~CsvOptions ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_allow_jagged_rows()

void google_bigquery_api::CsvOptions::clear_allow_jagged_rows ( )
inline

Clears the 'allowJaggedRows' attribute.

◆ clear_allow_quoted_newlines()

void google_bigquery_api::CsvOptions::clear_allow_quoted_newlines ( )
inline

Clears the 'allowQuotedNewlines' attribute.

◆ clear_encoding()

void google_bigquery_api::CsvOptions::clear_encoding ( )
inline

Clears the 'encoding' attribute.

◆ clear_field_delimiter()

void google_bigquery_api::CsvOptions::clear_field_delimiter ( )
inline

Clears the 'fieldDelimiter' attribute.

◆ clear_quote()

void google_bigquery_api::CsvOptions::clear_quote ( )
inline

Clears the 'quote' attribute.

◆ clear_skip_leading_rows()

void google_bigquery_api::CsvOptions::clear_skip_leading_rows ( )
inline

Clears the 'skipLeadingRows' attribute.

◆ get_allow_jagged_rows()

bool google_bigquery_api::CsvOptions::get_allow_jagged_rows ( ) const
inline

Get the value of the 'allowJaggedRows' attribute.

◆ get_allow_quoted_newlines()

bool google_bigquery_api::CsvOptions::get_allow_quoted_newlines ( ) const
inline

Get the value of the 'allowQuotedNewlines' attribute.

◆ get_encoding()

const StringPiece google_bigquery_api::CsvOptions::get_encoding ( ) const
inline

Get the value of the 'encoding' attribute.

◆ get_field_delimiter()

const StringPiece google_bigquery_api::CsvOptions::get_field_delimiter ( ) const
inline

Get the value of the 'fieldDelimiter' attribute.

◆ get_quote()

const StringPiece google_bigquery_api::CsvOptions::get_quote ( ) const
inline

Get the value of the 'quote' attribute.

◆ get_skip_leading_rows()

int64 google_bigquery_api::CsvOptions::get_skip_leading_rows ( ) const
inline

Get the value of the 'skipLeadingRows' attribute.

◆ GetTypeName()

const StringPiece google_bigquery_api::CsvOptions::GetTypeName ( ) const
inline

Returns a string denoting the type of this data object.

Returns
google_bigquery_api::CsvOptions

◆ has_allow_jagged_rows()

bool google_bigquery_api::CsvOptions::has_allow_jagged_rows ( ) const
inline

Determine if the 'allowJaggedRows' attribute was set.

Returns
true if the 'allowJaggedRows' attribute was set.

◆ has_allow_quoted_newlines()

bool google_bigquery_api::CsvOptions::has_allow_quoted_newlines ( ) const
inline

Determine if the 'allowQuotedNewlines' attribute was set.

Returns
true if the 'allowQuotedNewlines' attribute was set.

◆ has_encoding()

bool google_bigquery_api::CsvOptions::has_encoding ( ) const
inline

Determine if the 'encoding' attribute was set.

Returns
true if the 'encoding' attribute was set.

◆ has_field_delimiter()

bool google_bigquery_api::CsvOptions::has_field_delimiter ( ) const
inline

Determine if the 'fieldDelimiter' attribute was set.

Returns
true if the 'fieldDelimiter' attribute was set.

◆ has_quote()

bool google_bigquery_api::CsvOptions::has_quote ( ) const
inline

Determine if the 'quote' attribute was set.

Returns
true if the 'quote' attribute was set.

◆ has_skip_leading_rows()

bool google_bigquery_api::CsvOptions::has_skip_leading_rows ( ) const
inline

Determine if the 'skipLeadingRows' attribute was set.

Returns
true if the 'skipLeadingRows' attribute was set.

◆ New()

CsvOptions * google_bigquery_api::CsvOptions::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_allow_jagged_rows()

void google_bigquery_api::CsvOptions::set_allow_jagged_rows ( bool  value)
inline

Change the 'allowJaggedRows' attribute.

[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
[in]valueThe new value.

◆ set_allow_quoted_newlines()

void google_bigquery_api::CsvOptions::set_allow_quoted_newlines ( bool  value)
inline

Change the 'allowQuotedNewlines' attribute.

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

Parameters
[in]valueThe new value.

◆ set_encoding()

void google_bigquery_api::CsvOptions::set_encoding ( const StringPiece &  value)
inline

Change the 'encoding' attribute.

[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
[in]valueThe new value.

◆ set_field_delimiter()

void google_bigquery_api::CsvOptions::set_field_delimiter ( const StringPiece &  value)
inline

Change the 'fieldDelimiter' attribute.

[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
[in]valueThe new value.

◆ set_quote()

void google_bigquery_api::CsvOptions::set_quote ( const StringPiece &  value)
inline

Change the 'quote' attribute.

[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
[in]valueThe new value.

◆ set_skip_leading_rows()

void google_bigquery_api::CsvOptions::set_skip_leading_rows ( int64  value)
inline

Change the 'skipLeadingRows' attribute.

[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
[in]valueThe new value.

The documentation for this class was generated from the following files: