#include <query_request.h>

Inheritance diagram for google_bigquery_api::QueryRequest:

Public Member Functions
	QueryRequest (const Json::Value &storage)

	QueryRequest (Json::Value *storage)

virtual	~QueryRequest ()

const StringPiece	GetTypeName () const

bool	has_default_dataset () const

void	clear_default_dataset ()

const DatasetReference	get_default_dataset () const

DatasetReference	mutable_defaultDataset ()

bool	has_dry_run () const

void	clear_dry_run ()

bool	get_dry_run () const

void	set_dry_run (bool value)

bool	has_kind () const

void	clear_kind ()

const StringPiece	get_kind () const

void	set_kind (const StringPiece &value)

bool	has_location () const

void	clear_location ()

const StringPiece	get_location () const

void	set_location (const StringPiece &value)

bool	has_max_results () const

void	clear_max_results ()

uint32	get_max_results () const

void	set_max_results (uint32 value)

bool	has_parameter_mode () const

void	clear_parameter_mode ()

const StringPiece	get_parameter_mode () const

void	set_parameter_mode (const StringPiece &value)

bool	has_preserve_nulls () const

void	clear_preserve_nulls ()

bool	get_preserve_nulls () const

void	set_preserve_nulls (bool value)

bool	has_query () const

void	clear_query ()

const StringPiece	get_query () const

void	set_query (const StringPiece &value)

bool	has_query_parameters () const

void	clear_query_parameters ()

const client::JsonCppArray< QueryParameter >	get_query_parameters () const

client::JsonCppArray< QueryParameter >	mutable_queryParameters ()

bool	has_timeout_ms () const

void	clear_timeout_ms ()

uint32	get_timeout_ms () const

void	set_timeout_ms (uint32 value)

bool	has_use_legacy_sql () const

void	clear_use_legacy_sql ()

bool	get_use_legacy_sql () const

void	set_use_legacy_sql (bool value)

bool	has_use_query_cache () const

void	clear_use_query_cache ()

bool	get_use_query_cache () const

void	set_use_query_cache (bool value)

Static Public Member Functions
static QueryRequest *	New ()

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ QueryRequest() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ QueryRequest() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~QueryRequest()

google_bigquery_api::QueryRequest::~QueryRequest ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_default_dataset()

void google_bigquery_api::QueryRequest::clear_default_dataset ( )

inline

Clears the 'defaultDataset' attribute.

◆ clear_dry_run()

void google_bigquery_api::QueryRequest::clear_dry_run ( )

inline

Clears the 'dryRun' attribute.

◆ clear_kind()

void google_bigquery_api::QueryRequest::clear_kind ( )

inline

Clears the 'kind' attribute.

◆ clear_location()

void google_bigquery_api::QueryRequest::clear_location ( )

inline

Clears the 'location' attribute.

◆ clear_max_results()

void google_bigquery_api::QueryRequest::clear_max_results ( )

inline

Clears the 'maxResults' attribute.

◆ clear_parameter_mode()

void google_bigquery_api::QueryRequest::clear_parameter_mode ( )

inline

Clears the 'parameterMode' attribute.

◆ clear_preserve_nulls()

void google_bigquery_api::QueryRequest::clear_preserve_nulls ( )

inline

Clears the 'preserveNulls' attribute.

◆ clear_query()

void google_bigquery_api::QueryRequest::clear_query ( )

inline

Clears the 'query' attribute.

◆ clear_query_parameters()

void google_bigquery_api::QueryRequest::clear_query_parameters ( )

inline

Clears the 'queryParameters' attribute.

◆ clear_timeout_ms()

void google_bigquery_api::QueryRequest::clear_timeout_ms ( )

inline

Clears the 'timeoutMs' attribute.

◆ clear_use_legacy_sql()

void google_bigquery_api::QueryRequest::clear_use_legacy_sql ( )

inline

Clears the 'useLegacySql' attribute.

◆ clear_use_query_cache()

void google_bigquery_api::QueryRequest::clear_use_query_cache ( )

inline

Clears the 'useQueryCache' attribute.

◆ get_default_dataset()

const DatasetReference google_bigquery_api::QueryRequest::get_default_dataset ( ) const

Get a reference to the value of the 'defaultDataset' attribute.

◆ get_dry_run()

bool google_bigquery_api::QueryRequest::get_dry_run ( ) const

inline

Get the value of the 'dryRun' attribute.

