#include <dataflow_service.h>
Implements the aggregated 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/cloud-platform https://www.googleapis.com/auth/compute https://www.googleapis.com/auth/compute.readonly https://www.googleapis.com/auth/userinfo.email
◆ ProjectsResource_JobsResource_AggregatedMethod()
google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::ProjectsResource_JobsResource_AggregatedMethod |
( |
const DataflowService * |
_service_, |
|
|
client::AuthorizationCredential * |
_credential_, |
|
|
const absl::string_view & |
project_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 | The project which owns the jobs. |
◆ ~ProjectsResource_JobsResource_AggregatedMethod()
google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::~ProjectsResource_JobsResource_AggregatedMethod |
( |
| ) |
|
|
virtual |
◆ AppendOptionalQueryParameters()
util::Status google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::AppendOptionalQueryParameters |
( |
string * |
target | ) |
|
|
virtual |
◆ AppendVariable()
util::Status google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::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_dataflow_api::DataflowServiceBaseRequest.
◆ clear_filter()
void google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::clear_filter |
( |
| ) |
|
|
inline |
Clears the 'filter
' attribute so it is no longer set.
◆ clear_location()
void google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::clear_location |
( |
| ) |
|
|
inline |
Clears the 'location
' attribute so it is no longer set.
◆ clear_page_size()
void google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::clear_page_size |
( |
| ) |
|
|
inline |
Clears the 'pageSize
' attribute so it is no longer set.
◆ clear_page_token()
void google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::clear_page_token |
( |
| ) |
|
|
inline |
Clears the 'pageToken
' attribute so it is no longer set.
◆ clear_view()
void google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::clear_view |
( |
| ) |
|
|
inline |
Clears the 'view
' attribute so it is no longer set.
◆ ExecuteAndParseResponse()
util::Status google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::ExecuteAndParseResponse |
( |
ListJobsResponse * |
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_filter()
const string& google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::get_filter |
( |
| ) |
const |
|
inline |
Gets the optional 'filter
' attribute.
If the value is not set then the default value will be returned.
◆ get_location()
const string& google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::get_location |
( |
| ) |
const |
|
inline |
Gets the optional 'location
' attribute.
If the value is not set then the default value will be returned.
◆ get_page_size()
int32 google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::get_page_size |
( |
| ) |
const |
|
inline |
Gets the optional 'pageSize
' attribute.
If the value is not set then the default value will be returned.
◆ get_page_token()
const string& google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::get_page_token |
( |
| ) |
const |
|
inline |
Gets the optional 'pageToken
' attribute.
If the value is not set then the default value will be returned.
◆ get_view()
const string& google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::get_view |
( |
| ) |
const |
|
inline |
Gets the optional 'view
' attribute.
If the value is not set then the default value will be returned.
◆ mutable_filter()
string* google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::mutable_filter |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional filter
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ mutable_location()
string* google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::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_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::mutable_pageToken |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional pageToken
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ mutable_view()
string* google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::mutable_view |
( |
| ) |
|
|
inline |
Gets a modifiable pointer to the optional view
' attribute.
- Returns
- The value can be set by dereferencing the pointer.
◆ set_filter()
void google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::set_filter |
( |
const string & |
value | ) |
|
|
inline |
Sets the 'filter
' attribute.
- Parameters
-
[in] | value | The kind of filter to use. |
◆ set_location()
void google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::set_location |
( |
const string & |
value | ) |
|
|
inline |
Sets the 'location
' attribute.
- Parameters
-
◆ set_page_size()
void google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::set_page_size |
( |
int32 |
value | ) |
|
|
inline |
Sets the 'pageSize
' attribute.
- Parameters
-
[in] | value | If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit. |
◆ set_page_token()
void google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::set_page_token |
( |
const string & |
value | ) |
|
|
inline |
Sets the 'pageToken
' attribute.
- Parameters
-
[in] | value | Set this to the 'next_page_token' field of a previous response to request additional results in a long list. |
◆ set_view()
void google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::set_view |
( |
const string & |
value | ) |
|
|
inline |
Sets the 'view
' attribute.
- Parameters
-
[in] | value | Level of information requested in response. Default is JOB_VIEW_SUMMARY . |
The documentation for this class was generated from the following files: