google_drive_api::PropertiesResource_GetMethod Class Reference

#include <drive_service.h>

Inheritance diagram for google_drive_api::PropertiesResource_GetMethod:

Public Member Functions
	PropertiesResource_GetMethod (const DriveService *_service_, client::AuthorizationCredential *_credential_, const absl::string_view &file_id, const absl::string_view &property_key)
virtual	~PropertiesResource_GetMethod ()
void	clear_visibility ()
const string &	get_visibility () const
string *	mutable_visibility ()
void	set_visibility (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 (Property *data)
Public Member Functions inherited from google_drive_api::DriveServiceBaseRequest
	DriveServiceBaseRequest (const client::ClientService *service, client::AuthorizationCredential *credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)
virtual	~DriveServiceBaseRequest ()
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_drive_api::DriveServiceBaseRequest
void	AddJsonContentToRequest (const client::JsonCppData *content)

Detailed Description

Implements the get 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/drive https://www.googleapis.com/auth/drive.appdata https://www.googleapis.com/auth/drive.file https://www.googleapis.com/auth/drive.metadata https://www.googleapis.com/auth/drive.metadata.readonly https://www.googleapis.com/auth/drive.photos.readonly https://www.googleapis.com/auth/drive.readonly

Constructor & Destructor Documentation

PropertiesResource_GetMethod()

google_drive_api::PropertiesResource_GetMethod::PropertiesResource_GetMethod	(	const DriveService *	_service_,
		client::AuthorizationCredential *	_credential_,
		const absl::string_view &	file_id,
		const absl::string_view &	property_key
	)

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]	file_id	The ID of the file.
[in]	property_key	The key of the property.

~PropertiesResource_GetMethod()

google_drive_api::PropertiesResource_GetMethod::~PropertiesResource_GetMethod ( )

virtual

Standard destructor.

Member Function Documentation

AppendOptionalQueryParameters()

util::Status google_drive_api::PropertiesResource_GetMethod::AppendOptionalQueryParameters ( string *  target )

virtual

Appends the optional query parameters to the target URL.

Parameters

[in,out]

target

The URL string to append to.

Reimplemented from google_drive_api::DriveServiceBaseRequest.

AppendVariable()

util::Status google_drive_api::PropertiesResource_GetMethod::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_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 from google_drive_api::DriveServiceBaseRequest.

clear_visibility()

void google_drive_api::PropertiesResource_GetMethod::clear_visibility ( )

inline

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

ExecuteAndParseResponse()

util::Status google_drive_api::PropertiesResource_GetMethod::ExecuteAndParseResponse ( Property *  data )

inline

Executes the method and parses the response into a data object on success.

Parameters

[out]

data

Loads 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_visibility()

const string& google_drive_api::PropertiesResource_GetMethod::get_visibility ( ) const

inline

Gets the optional 'visibility' attribute.

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

mutable_visibility()

string* google_drive_api::PropertiesResource_GetMethod::mutable_visibility ( )

inline

Gets a modifiable pointer to the optional visibility' attribute.

Returns

The value can be set by dereferencing the pointer.

set_visibility()

void google_drive_api::PropertiesResource_GetMethod::set_visibility ( const string &  value )

inline

Sets the 'visibility' attribute.

Parameters

[in]

value

The visibility of the property.

---

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

• google/drive_api/drive_service.h
• google/drive_api/drive_service.cc