◆ get_kind()

const StringPiece google_bigquery_api::QueryRequest::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

◆ get_location()

const StringPiece google_bigquery_api::QueryRequest::get_location ( ) const

inline

Get the value of the 'location' attribute.

◆ get_max_results()

uint32 google_bigquery_api::QueryRequest::get_max_results ( ) const

inline

Get the value of the 'maxResults' attribute.

◆ get_parameter_mode()

const StringPiece google_bigquery_api::QueryRequest::get_parameter_mode ( ) const

inline

Get the value of the 'parameterMode' attribute.

◆ get_preserve_nulls()

bool google_bigquery_api::QueryRequest::get_preserve_nulls ( ) const

inline

Get the value of the 'preserveNulls' attribute.

◆ get_query()

const StringPiece google_bigquery_api::QueryRequest::get_query ( ) const

inline

Get the value of the 'query' attribute.

◆ get_query_parameters()

const client::JsonCppArray<QueryParameter > google_bigquery_api::QueryRequest::get_query_parameters ( ) const

Get a reference to the value of the 'queryParameters' attribute.

◆ get_timeout_ms()

uint32 google_bigquery_api::QueryRequest::get_timeout_ms ( ) const

inline

Get the value of the 'timeoutMs' attribute.

◆ get_use_legacy_sql()

bool google_bigquery_api::QueryRequest::get_use_legacy_sql ( ) const

inline

Get the value of the 'useLegacySql' attribute.

◆ get_use_query_cache()

bool google_bigquery_api::QueryRequest::get_use_query_cache ( ) const

inline

Get the value of the 'useQueryCache' attribute.

◆ GetTypeName()

const StringPiece google_bigquery_api::QueryRequest::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_bigquery_api::QueryRequest

◆ has_default_dataset()

bool google_bigquery_api::QueryRequest::has_default_dataset ( ) const

inline

Determine if the 'defaultDataset' attribute was set.

Returns: true if the 'defaultDataset' attribute was set.

◆ has_dry_run()

bool google_bigquery_api::QueryRequest::has_dry_run ( ) const

inline

Determine if the 'dryRun' attribute was set.

Returns: true if the 'dryRun' attribute was set.

◆ has_kind()

bool google_bigquery_api::QueryRequest::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns: true if the 'kind' attribute was set.

◆ has_location()

bool google_bigquery_api::QueryRequest::has_location ( ) const

inline

Determine if the 'location' attribute was set.

Returns: true if the 'location' attribute was set.

◆ has_max_results()

bool google_bigquery_api::QueryRequest::has_max_results ( ) const

inline

Determine if the 'maxResults' attribute was set.

Returns: true if the 'maxResults' attribute was set.

◆ has_parameter_mode()

bool google_bigquery_api::QueryRequest::has_parameter_mode ( ) const

inline

Determine if the 'parameterMode' attribute was set.

Returns: true if the 'parameterMode' attribute was set.

◆ has_preserve_nulls()

bool google_bigquery_api::QueryRequest::has_preserve_nulls ( ) const

inline

Determine if the 'preserveNulls' attribute was set.

Returns: true if the 'preserveNulls' attribute was set.

◆ has_query()

bool google_bigquery_api::QueryRequest::has_query ( ) const

inline

Determine if the 'query' attribute was set.

Returns: true if the 'query' attribute was set.

◆ has_query_parameters()

bool google_bigquery_api::QueryRequest::has_query_parameters ( ) const

inline

Determine if the 'queryParameters' attribute was set.

Returns: true if the 'queryParameters' attribute was set.

◆ has_timeout_ms()

bool google_bigquery_api::QueryRequest::has_timeout_ms ( ) const

inline

Determine if the 'timeoutMs' attribute was set.

Returns: true if the 'timeoutMs' attribute was set.

◆ has_use_legacy_sql()

bool google_bigquery_api::QueryRequest::has_use_legacy_sql ( ) const

inline

Determine if the 'useLegacySql' attribute was set.

Returns: true if the 'useLegacySql' attribute was set.

◆ has_use_query_cache()

bool google_bigquery_api::QueryRequest::has_use_query_cache ( ) const

inline

Determine if the 'useQueryCache' attribute was set.

Returns: true if the 'useQueryCache' attribute was set.

◆ mutable_defaultDataset()

DatasetReference google_bigquery_api::QueryRequest::mutable_defaultDataset ( )

