#include <bigquery_service.h>
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
◆ 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 |
◆ AppendOptionalQueryParameters()
util::Status google_bigquery_api::JobsResource_GetQueryResultsMethod::AppendOptionalQueryParameters |
( |
string * |
target | ) |
|
|
virtual |
◆ 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_name | The name of the templated variable. |
[in] | config | A pass-through parameter used for lists and maps. |
[in,out] | target | The 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] | data | Loads 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] | value | The 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] | value | Maximum 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] | value | Page 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] | value | Zero-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] | value | How 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: