google_dataflow_api::DataflowServiceBaseRequest Class Reference

#include <dataflow_service.h>

Inheritance diagram for google_dataflow_api::DataflowServiceBaseRequest:

Public Member Functions
	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)
virtual util::Status	AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)
virtual util::Status	AppendOptionalQueryParameters (string *target)

Protected Member Functions
void	AddJsonContentToRequest (const client::JsonCppData *content)

Detailed Description

Implements a common base method for all methods within the DataflowService.

This class defines all the attributes common across all methods. It does not pertain to any specific service API so is not normally explicitly instantiated.

Constructor & Destructor Documentation

DataflowServiceBaseRequest()

google_dataflow_api::DataflowServiceBaseRequest::DataflowServiceBaseRequest	(	const client::ClientService *	service,
		client::AuthorizationCredential *	credential,
		client::HttpRequest::HttpMethod	method,
		const StringPiece &	uri_template
	)

Standard constructor.

Parameters

[in]	service	The service instance to send to when executed. In practice this will be supplied internally by the service when it acts as a method factory.
[in]	credential	If not NULL then the credential to authorize with. In practice this is supplied by the user code that is creating the method instance.
[in]	method	The HTTP method to use for the underlying HTTP request. In practice this is specified by the particular API endpoint and supplied internally by the derived class for that endpoint.
[in]	uri_template	The RFC 6570 URI Template specifying the url to invoke The parameters in the template should be resolvable attributes. In practice this parameter is supplied internally by the derived class for the endpoint.

~DataflowServiceBaseRequest()

google_dataflow_api::DataflowServiceBaseRequest::~DataflowServiceBaseRequest ( )

virtual

Standard destructor.

Member Function Documentation

$Xgafv()

string* mutable_ google_dataflow_api::DataflowServiceBaseRequest::$Xgafv ( )

inline

Gets a modifiable pointer to the optional $.xgafv' attribute.

Returns

The value can be set by dereferencing the pointer.

AddJsonContentToRequest()

void google_dataflow_api::DataflowServiceBaseRequest::AddJsonContentToRequest ( const client::JsonCppData *  content )

protected

Prepares the method's HTTP request to send body content as JSON.

Only to be used for method constructors.

AppendOptionalQueryParameters()

util::Status google_dataflow_api::DataflowServiceBaseRequest::AppendOptionalQueryParameters ( string *  target )

virtual

Appends the optional query parameters to the target URL.

Parameters

[in,out]

target

The URL string to append to.

Reimplemented in google_dataflow_api::ProjectsResource_TemplatesResource_LaunchMethod, google_dataflow_api::ProjectsResource_TemplatesResource_GetMethod, google_dataflow_api::ProjectsResource_SnapshotsResource_ListMethod, google_dataflow_api::ProjectsResource_SnapshotsResource_GetMethod, google_dataflow_api::ProjectsResource_LocationsResource_TemplatesResource_LaunchMethod, google_dataflow_api::ProjectsResource_LocationsResource_TemplatesResource_GetMethod, google_dataflow_api::ProjectsResource_LocationsResource_SqlResource_ValidateMethod, google_dataflow_api::ProjectsResource_LocationsResource_SnapshotsResource_ListMethod, google_dataflow_api::ProjectsResource_LocationsResource_JobsResource_MessagesResource_ListMethod, google_dataflow_api::ProjectsResource_LocationsResource_JobsResource_ListMethod, google_dataflow_api::ProjectsResource_LocationsResource_JobsResource_GetMetricsMethod, google_dataflow_api::ProjectsResource_LocationsResource_JobsResource_GetMethod, google_dataflow_api::ProjectsResource_LocationsResource_JobsResource_CreateMethod, google_dataflow_api::ProjectsResource_JobsResource_MessagesResource_ListMethod, google_dataflow_api::ProjectsResource_JobsResource_UpdateMethod, google_dataflow_api::ProjectsResource_JobsResource_ListMethod, google_dataflow_api::ProjectsResource_JobsResource_GetMetricsMethod, google_dataflow_api::ProjectsResource_JobsResource_GetMethod, google_dataflow_api::ProjectsResource_JobsResource_CreateMethod, google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod, and google_dataflow_api::ProjectsResource_DeleteSnapshotsMethod.

