androidenterprise  v1
Public Member Functions | List of all members
google_androidenterprise_api::StorelayoutclustersResource_UpdateMethod Class Reference

#include <android_enterprise_service.h>

Inheritance diagram for google_androidenterprise_api::StorelayoutclustersResource_UpdateMethod:
google_androidenterprise_api::AndroidEnterpriseServiceBaseRequest

Public Member Functions

 StorelayoutclustersResource_UpdateMethod (const AndroidEnterpriseService *_service_, client::AuthorizationCredential *_credential_, const absl::string_view &enterprise_id, const absl::string_view &page_id, const absl::string_view &cluster_id, const StoreCluster &_content_)
 
virtual ~StorelayoutclustersResource_UpdateMethod ()
 
virtual util::Status AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)
 
util::Status ExecuteAndParseResponse (StoreCluster *data)
 
- Public Member Functions inherited from google_androidenterprise_api::AndroidEnterpriseServiceBaseRequest
 AndroidEnterpriseServiceBaseRequest (const client::ClientService *service, client::AuthorizationCredential *credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)
 
virtual ~AndroidEnterpriseServiceBaseRequest ()
 
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)
 
virtual util::Status AppendOptionalQueryParameters (string *target)
 

Additional Inherited Members

- Protected Member Functions inherited from google_androidenterprise_api::AndroidEnterpriseServiceBaseRequest
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/androidenterprise

Constructor & Destructor Documentation

◆ StorelayoutclustersResource_UpdateMethod()

google_androidenterprise_api::StorelayoutclustersResource_UpdateMethod::StorelayoutclustersResource_UpdateMethod ( const AndroidEnterpriseService _service_,
client::AuthorizationCredential *  _credential_,
const absl::string_view &  enterprise_id,
const absl::string_view &  page_id,
const absl::string_view &  cluster_id,
const StoreCluster _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]enterprise_idThe ID of the enterprise.
[in]page_idThe ID of the page.
[in]cluster_idThe ID of the cluster.
[in]<em>content</em>The data object to update.

◆ ~StorelayoutclustersResource_UpdateMethod()

google_androidenterprise_api::StorelayoutclustersResource_UpdateMethod::~StorelayoutclustersResource_UpdateMethod ( )
virtual

Standard destructor.

Member Function Documentation

◆ AppendVariable()

util::Status google_androidenterprise_api::StorelayoutclustersResource_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_androidenterprise_api::AndroidEnterpriseServiceBaseRequest.

◆ ExecuteAndParseResponse()

util::Status google_androidenterprise_api::StorelayoutclustersResource_UpdateMethod::ExecuteAndParseResponse ( StoreCluster 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.

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