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

#include <bigquery_service.h>

Inheritance diagram for google_bigquery_api::JobsResource_GetQueryResultsMethod:
google_bigquery_api::BigqueryServiceBaseRequest

Public Member Functions

 JobsResource_GetQueryResultsMethod (const BigqueryService *_service_, client::AuthorizationCredential *_credential_, const absl::string_view &project_id, const absl::string_view &job_id)
 
virtual ~JobsResource_GetQueryResultsMethod ()
 
void clear_max_results ()
 
uint32 get_max_results () const
 
void set_max_results (uint32 value)
 
void clear_start_index ()
 
uint64 get_start_index () const
 
void set_start_index (uint64 value)
 
void clear_location ()
 
const string & get_location () const
 
string * mutable_location ()
 
void set_location (const string &value)
 
void clear_page_token ()
 
const string & get_page_token () const
 
string * mutable_pageToken ()
 
void set_page_token (const string &value)
 
void clear_timeout_ms ()
 
uint32 get_timeout_ms () const
 
void set_timeout_ms (uint32 value)
 
virtual util::Status AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)
 
virtual util::Status AppendOptionalQueryParameters (string *target)
 
util::Status ExecuteAndParseResponse (GetQueryResultsResponse *data)
 
- Public Member Functions inherited from google_bigquery_api::BigqueryServiceBaseRequest
 BigqueryServiceBaseRequest (const client::ClientService *service, client::AuthorizationCredential *credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)
 
virtual ~BigqueryServiceBaseRequest ()
 
void clear_alt ()
 
const string & get_alt () const
 
string * mutable_alt ()
 
void set_alt (const string &value)
 
void clear_fields ()
 
const string & get_fields () const
 
string * mutable_fields ()
 
void set_fields (const string &value)
 
void clear_key ()
 
const string & get_key () const
 
string * mutable_key ()
 
void set_key (const string &value)
 
void clear_oauth_token ()
 
const string & get_oauth_token () const
 
string * mutable_oauthToken ()
 
void set_oauth_token (const string &value)
 
void clear_pretty_print ()
 
bool get_pretty_print () const
 
void set_pretty_print (bool value)
 
void clear_quota_user ()
 
const string & get_quota_user () const
 
string * mutable_quotaUser ()
 
void set_quota_user (const string &value)
 
void clear_user_ip ()
 
const string & get_user_ip () const
 
string * mutable_userIp ()
 
void set_user_ip (const string &value)
 

Additional Inherited Members

- Protected Member Functions inherited from google_bigquery_api::BigqueryServiceBaseRequest
void AddJsonContentToRequest (const client::JsonCppData *content)
 

Detailed Description

Implements the getQueryResults method.

This class uses the Command Pattern. Construct an instance with the required parameters, then set any additional optional parameters by using the attribute setters. To invoke the method, call Execute.

One or more of these authorization scopes are required for this method: https://www.googleapis.com/auth/bigquery https://www.googleapis.com/auth/bigquery.readonly https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/cloud-platform.read-only

Constructor & Destructor Documentation

◆ JobsResource_GetQueryResultsMethod()

google_bigquery_api::JobsResource_GetQueryResultsMethod::JobsResource_GetQueryResultsMethod ( const BigqueryService _service_,
client::AuthorizationCredential *  _credential_,
const absl::string_view &  project_id,
const absl::string_view &  job_id 
)

The standard constructor takes all the required method parameters.

Parameters
[in]<em>service</em>The service instance to send to when executed.
[in]<em>credential</em>If not NULL, the credential to authorize with. In practice this is supplied by the user code that is creating the method instance.
[in]project_id[Required] Project ID of the query job.
[in]job_id[Required] Job ID of the query job.

◆ ~JobsResource_GetQueryResultsMethod()

google_bigquery_api::JobsResource_GetQueryResultsMethod::~JobsResource_GetQueryResultsMethod ( )
virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_bigquery_api::JobsResource_GetQueryResultsMethod::AppendOptionalQueryParameters ( string *  target)
virtual

Appends the optional query parameters to the target URL.

Parameters
[in,out]targetThe URL string to append to.

Reimplemented from google_bigquery_api::BigqueryServiceBaseRequest.

◆ AppendVariable()

util::Status google_bigquery_api::JobsResource_GetQueryResultsMethod::AppendVariable ( const StringPiece &  variable_name,
const client::UriTemplateConfig &  config,
string *  target 
)
virtual

Appends variable value to the target string.

This is a helper function used to resolve templated variables in the URI.

