google_bigquery_api::GoogleSheetsOptions Class Reference

#include <google_sheets_options.h>

Inheritance diagram for google_bigquery_api::GoogleSheetsOptions:

Public Member Functions
	GoogleSheetsOptions (const Json::Value &storage)
	GoogleSheetsOptions (Json::Value *storage)
virtual	~GoogleSheetsOptions ()
const StringPiece	GetTypeName () const
bool	has_range () const
void	clear_range ()
const StringPiece	get_range () const
void	set_range (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 GoogleSheetsOptions *	New ()

Detailed Description

No description provided.

Constructor & Destructor Documentation

GoogleSheetsOptions() [1/2]

google_bigquery_api::GoogleSheetsOptions::GoogleSheetsOptions ( const Json::Value &  storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

GoogleSheetsOptions() [2/2]

google_bigquery_api::GoogleSheetsOptions::GoogleSheetsOptions ( Json::Value *  storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~GoogleSheetsOptions()

google_bigquery_api::GoogleSheetsOptions::~GoogleSheetsOptions ( )

virtual

Standard destructor.

Member Function Documentation

clear_range()

void google_bigquery_api::GoogleSheetsOptions::clear_range ( )

inline

Clears the 'range' attribute.

clear_skip_leading_rows()

void google_bigquery_api::GoogleSheetsOptions::clear_skip_leading_rows ( )

inline

Clears the 'skipLeadingRows' attribute.

get_range()

const StringPiece google_bigquery_api::GoogleSheetsOptions::get_range ( ) const

inline

Get the value of the 'range' attribute.

get_skip_leading_rows()

int64 google_bigquery_api::GoogleSheetsOptions::get_skip_leading_rows ( ) const

inline

Get the value of the 'skipLeadingRows' attribute.

GetTypeName()

const StringPiece google_bigquery_api::GoogleSheetsOptions::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_bigquery_api::GoogleSheetsOptions

has_range()

bool google_bigquery_api::GoogleSheetsOptions::has_range ( ) const

inline

Determine if the 'range' attribute was set.

Returns

true if the 'range' attribute was set.

has_skip_leading_rows()

bool google_bigquery_api::GoogleSheetsOptions::has_skip_leading_rows ( ) const

inline

Determine if the 'skipLeadingRows' attribute was set.

Returns

true if the 'skipLeadingRows' attribute was set.

New()

GoogleSheetsOptions * google_bigquery_api::GoogleSheetsOptions::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_range()

void google_bigquery_api::GoogleSheetsOptions::set_range ( const StringPiece &  value )

inline

Change the 'range' attribute.

[Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20.

Parameters

[in]

value

The new value.

set_skip_leading_rows()

void google_bigquery_api::GoogleSheetsOptions::set_skip_leading_rows ( int64  value )

inline

Change the 'skipLeadingRows' attribute.

[Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, 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]

value

The new value.

---

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

• google/bigquery_api/google_sheets_options.h
• google/bigquery_api/google_sheets_options.cc