dataflow  v1b3
Public Member Functions | List of all members
google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod Class Reference

#include <dataflow_service.h>

Inheritance diagram for google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod:
google_dataflow_api::DataflowServiceBaseRequest

Public Member Functions

 ProjectsResource_JobsResource_AggregatedMethod (const DataflowService *_service_, client::AuthorizationCredential *_credential_, const absl::string_view &project_id)
 
virtual ~ProjectsResource_JobsResource_AggregatedMethod ()
 
void clear_filter ()
 
const string & get_filter () const
 
string * mutable_filter ()
 
void set_filter (const string &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_page_size ()
 
int32 get_page_size () const
 
void set_page_size (int32 value)
 
void clear_view ()
 
const string & get_view () const
 
string * mutable_view ()
 
void set_view (const string &value)
 
virtual util::Status AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)
 
virtual util::Status AppendOptionalQueryParameters (string *target)
 
util::Status ExecuteAndParseResponse (ListJobsResponse *data)
 
- Public Member Functions inherited from google_dataflow_api::DataflowServiceBaseRequest
 DataflowServiceBaseRequest (const client::ClientService *service, client::AuthorizationCredential *credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)
 
virtual ~DataflowServiceBaseRequest ()
 
void clear_xgafv ()
 
const string & get_xgafv () const
 
string *mutable_ $Xgafv ()
 
void set_xgafv (const string &value)
 
void clear_access_token ()
 
const string & get_access_token () const
 
string * mutable_accessToken ()
 
void set_access_token (const string &value)
 
void clear_alt ()
 
const string & get_alt () const
 
string * mutable_alt ()
 
void set_alt (const string &value)
 
void clear_callback ()
 
const string & get_callback () const
 
string * mutable_callback ()
 
void set_callback (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_upload_type ()
 
const string & get_upload_type () const
 
string * mutable_uploadType ()
 
void set_upload_type (const string &value)
 
void clear_upload_protocol ()
 
const string & get_upload_protocol () const
 
string * mutable_uploadProtocol ()
 
void set_upload_protocol (const string &value)
 

Additional Inherited Members

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

Detailed Description

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

Constructor & Destructor Documentation

◆ 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_idThe project which owns the jobs.

◆ ~ProjectsResource_JobsResource_AggregatedMethod()

google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::~ProjectsResource_JobsResource_AggregatedMethod ( )
virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::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_dataflow_api::DataflowServiceBaseRequest.

◆ 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_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_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]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_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]valueThe 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
[in]valueThe regional endpoint that contains this job.

◆ set_page_size()

void google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod::set_page_size ( int32  value)
inline

Sets the 'pageSize' attribute.

Parameters
[in]valueIf 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]valueSet 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]valueLevel of information requested in response. Default is JOB_VIEW_SUMMARY.

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