Parameters
[in]variable_nameThe name of the templated variable.
[in]configA pass-through parameter used for lists and maps.
[in,out]targetThe string to append the value to.

Reimplemented from google_bigquery_api::BigqueryServiceBaseRequest.

◆ clear_location()

void google_bigquery_api::JobsResource_GetQueryResultsMethod::clear_location ( )
inline

Clears the 'location' attribute so it is no longer set.

◆ clear_max_results()

void google_bigquery_api::JobsResource_GetQueryResultsMethod::clear_max_results ( )
inline

Clears the 'maxResults' attribute so it is no longer set.

◆ clear_page_token()

void google_bigquery_api::JobsResource_GetQueryResultsMethod::clear_page_token ( )
inline

Clears the 'pageToken' attribute so it is no longer set.

◆ clear_start_index()

void google_bigquery_api::JobsResource_GetQueryResultsMethod::clear_start_index ( )
inline

Clears the 'startIndex' attribute so it is no longer set.

◆ clear_timeout_ms()

void google_bigquery_api::JobsResource_GetQueryResultsMethod::clear_timeout_ms ( )
inline

Clears the 'timeoutMs' attribute so it is no longer set.

◆ ExecuteAndParseResponse()

util::Status google_bigquery_api::JobsResource_GetQueryResultsMethod::ExecuteAndParseResponse ( GetQueryResultsResponse data)
inline

Executes the method and parses the response into a data object on success.

Parameters
[out]dataLoads from the response payload JSON data on success.
Returns
Success if an HTTP 2xx response was received. Otherwise the status indicates the reason for failure. Finer detail may be available from the underlying http_request to distinguish the transport_status from the overal HTTP request status.

◆ get_location()

const string& google_bigquery_api::JobsResource_GetQueryResultsMethod::get_location ( ) const
inline

Gets the optional 'location' attribute.

If the value is not set then the default value will be returned.

◆ get_max_results()

uint32 google_bigquery_api::JobsResource_GetQueryResultsMethod::get_max_results ( ) const
inline

Gets the optional 'maxResults' attribute.

If the value is not set then the default value will be returned.

◆ get_page_token()

const string& google_bigquery_api::JobsResource_GetQueryResultsMethod::get_page_token ( ) const
inline

Gets the optional 'pageToken' attribute.

If the value is not set then the default value will be returned.

◆ get_start_index()

uint64 google_bigquery_api::JobsResource_GetQueryResultsMethod::get_start_index ( ) const
inline

Gets the optional 'startIndex' attribute.

If the value is not set then the default value will be returned.

◆ get_timeout_ms()

uint32 google_bigquery_api::JobsResource_GetQueryResultsMethod::get_timeout_ms ( ) const
inline

Gets the optional 'timeoutMs' attribute.

If the value is not set then the default value will be returned.

◆ mutable_location()

string* google_bigquery_api::JobsResource_GetQueryResultsMethod::mutable_location ( )
inline

Gets a modifiable pointer to the optional location' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ mutable_pageToken()

string* google_bigquery_api::JobsResource_GetQueryResultsMethod::mutable_pageToken ( )
inline

Gets a modifiable pointer to the optional pageToken' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ set_location()

void google_bigquery_api::JobsResource_GetQueryResultsMethod::set_location ( const string &  value)
inline

Sets the 'location' attribute.

Parameters
[in]valueThe geographic location where the job should run. Required except for US and EU. See details at https://cloud.google.com/bi gquery/docs/locations#specifying_your_location.

◆ set_max_results()

void google_bigquery_api::JobsResource_GetQueryResultsMethod::set_max_results ( uint32  value)
inline

Sets the 'maxResults' attribute.

Parameters
[in]valueMaximum number of results to read.

◆ set_page_token()

void google_bigquery_api::JobsResource_GetQueryResultsMethod::set_page_token ( const string &  value)
inline

Sets the 'pageToken' attribute.

Parameters
[in]valuePage token, returned by a previous call, to request the next page of results.

◆ set_start_index()

void google_bigquery_api::JobsResource_GetQueryResultsMethod::set_start_index ( uint64  value)
inline

Sets the 'startIndex' attribute.

Parameters
[in]valueZero-based index of the starting row.

◆ set_timeout_ms()

void google_bigquery_api::JobsResource_GetQueryResultsMethod::set_timeout_ms ( uint32  value)
inline

Sets the 'timeoutMs' attribute.

Parameters
[in]valueHow long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, the 'jobComplete' field in the response will be false.

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