cloudresourcemanager  v1beta1
Public Member Functions | Protected Member Functions | List of all members
google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest Class Reference

#include <cloud_resource_manager_service.h>

Inheritance diagram for google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest:
google_cloudresourcemanager_api::OrganizationsResource_GetIamPolicyMethod google_cloudresourcemanager_api::OrganizationsResource_GetMethod google_cloudresourcemanager_api::OrganizationsResource_ListMethod google_cloudresourcemanager_api::OrganizationsResource_SetIamPolicyMethod google_cloudresourcemanager_api::OrganizationsResource_TestIamPermissionsMethod google_cloudresourcemanager_api::OrganizationsResource_UpdateMethod google_cloudresourcemanager_api::ProjectsResource_CreateMethod google_cloudresourcemanager_api::ProjectsResource_DeleteMethod google_cloudresourcemanager_api::ProjectsResource_GetAncestryMethod google_cloudresourcemanager_api::ProjectsResource_GetIamPolicyMethod google_cloudresourcemanager_api::ProjectsResource_GetMethod google_cloudresourcemanager_api::ProjectsResource_ListMethod google_cloudresourcemanager_api::ProjectsResource_SetIamPolicyMethod google_cloudresourcemanager_api::ProjectsResource_TestIamPermissionsMethod google_cloudresourcemanager_api::ProjectsResource_UndeleteMethod google_cloudresourcemanager_api::ProjectsResource_UpdateMethod

Public Member Functions

 CloudResourceManagerServiceBaseRequest (const client::ClientService *service, client::AuthorizationCredential *credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)
 
virtual ~CloudResourceManagerServiceBaseRequest ()
 
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 CloudResourceManagerService.

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

◆ CloudResourceManagerServiceBaseRequest()

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

Standard constructor.

Parameters
[in]serviceThe 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]credentialIf not NULL then the credential to authorize with. In practice this is supplied by the user code that is creating the method instance.
[in]methodThe 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_templateThe 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.

◆ ~CloudResourceManagerServiceBaseRequest()

google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::~CloudResourceManagerServiceBaseRequest ( )
virtual

Standard destructor.

Member Function Documentation

◆ $Xgafv()

string* mutable_ google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::$Xgafv ( )
inline

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

Returns
The value can be set by dereferencing the pointer.

◆ AddJsonContentToRequest()

void google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::AppendOptionalQueryParameters ( string *  target)
virtual

◆ AppendVariable()

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

◆ clear_access_token()

void google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::clear_access_token ( )
inline

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

◆ clear_alt()

void google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::clear_alt ( )
inline

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

◆ clear_callback()

void google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::clear_callback ( )
inline

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

◆ clear_fields()

void google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::clear_fields ( )
inline

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

◆ clear_key()

void google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::clear_key ( )
inline

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

◆ clear_oauth_token()

void google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::clear_oauth_token ( )
inline

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

◆ clear_pretty_print()

void google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::clear_pretty_print ( )
inline

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

◆ clear_quota_user()

void google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::clear_quota_user ( )
inline

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

◆ clear_upload_protocol()

void google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::clear_upload_protocol ( )
inline

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

◆ clear_upload_type()

void google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::clear_upload_type ( )
inline

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

◆ clear_xgafv()

void google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::clear_xgafv ( )
inline

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

◆ get_access_token()

const string& google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::set_access_token ( const string &  value)
inline

Sets the 'access_token' attribute.

Parameters
[in]valueOAuth access token.

◆ set_alt()

void google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::set_alt ( const string &  value)
inline

Sets the 'alt' attribute.

Parameters
[in]valueData format for response.

◆ set_callback()

void google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::set_callback ( const string &  value)
inline

Sets the 'callback' attribute.

Parameters
[in]valueJSONP.

◆ set_fields()

void google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::set_fields ( const string &  value)
inline

Sets the 'fields' attribute.

Parameters
[in]valueSelector specifying which fields to include in a partial response.

◆ set_key()

void google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::set_key ( const string &  value)
inline

Sets the 'key' attribute.

Parameters
[in]valueAPI 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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::set_oauth_token ( const string &  value)
inline

Sets the 'oauth_token' attribute.

Parameters
[in]valueOAuth 2.0 token for the current user.

◆ set_pretty_print()

void google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::set_pretty_print ( bool  value)
inline

Sets the 'prettyPrint' attribute.

Parameters
[in]valueReturns response with indentations and line breaks.

◆ set_quota_user()

void google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::set_quota_user ( const string &  value)
inline

Sets the 'quotaUser' attribute.

Parameters
[in]valueAvailable 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_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::set_upload_protocol ( const string &  value)
inline

Sets the 'upload_protocol' attribute.

Parameters
[in]valueUpload protocol for media (e.g. "raw", "multipart").

◆ set_upload_type()

void google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::set_upload_type ( const string &  value)
inline

Sets the 'uploadType' attribute.

Parameters
[in]valueLegacy upload protocol for media (e.g. "media", "multipart").

◆ set_xgafv()

void google_cloudresourcemanager_api::CloudResourceManagerServiceBaseRequest::set_xgafv ( const string &  value)
inline

Sets the '$.xgafv' attribute.

Parameters
[in]valueV1 error format.

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