AppendVariable()

util::Status google_dataflow_api::DataflowServiceBaseRequest::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 supplied to the constructor.

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 in google_dataflow_api::ProjectsResource_TemplatesResource_LaunchMethod, google_dataflow_api::ProjectsResource_TemplatesResource_GetMethod, google_dataflow_api::ProjectsResource_TemplatesResource_CreateMethod, google_dataflow_api::ProjectsResource_SnapshotsResource_ListMethod, google_dataflow_api::ProjectsResource_SnapshotsResource_GetMethod, google_dataflow_api::ProjectsResource_LocationsResource_TemplatesResource_LaunchMethod, google_dataflow_api::ProjectsResource_LocationsResource_TemplatesResource_GetMethod, google_dataflow_api::ProjectsResource_LocationsResource_TemplatesResource_CreateMethod, google_dataflow_api::ProjectsResource_LocationsResource_SqlResource_ValidateMethod, google_dataflow_api::ProjectsResource_LocationsResource_SnapshotsResource_ListMethod, google_dataflow_api::ProjectsResource_LocationsResource_SnapshotsResource_GetMethod, google_dataflow_api::ProjectsResource_LocationsResource_SnapshotsResource_DeleteMethod, google_dataflow_api::ProjectsResource_LocationsResource_JobsResource_WorkItemsResource_ReportStatusMethod, google_dataflow_api::ProjectsResource_LocationsResource_JobsResource_WorkItemsResource_LeaseMethod, google_dataflow_api::ProjectsResource_LocationsResource_JobsResource_SnapshotsResource_ListMethod, google_dataflow_api::ProjectsResource_LocationsResource_JobsResource_MessagesResource_ListMethod, google_dataflow_api::ProjectsResource_LocationsResource_JobsResource_DebugResource_SendCaptureMethod, google_dataflow_api::ProjectsResource_LocationsResource_JobsResource_DebugResource_GetConfigMethod, google_dataflow_api::ProjectsResource_LocationsResource_JobsResource_UpdateMethod, google_dataflow_api::ProjectsResource_LocationsResource_JobsResource_SnapshotMethod, google_dataflow_api::ProjectsResource_LocationsResource_JobsResource_ListMethod, google_dataflow_api::ProjectsResource_LocationsResource_JobsResource_GetMetricsMethod, google_dataflow_api::ProjectsResource_LocationsResource_JobsResource_GetMethod, google_dataflow_api::ProjectsResource_LocationsResource_JobsResource_CreateMethod, google_dataflow_api::ProjectsResource_LocationsResource_FlexTemplatesResource_LaunchMethod, google_dataflow_api::ProjectsResource_LocationsResource_WorkerMessagesMethod, google_dataflow_api::ProjectsResource_JobsResource_WorkItemsResource_ReportStatusMethod, google_dataflow_api::ProjectsResource_JobsResource_WorkItemsResource_LeaseMethod, google_dataflow_api::ProjectsResource_JobsResource_MessagesResource_ListMethod, google_dataflow_api::ProjectsResource_JobsResource_DebugResource_SendCaptureMethod, google_dataflow_api::ProjectsResource_JobsResource_DebugResource_GetConfigMethod, google_dataflow_api::ProjectsResource_JobsResource_UpdateMethod, google_dataflow_api::ProjectsResource_JobsResource_SnapshotMethod, google_dataflow_api::ProjectsResource_JobsResource_ListMethod, google_dataflow_api::ProjectsResource_JobsResource_GetMetricsMethod, google_dataflow_api::ProjectsResource_JobsResource_GetMethod, google_dataflow_api::ProjectsResource_JobsResource_CreateMethod, google_dataflow_api::ProjectsResource_JobsResource_AggregatedMethod, google_dataflow_api::ProjectsResource_WorkerMessagesMethod, and google_dataflow_api::ProjectsResource_DeleteSnapshotsMethod.

