deploymentmanager  v2
Public Member Functions | List of all members
google_deploymentmanager_api::DeploymentsResource_UpdateMethod Class Reference

#include <deployment_manager_service.h>

Inheritance diagram for google_deploymentmanager_api::DeploymentsResource_UpdateMethod:
google_deploymentmanager_api::DeploymentManagerServiceBaseRequest

Public Member Functions

 DeploymentsResource_UpdateMethod (const DeploymentManagerService *_service_, client::AuthorizationCredential *_credential_, const absl::string_view &project, const absl::string_view &deployment, const Deployment &_content_)
 
virtual ~DeploymentsResource_UpdateMethod ()
 
void clear_create_policy ()
 
const string & get_create_policy () const
 
string * mutable_createPolicy ()
 
void set_create_policy (const string &value)
 
void clear_delete_policy ()
 
const string & get_delete_policy () const
 
string * mutable_deletePolicy ()
 
void set_delete_policy (const string &value)
 
void clear_preview ()
 
bool get_preview () const
 
void set_preview (bool value)
 
virtual util::Status AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)
 
virtual util::Status AppendOptionalQueryParameters (string *target)
 
util::Status ExecuteAndParseResponse (Operation *data)
 
- Public Member Functions inherited from google_deploymentmanager_api::DeploymentManagerServiceBaseRequest
 DeploymentManagerServiceBaseRequest (const client::ClientService *service, client::AuthorizationCredential *credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)
 
virtual ~DeploymentManagerServiceBaseRequest ()
 
void clear_alt ()
 
const string & get_alt () const
 
string * mutable_alt ()
 
void set_alt (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_user_ip ()
 
const string & get_user_ip () const
 
string * mutable_userIp ()
 
void set_user_ip (const string &value)
 

Additional Inherited Members

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

Detailed Description

Implements the update 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/ndev.cloudman

Constructor & Destructor Documentation

◆ DeploymentsResource_UpdateMethod()

google_deploymentmanager_api::DeploymentsResource_UpdateMethod::DeploymentsResource_UpdateMethod ( const DeploymentManagerService _service_,
client::AuthorizationCredential *  _credential_,
const absl::string_view &  project,
const absl::string_view &  deployment,
const Deployment _content_ 
)

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]projectThe project ID for this request.
[in]deploymentThe name of the deployment for this request.
[in]<em>content</em>The data object to update.

◆ ~DeploymentsResource_UpdateMethod()

google_deploymentmanager_api::DeploymentsResource_UpdateMethod::~DeploymentsResource_UpdateMethod ( )
virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_deploymentmanager_api::DeploymentsResource_UpdateMethod::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_deploymentmanager_api::DeploymentManagerServiceBaseRequest.

◆ AppendVariable()

util::Status google_deploymentmanager_api::DeploymentsResource_UpdateMethod::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_deploymentmanager_api::DeploymentManagerServiceBaseRequest.

◆ clear_create_policy()

void google_deploymentmanager_api::DeploymentsResource_UpdateMethod::clear_create_policy ( )
inline

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

◆ clear_delete_policy()

void google_deploymentmanager_api::DeploymentsResource_UpdateMethod::clear_delete_policy ( )
inline

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

◆ clear_preview()

void google_deploymentmanager_api::DeploymentsResource_UpdateMethod::clear_preview ( )
inline

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

◆ ExecuteAndParseResponse()

util::Status google_deploymentmanager_api::DeploymentsResource_UpdateMethod::ExecuteAndParseResponse ( Operation 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_create_policy()

const string& google_deploymentmanager_api::DeploymentsResource_UpdateMethod::get_create_policy ( ) const
inline

Gets the optional 'createPolicy' attribute.

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

◆ get_delete_policy()

const string& google_deploymentmanager_api::DeploymentsResource_UpdateMethod::get_delete_policy ( ) const
inline

Gets the optional 'deletePolicy' attribute.

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

◆ get_preview()

bool google_deploymentmanager_api::DeploymentsResource_UpdateMethod::get_preview ( ) const
inline

Gets the optional 'preview' attribute.

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

◆ mutable_createPolicy()

string* google_deploymentmanager_api::DeploymentsResource_UpdateMethod::mutable_createPolicy ( )
inline

Gets a modifiable pointer to the optional createPolicy' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ mutable_deletePolicy()

string* google_deploymentmanager_api::DeploymentsResource_UpdateMethod::mutable_deletePolicy ( )
inline

Gets a modifiable pointer to the optional deletePolicy' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ set_create_policy()

void google_deploymentmanager_api::DeploymentsResource_UpdateMethod::set_create_policy ( const string &  value)
inline

Sets the 'createPolicy' attribute.

Parameters
[in]valueSets the policy to use for creating new resources.

◆ set_delete_policy()

void google_deploymentmanager_api::DeploymentsResource_UpdateMethod::set_delete_policy ( const string &  value)
inline

Sets the 'deletePolicy' attribute.

Parameters
[in]valueSets the policy to use for deleting resources.

◆ set_preview()

void google_deploymentmanager_api::DeploymentsResource_UpdateMethod::set_preview ( bool  value)
inline

Sets the 'preview' attribute.

Parameters
[in]valueIf set to true, updates the deployment and creates and updates the "shell" resources but does not actually alter or instantiate these resources. This allows you to preview what your deployment will look like. You can use this intent to preview how an update would affect your deployment. You must provide a target.config with a configuration if this is set to true. After previewing a deployment, you can deploy your resources by making a request with the update() or you can cancelPreview() to remove the preview altogether. Note that the deployment will still exist after you cancel the preview and you must separately delete this deployment if you want to remove it.

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