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

#include <query_response.h>

Inheritance diagram for google_bigquery_api::QueryResponse:

Public Member Functions

 QueryResponse (const Json::Value &storage)
 
 QueryResponse (Json::Value *storage)
 
virtual ~QueryResponse ()
 
const StringPiece GetTypeName () const
 
bool has_cache_hit () const
 
void clear_cache_hit ()
 
bool get_cache_hit () const
 
void set_cache_hit (bool value)
 
bool has_errors () const
 
void clear_errors ()
 
const client::JsonCppArray< ErrorProtoget_errors () const
 
client::JsonCppArray< ErrorProtomutable_errors ()
 
bool has_job_complete () const
 
void clear_job_complete ()
 
bool get_job_complete () const
 
void set_job_complete (bool value)
 
bool has_job_reference () const
 
void clear_job_reference ()
 
const JobReference get_job_reference () const
 
JobReference mutable_jobReference ()
 
bool has_kind () const
 
void clear_kind ()
 
const StringPiece get_kind () const
 
void set_kind (const StringPiece &value)
 
bool has_num_dml_affected_rows () const
 
void clear_num_dml_affected_rows ()
 
int64 get_num_dml_affected_rows () const
 
void set_num_dml_affected_rows (int64 value)
 
bool has_page_token () const
 
void clear_page_token ()
 
const StringPiece get_page_token () const
 
void set_page_token (const StringPiece &value)
 
bool has_rows () const
 
void clear_rows ()
 
const client::JsonCppArray< TableRowget_rows () const
 
client::JsonCppArray< TableRowmutable_rows ()
 
bool has_schema () const
 
void clear_schema ()
 
const TableSchema get_schema () const
 
TableSchema mutable_schema ()
 
bool has_total_bytes_processed () const
 
void clear_total_bytes_processed ()
 
int64 get_total_bytes_processed () const
 
void set_total_bytes_processed (int64 value)
 
bool has_total_rows () const
 
void clear_total_rows ()
 
uint64 get_total_rows () const
 
void set_total_rows (uint64 value)
 

Static Public Member Functions

static QueryResponseNew ()
 

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ QueryResponse() [1/2]

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

Standard constructor for an immutable data object instance.

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

◆ QueryResponse() [2/2]

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

Standard constructor for a mutable data object instance.

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

◆ ~QueryResponse()

google_bigquery_api::QueryResponse::~QueryResponse ( )
virtual

Standard destructor.

Member Function Documentation

◆ clear_cache_hit()

void google_bigquery_api::QueryResponse::clear_cache_hit ( )
inline

Clears the 'cacheHit' attribute.

◆ clear_errors()

void google_bigquery_api::QueryResponse::clear_errors ( )
inline

Clears the 'errors' attribute.

◆ clear_job_complete()

void google_bigquery_api::QueryResponse::clear_job_complete ( )
inline

Clears the 'jobComplete' attribute.

◆ clear_job_reference()

void google_bigquery_api::QueryResponse::clear_job_reference ( )
inline

Clears the 'jobReference' attribute.

◆ clear_kind()

void google_bigquery_api::QueryResponse::clear_kind ( )
inline

Clears the 'kind' attribute.

◆ clear_num_dml_affected_rows()

void google_bigquery_api::QueryResponse::clear_num_dml_affected_rows ( )
inline

Clears the 'numDmlAffectedRows' attribute.

◆ clear_page_token()

void google_bigquery_api::QueryResponse::clear_page_token ( )
inline

Clears the 'pageToken' attribute.

◆ clear_rows()

void google_bigquery_api::QueryResponse::clear_rows ( )
inline

Clears the 'rows' attribute.

◆ clear_schema()

void google_bigquery_api::QueryResponse::clear_schema ( )
inline

Clears the 'schema' attribute.

◆ clear_total_bytes_processed()

void google_bigquery_api::QueryResponse::clear_total_bytes_processed ( )
inline

Clears the 'totalBytesProcessed' attribute.

◆ clear_total_rows()

void google_bigquery_api::QueryResponse::clear_total_rows ( )
inline

Clears the 'totalRows' attribute.

◆ get_cache_hit()

bool google_bigquery_api::QueryResponse::get_cache_hit ( ) const
inline

Get the value of the 'cacheHit' attribute.

◆ get_errors()

const client::JsonCppArray<ErrorProto > google_bigquery_api::QueryResponse::get_errors ( ) const

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

◆ get_job_complete()

bool google_bigquery_api::QueryResponse::get_job_complete ( ) const
inline

Get the value of the 'jobComplete' attribute.

◆ get_job_reference()

const JobReference google_bigquery_api::QueryResponse::get_job_reference ( ) const

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

◆ get_kind()

const StringPiece google_bigquery_api::QueryResponse::get_kind ( ) const
inline

Get the value of the 'kind' attribute.

◆ get_num_dml_affected_rows()

int64 google_bigquery_api::QueryResponse::get_num_dml_affected_rows ( ) const
inline

Get the value of the 'numDmlAffectedRows' attribute.

◆ get_page_token()

const StringPiece google_bigquery_api::QueryResponse::get_page_token ( ) const
inline

Get the value of the 'pageToken' attribute.

◆ get_rows()

const client::JsonCppArray<TableRow > google_bigquery_api::QueryResponse::get_rows ( ) const

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