clear_access_token()

void google_dataflow_api::DataflowServiceBaseRequest::clear_access_token ( )

inline

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

clear_alt()

void google_dataflow_api::DataflowServiceBaseRequest::clear_alt ( )

inline

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

clear_callback()

void google_dataflow_api::DataflowServiceBaseRequest::clear_callback ( )

inline

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

clear_fields()

void google_dataflow_api::DataflowServiceBaseRequest::clear_fields ( )

inline

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

clear_key()

void google_dataflow_api::DataflowServiceBaseRequest::clear_key ( )

inline

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

clear_oauth_token()

void google_dataflow_api::DataflowServiceBaseRequest::clear_oauth_token ( )

inline

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

clear_pretty_print()

void google_dataflow_api::DataflowServiceBaseRequest::clear_pretty_print ( )

inline

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

clear_quota_user()

void google_dataflow_api::DataflowServiceBaseRequest::clear_quota_user ( )

inline

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

clear_upload_protocol()

void google_dataflow_api::DataflowServiceBaseRequest::clear_upload_protocol ( )

inline

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

clear_upload_type()

void google_dataflow_api::DataflowServiceBaseRequest::clear_upload_type ( )

inline

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

clear_xgafv()

void google_dataflow_api::DataflowServiceBaseRequest::clear_xgafv ( )

inline

Clears the '$.xgafv' attribute so it is no longer set.

get_access_token()

const string& google_dataflow_api::DataflowServiceBaseRequest::get_access_token ( ) const

inline

Gets the optional 'access_token' attribute.

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

get_alt()

const string& google_dataflow_api::DataflowServiceBaseRequest::get_alt ( ) const

inline

Gets the optional 'alt' attribute.

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

get_callback()

const string& google_dataflow_api::DataflowServiceBaseRequest::get_callback ( ) const

inline

Gets the optional 'callback' attribute.

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

get_fields()

const string& google_dataflow_api::DataflowServiceBaseRequest::get_fields ( ) const

inline

Gets the optional 'fields' attribute.

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

get_key()

const string& google_dataflow_api::DataflowServiceBaseRequest::get_key ( ) const

inline

Gets the optional 'key' attribute.

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

get_oauth_token()

const string& google_dataflow_api::DataflowServiceBaseRequest::get_oauth_token ( ) const

inline

Gets the optional 'oauth_token' attribute.

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

get_pretty_print()

bool google_dataflow_api::DataflowServiceBaseRequest::get_pretty_print ( ) const

inline

Gets the optional 'prettyPrint' attribute.

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

get_quota_user()

const string& google_dataflow_api::DataflowServiceBaseRequest::get_quota_user ( ) const

inline

Gets the optional 'quotaUser' attribute.

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

get_upload_protocol()

const string& google_dataflow_api::DataflowServiceBaseRequest::get_upload_protocol ( ) const

inline

Gets the optional 'upload_protocol' attribute.

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

get_upload_type()

const string& google_dataflow_api::DataflowServiceBaseRequest::get_upload_type ( ) const

inline

Gets the optional 'uploadType' attribute.

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

get_xgafv()

const string& google_dataflow_api::DataflowServiceBaseRequest::get_xgafv ( ) const

inline

Gets the optional '$.xgafv' attribute.

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

mutable_accessToken()

string* google_dataflow_api::DataflowServiceBaseRequest::mutable_accessToken ( )

inline

Gets a modifiable pointer to the optional access_token' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_alt()

string* google_dataflow_api::DataflowServiceBaseRequest::mutable_alt ( )

inline

Gets a modifiable pointer to the optional alt' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_callback()

string* google_dataflow_api::DataflowServiceBaseRequest::mutable_callback ( )

inline

Gets a modifiable pointer to the optional callback' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_fields()

string* google_dataflow_api::DataflowServiceBaseRequest::mutable_fields ( )

inline

Gets a modifiable pointer to the optional fields' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_key()

string* google_dataflow_api::DataflowServiceBaseRequest::mutable_key ( )

inline

Gets a modifiable pointer to the optional key' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_oauthToken()

string* google_dataflow_api::DataflowServiceBaseRequest::mutable_oauthToken ( )

inline

Gets a modifiable pointer to the optional oauth_token' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_quotaUser()

string* google_dataflow_api::DataflowServiceBaseRequest::mutable_quotaUser ( )

inline

Gets a modifiable pointer to the optional quotaUser' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_uploadProtocol()

string* google_dataflow_api::DataflowServiceBaseRequest::mutable_uploadProtocol ( )

inline

Gets a modifiable pointer to the optional upload_protocol' attribute.

Returns

The value can be set by dereferencing the pointer.

mutable_uploadType()

string* google_dataflow_api::DataflowServiceBaseRequest::mutable_uploadType ( )

inline

Gets a modifiable pointer to the optional uploadType' attribute.

Returns

The value can be set by dereferencing the pointer.

set_access_token()

void google_dataflow_api::DataflowServiceBaseRequest::set_access_token ( const string &  value )

inline

Sets the 'access_token' attribute.

Parameters

[in]

value

OAuth access token.

set_alt()

void google_dataflow_api::DataflowServiceBaseRequest::set_alt ( const string &  value )

inline

Sets the 'alt' attribute.

Parameters

[in]

value

Data format for response.

set_callback()

void google_dataflow_api::DataflowServiceBaseRequest::set_callback ( const string &  value )

inline

Sets the 'callback' attribute.

Parameters

[in]

value

JSONP.

set_fields()

void google_dataflow_api::DataflowServiceBaseRequest::set_fields ( const string &  value )

inline

Sets the 'fields' attribute.

Parameters

[in]

value

Selector specifying which fields to include in a partial response.

set_key()

void google_dataflow_api::DataflowServiceBaseRequest::set_key ( const string &  value )

inline

Sets the 'key' attribute.

Parameters

[in]

value

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

set_oauth_token()

void google_dataflow_api::DataflowServiceBaseRequest::set_oauth_token ( const string &  value )

inline

Sets the 'oauth_token' attribute.

Parameters

[in]

value

OAuth 2.0 token for the current user.

set_pretty_print()

void google_dataflow_api::DataflowServiceBaseRequest::set_pretty_print ( bool  value )

inline

Sets the 'prettyPrint' attribute.

Parameters

[in]

value

Returns response with indentations and line breaks.

set_quota_user()

void google_dataflow_api::DataflowServiceBaseRequest::set_quota_user ( const string &  value )

inline

Sets the 'quotaUser' attribute.

Parameters

[in]

value

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

set_upload_protocol()

void google_dataflow_api::DataflowServiceBaseRequest::set_upload_protocol ( const string &  value )

inline

Sets the 'upload_protocol' attribute.

Parameters

[in]

value

Upload protocol for media (e.g. "raw", "multipart").

set_upload_type()

void google_dataflow_api::DataflowServiceBaseRequest::set_upload_type ( const string &  value )

inline

Sets the 'uploadType' attribute.

Parameters

[in]

value

Legacy upload protocol for media (e.g. "media", "multipart").

set_xgafv()

void google_dataflow_api::DataflowServiceBaseRequest::set_xgafv ( const string &  value )

inline

Sets the '$.xgafv' attribute.

Parameters

[in]

value

V1 error format.

---

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

• google/dataflow_api/dataflow_service.h
• google/dataflow_api/dataflow_service.cc