Gets a reference to a mutable value of the 'defaultDataset' property.

[Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'.

Returns: The result can be modified to change the attribute value.

◆ mutable_queryParameters()

client::JsonCppArray<QueryParameter > google_bigquery_api::QueryRequest::mutable_queryParameters ( )

Gets a reference to a mutable value of the 'queryParameters' property.

Query parameters for Standard SQL queries.

Returns: The result can be modified to change the attribute value.

◆ New()

QueryRequest * google_bigquery_api::QueryRequest::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_dry_run()

void google_bigquery_api::QueryRequest::set_dry_run ( bool value )

inline

Change the 'dryRun' attribute.

[Optional] If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false.

Parameters

[in] value The new value.

◆ set_kind()

void google_bigquery_api::QueryRequest::set_kind ( const StringPiece & value )

inline

Change the 'kind' attribute.

The resource type of the request.

Parameters

[in] value The new value.

◆ set_location()

void google_bigquery_api::QueryRequest::set_location ( const StringPiece & value )

inline

Change the 'location' attribute.

The geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

Parameters

[in] value The new value.

◆ set_max_results()

void google_bigquery_api::QueryRequest::set_max_results ( uint32 value )

inline

Change the 'maxResults' attribute.

[Optional] The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies.

Parameters

[in] value The new value.

◆ set_parameter_mode()

void google_bigquery_api::QueryRequest::set_parameter_mode ( const StringPiece & value )

inline

Change the 'parameterMode' attribute.

Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named () query parameters in this query.

Parameters

[in] value The new value.

◆ set_preserve_nulls()

void google_bigquery_api::QueryRequest::set_preserve_nulls ( bool value )

inline

Change the 'preserveNulls' attribute.

Deprecated:

[Deprecated] This property is deprecated.

Parameters

[in] value The new value.

◆ set_query()

void google_bigquery_api::QueryRequest::set_query ( const StringPiece & value )

inline

Change the 'query' attribute.

[Required] A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]".

Parameters

[in] value The new value.

◆ set_timeout_ms()

void google_bigquery_api::QueryRequest::set_timeout_ms ( uint32 value )

inline

Change the 'timeoutMs' attribute.

[Optional] How long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the 'jobComplete' flag set to false. You can call GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds).

Parameters

[in] value The new value.

◆ set_use_legacy_sql()

void google_bigquery_api::QueryRequest::set_use_legacy_sql ( bool value )

inline

Change the 'useLegacySql' attribute.

Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.

Parameters

[in] value The new value.

◆ set_use_query_cache()

void google_bigquery_api::QueryRequest::set_use_query_cache ( bool value )

inline

Change the 'useQueryCache' attribute.

[Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true.

Parameters

[in] value The new value.

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

google/bigquery_api/query_request.h
google/bigquery_api/query_request.cc

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ QueryRequest() [1/2]

◆ QueryRequest() [2/2]

◆ ~QueryRequest()

Member Function Documentation

◆ clear_default_dataset()

◆ clear_dry_run()

◆ clear_kind()

◆ clear_location()

◆ clear_max_results()

◆ clear_parameter_mode()

◆ clear_preserve_nulls()

◆ clear_query()

◆ clear_query_parameters()

◆ clear_timeout_ms()

◆ clear_use_legacy_sql()

◆ clear_use_query_cache()

◆ get_default_dataset()

◆ get_dry_run()

◆ get_kind()

◆ get_location()

◆ get_max_results()

◆ get_parameter_mode()

◆ get_preserve_nulls()

◆ get_query()

◆ get_query_parameters()

◆ get_timeout_ms()

◆ get_use_legacy_sql()

◆ get_use_query_cache()

◆ GetTypeName()

◆ has_default_dataset()

◆ has_dry_run()

◆ has_kind()

◆ has_location()

◆ has_max_results()

◆ has_parameter_mode()

◆ has_preserve_nulls()

◆ has_query()

◆ has_query_parameters()

◆ has_timeout_ms()

◆ has_use_legacy_sql()

◆ has_use_query_cache()

◆ mutable_defaultDataset()

◆ mutable_queryParameters()

◆ New()

◆ set_dry_run()

◆ set_kind()

◆ set_location()

◆ set_max_results()

◆ set_parameter_mode()

◆ set_preserve_nulls()

◆ set_query()

◆ set_timeout_ms()

◆ set_use_legacy_sql()

◆ set_use_query_cache()