◆ get_schema()

const TableSchema google_bigquery_api::QueryResponse::get_schema ( ) const

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

◆ get_total_bytes_processed()

int64 google_bigquery_api::QueryResponse::get_total_bytes_processed ( ) const
inline

Get the value of the 'totalBytesProcessed' attribute.

◆ get_total_rows()

uint64 google_bigquery_api::QueryResponse::get_total_rows ( ) const
inline

Get the value of the 'totalRows' attribute.

◆ GetTypeName()

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

Returns a string denoting the type of this data object.

Returns
google_bigquery_api::QueryResponse

◆ has_cache_hit()

bool google_bigquery_api::QueryResponse::has_cache_hit ( ) const
inline

Determine if the 'cacheHit' attribute was set.

Returns
true if the 'cacheHit' attribute was set.

◆ has_errors()

bool google_bigquery_api::QueryResponse::has_errors ( ) const
inline

Determine if the 'errors' attribute was set.

Returns
true if the 'errors' attribute was set.

◆ has_job_complete()

bool google_bigquery_api::QueryResponse::has_job_complete ( ) const
inline

Determine if the 'jobComplete' attribute was set.

Returns
true if the 'jobComplete' attribute was set.

◆ has_job_reference()

bool google_bigquery_api::QueryResponse::has_job_reference ( ) const
inline

Determine if the 'jobReference' attribute was set.

Returns
true if the 'jobReference' attribute was set.

◆ has_kind()

bool google_bigquery_api::QueryResponse::has_kind ( ) const
inline

Determine if the 'kind' attribute was set.

Returns
true if the 'kind' attribute was set.

◆ has_num_dml_affected_rows()

bool google_bigquery_api::QueryResponse::has_num_dml_affected_rows ( ) const
inline

Determine if the 'numDmlAffectedRows' attribute was set.

Returns
true if the 'numDmlAffectedRows' attribute was set.

◆ has_page_token()

bool google_bigquery_api::QueryResponse::has_page_token ( ) const
inline

Determine if the 'pageToken' attribute was set.

Returns
true if the 'pageToken' attribute was set.

◆ has_rows()

bool google_bigquery_api::QueryResponse::has_rows ( ) const
inline

Determine if the 'rows' attribute was set.

Returns
true if the 'rows' attribute was set.

◆ has_schema()

bool google_bigquery_api::QueryResponse::has_schema ( ) const
inline

Determine if the 'schema' attribute was set.

Returns
true if the 'schema' attribute was set.

◆ has_total_bytes_processed()

bool google_bigquery_api::QueryResponse::has_total_bytes_processed ( ) const
inline

Determine if the 'totalBytesProcessed' attribute was set.

Returns
true if the 'totalBytesProcessed' attribute was set.

◆ has_total_rows()

bool google_bigquery_api::QueryResponse::has_total_rows ( ) const
inline

Determine if the 'totalRows' attribute was set.

Returns
true if the 'totalRows' attribute was set.

◆ mutable_errors()

client::JsonCppArray<ErrorProto > google_bigquery_api::QueryResponse::mutable_errors ( )

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

[Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.

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

◆ mutable_jobReference()

JobReference google_bigquery_api::QueryResponse::mutable_jobReference ( )

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

Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).

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

◆ mutable_rows()

client::JsonCppArray<TableRow > google_bigquery_api::QueryResponse::mutable_rows ( )

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

An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.

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

◆ mutable_schema()

TableSchema google_bigquery_api::QueryResponse::mutable_schema ( )

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

The schema of the results. Present only when the query completes successfully.

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

◆ New()

QueryResponse * google_bigquery_api::QueryResponse::New ( )
static

Creates a new default instance.

Returns
Ownership is passed back to the caller.

◆ set_cache_hit()

void google_bigquery_api::QueryResponse::set_cache_hit ( bool  value)
inline

Change the 'cacheHit' attribute.

Whether the query result was fetched from the query cache.

Parameters
[in]valueThe new value.

◆ set_job_complete()

void google_bigquery_api::QueryResponse::set_job_complete ( bool  value)
inline

Change the 'jobComplete' attribute.

Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.

Parameters
[in]valueThe new value.

◆ set_kind()

void google_bigquery_api::QueryResponse::set_kind ( const StringPiece &  value)
inline

Change the 'kind' attribute.

The resource type.

Parameters
[in]valueThe new value.

◆ set_num_dml_affected_rows()

void google_bigquery_api::QueryResponse::set_num_dml_affected_rows ( int64  value)
inline

Change the 'numDmlAffectedRows' attribute.

[Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.

Parameters
[in]valueThe new value.

◆ set_page_token()

void google_bigquery_api::QueryResponse::set_page_token ( const StringPiece &  value)
inline

Change the 'pageToken' attribute.

A token used for paging results.

Parameters
[in]valueThe new value.

◆ set_total_bytes_processed()

void google_bigquery_api::QueryResponse::set_total_bytes_processed ( int64  value)
inline

Change the 'totalBytesProcessed' attribute.

The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run.

Parameters
[in]valueThe new value.

◆ set_total_rows()

void google_bigquery_api::QueryResponse::set_total_rows ( uint64  value)
inline

Change the 'totalRows' attribute.

The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results.

Parameters
[in]valueThe new value.

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