#include <rest_method.h>

Inheritance diagram for google_discovery_api::RestMethod:

Classes
class	RestMethodMediaUpload

class	RestMethodRequest

class	RestMethodResponse

Public Member Functions
	RestMethod (const Json::Value &storage)

	RestMethod (Json::Value *storage)

virtual	~RestMethod ()

const StringPiece	GetTypeName () const

bool	has_description () const

void	clear_description ()

const StringPiece	get_description () const

void	set_description (const StringPiece &value)

bool	has_etag_required () const

void	clear_etag_required ()

bool	get_etag_required () const

void	set_etag_required (bool value)

bool	has_http_method () const

void	clear_http_method ()

const StringPiece	get_http_method () const

void	set_http_method (const StringPiece &value)

bool	has_id () const

void	clear_id ()

const StringPiece	get_id () const

void	set_id (const StringPiece &value)

bool	has_media_upload () const

void	clear_media_upload ()

const RestMethodMediaUpload	get_media_upload () const

RestMethodMediaUpload	mutable_mediaUpload ()

bool	has_parameter_order () const

void	clear_parameter_order ()

const client::JsonCppArray< string >	get_parameter_order () const

client::JsonCppArray< string >	mutable_parameterOrder ()

bool	has_parameters () const

void	clear_parameters ()

const client::JsonCppAssociativeArray< JsonSchema >	get_parameters () const

client::JsonCppAssociativeArray< JsonSchema >	mutable_parameters ()

bool	has_path () const

void	clear_path ()

const StringPiece	get_path () const

void	set_path (const StringPiece &value)

bool	has_request () const

void	clear_request ()

const RestMethodRequest	get_request () const

RestMethodRequest	mutable_request ()

bool	has_response () const

void	clear_response ()

const RestMethodResponse	get_response () const

RestMethodResponse	mutable_response ()

bool	has_scopes () const

void	clear_scopes ()

const client::JsonCppArray< string >	get_scopes () const

client::JsonCppArray< string >	mutable_scopes ()

bool	has_supports_media_download () const

void	clear_supports_media_download ()

bool	get_supports_media_download () const

void	set_supports_media_download (bool value)

bool	has_supports_media_upload () const

void	clear_supports_media_upload ()

bool	get_supports_media_upload () const

void	set_supports_media_upload (bool value)

bool	has_supports_subscription () const

void	clear_supports_subscription ()

bool	get_supports_subscription () const

void	set_supports_subscription (bool value)

bool	has_use_media_download_service () const

void	clear_use_media_download_service ()

bool	get_use_media_download_service () const

void	set_use_media_download_service (bool value)

Static Public Member Functions
static RestMethod *	New ()

Detailed Description

No description provided.

Constructor & Destructor Documentation

◆ RestMethod() [1/2]

google_discovery_api::RestMethod::RestMethod ( const Json::Value & storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ RestMethod() [2/2]

google_discovery_api::RestMethod::RestMethod ( Json::Value * storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in] storage The underlying data storage for this instance.

◆ ~RestMethod()

google_discovery_api::RestMethod::~RestMethod ( )

virtual

Standard destructor.

Member Function Documentation

◆ clear_description()

void google_discovery_api::RestMethod::clear_description ( )

inline

Clears the 'description' attribute.

◆ clear_etag_required()

void google_discovery_api::RestMethod::clear_etag_required ( )

inline

Clears the 'etagRequired' attribute.

◆ clear_http_method()

void google_discovery_api::RestMethod::clear_http_method ( )

inline

Clears the 'httpMethod' attribute.

◆ clear_id()

void google_discovery_api::RestMethod::clear_id ( )

inline

Clears the 'id' attribute.

◆ clear_media_upload()

void google_discovery_api::RestMethod::clear_media_upload ( )

inline

Clears the 'mediaUpload' attribute.

◆ clear_parameter_order()

void google_discovery_api::RestMethod::clear_parameter_order ( )

inline

Clears the 'parameterOrder' attribute.

◆ clear_parameters()

void google_discovery_api::RestMethod::clear_parameters ( )

inline

Clears the 'parameters' attribute.

◆ clear_path()

void google_discovery_api::RestMethod::clear_path ( )

inline

Clears the 'path' attribute.

◆ clear_request()

void google_discovery_api::RestMethod::clear_request ( )

inline

Clears the 'request' attribute.

◆ clear_response()

void google_discovery_api::RestMethod::clear_response ( )

inline

Clears the 'response' attribute.

◆ clear_scopes()

void google_discovery_api::RestMethod::clear_scopes ( )

inline

Clears the 'scopes' attribute.

◆ clear_supports_media_download()

void google_discovery_api::RestMethod::clear_supports_media_download ( )

inline

Clears the 'supportsMediaDownload' attribute.

◆ clear_supports_media_upload()

void google_discovery_api::RestMethod::clear_supports_media_upload ( )

inline

Clears the 'supportsMediaUpload' attribute.

◆ clear_supports_subscription()

void google_discovery_api::RestMethod::clear_supports_subscription ( )

inline

Clears the 'supportsSubscription' attribute.

◆ clear_use_media_download_service()

void google_discovery_api::RestMethod::clear_use_media_download_service ( )

inline

Clears the 'useMediaDownloadService' attribute.

◆ get_description()

const StringPiece google_discovery_api::RestMethod::get_description ( ) const

inline

Get the value of the 'description' attribute.

◆ get_etag_required()

bool google_discovery_api::RestMethod::get_etag_required ( ) const

inline

Get the value of the 'etagRequired' attribute.

◆ get_http_method()

const StringPiece google_discovery_api::RestMethod::get_http_method ( ) const

inline

Get the value of the 'httpMethod' attribute.

◆ get_id()

const StringPiece google_discovery_api::RestMethod::get_id ( ) const

inline

Get the value of the 'id' attribute.

◆ get_media_upload()

const RestMethodMediaUpload google_discovery_api::RestMethod::get_media_upload ( ) const

inline

Get a reference to the value of the 'mediaUpload' attribute.

◆ get_parameter_order()

const client::JsonCppArray<string > google_discovery_api::RestMethod::get_parameter_order ( ) const

inline

Get a reference to the value of the 'parameterOrder' attribute.

◆ get_parameters()

const client::JsonCppAssociativeArray<JsonSchema > google_discovery_api::RestMethod::get_parameters ( ) const

Get a reference to the value of the 'parameters' attribute.

◆ get_path()

const StringPiece google_discovery_api::RestMethod::get_path ( ) const

inline

Get the value of the 'path' attribute.

◆ get_request()

const RestMethodRequest google_discovery_api::RestMethod::get_request ( ) const

inline

Get a reference to the value of the 'request' attribute.

◆ get_response()

const RestMethodResponse google_discovery_api::RestMethod::get_response ( ) const

inline

Get a reference to the value of the 'response' attribute.

◆ get_scopes()

const client::JsonCppArray<string > google_discovery_api::RestMethod::get_scopes ( ) const

inline

Get a reference to the value of the 'scopes' attribute.

◆ get_supports_media_download()

bool google_discovery_api::RestMethod::get_supports_media_download ( ) const

inline

Get the value of the 'supportsMediaDownload' attribute.

◆ get_supports_media_upload()

bool google_discovery_api::RestMethod::get_supports_media_upload ( ) const

inline

Get the value of the 'supportsMediaUpload' attribute.

◆ get_supports_subscription()

bool google_discovery_api::RestMethod::get_supports_subscription ( ) const

inline

Get the value of the 'supportsSubscription' attribute.

◆ get_use_media_download_service()

bool google_discovery_api::RestMethod::get_use_media_download_service ( ) const

inline

Get the value of the 'useMediaDownloadService' attribute.

◆ GetTypeName()

const StringPiece google_discovery_api::RestMethod::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns: google_discovery_api::RestMethod

◆ has_description()

bool google_discovery_api::RestMethod::has_description ( ) const

inline

Determine if the 'description' attribute was set.

Returns: true if the 'description' attribute was set.

◆ has_etag_required()

bool google_discovery_api::RestMethod::has_etag_required ( ) const

inline

Determine if the 'etagRequired' attribute was set.

Returns: true if the 'etagRequired' attribute was set.

◆ has_http_method()

bool google_discovery_api::RestMethod::has_http_method ( ) const

inline

Determine if the 'httpMethod' attribute was set.

Returns: true if the 'httpMethod' attribute was set.

◆ has_id()

bool google_discovery_api::RestMethod::has_id ( ) const

inline

Determine if the 'id' attribute was set.

Returns: true if the 'id' attribute was set.

◆ has_media_upload()

bool google_discovery_api::RestMethod::has_media_upload ( ) const

inline

Determine if the 'mediaUpload' attribute was set.

Returns: true if the 'mediaUpload' attribute was set.

◆ has_parameter_order()

bool google_discovery_api::RestMethod::has_parameter_order ( ) const

inline

Determine if the 'parameterOrder' attribute was set.

Returns: true if the 'parameterOrder' attribute was set.

◆ has_parameters()

bool google_discovery_api::RestMethod::has_parameters ( ) const

inline

Determine if the 'parameters' attribute was set.

Returns: true if the 'parameters' attribute was set.

◆ has_path()

bool google_discovery_api::RestMethod::has_path ( ) const

inline

Determine if the 'path' attribute was set.

Returns: true if the 'path' attribute was set.

◆ has_request()

bool google_discovery_api::RestMethod::has_request ( ) const

inline

Determine if the 'request' attribute was set.

Returns: true if the 'request' attribute was set.

◆ has_response()

bool google_discovery_api::RestMethod::has_response ( ) const

inline

Determine if the 'response' attribute was set.

Returns: true if the 'response' attribute was set.

◆ has_scopes()

bool google_discovery_api::RestMethod::has_scopes ( ) const

inline

Determine if the 'scopes' attribute was set.

Returns: true if the 'scopes' attribute was set.

◆ has_supports_media_download()

bool google_discovery_api::RestMethod::has_supports_media_download ( ) const

inline

Determine if the 'supportsMediaDownload' attribute was set.

Returns: true if the 'supportsMediaDownload' attribute was set.

◆ has_supports_media_upload()

bool google_discovery_api::RestMethod::has_supports_media_upload ( ) const

inline

Determine if the 'supportsMediaUpload' attribute was set.

Returns: true if the 'supportsMediaUpload' attribute was set.

◆ has_supports_subscription()

bool google_discovery_api::RestMethod::has_supports_subscription ( ) const

inline

Determine if the 'supportsSubscription' attribute was set.

Returns: true if the 'supportsSubscription' attribute was set.

◆ has_use_media_download_service()

bool google_discovery_api::RestMethod::has_use_media_download_service ( ) const

inline

Determine if the 'useMediaDownloadService' attribute was set.

Returns: true if the 'useMediaDownloadService' attribute was set.

◆ mutable_mediaUpload()

RestMethodMediaUpload google_discovery_api::RestMethod::mutable_mediaUpload ( )

inline

Gets a reference to a mutable value of the 'mediaUpload' property.

Media upload parameters.

Returns: The result can be modified to change the attribute value.

◆ mutable_parameterOrder()

client::JsonCppArray<string > google_discovery_api::RestMethod::mutable_parameterOrder ( )

inline

Gets a reference to a mutable value of the 'parameterOrder' property.

Ordered list of required parameters, serves as a hint to clients on how to structure their method signatures. The array is ordered such that the "most-significant" parameter appears first.

Returns: The result can be modified to change the attribute value.

◆ mutable_parameters()

client::JsonCppAssociativeArray<JsonSchema > google_discovery_api::RestMethod::mutable_parameters ( )

Gets a reference to a mutable value of the 'parameters' property.

Details for all parameters in this method.

Returns: The result can be modified to change the attribute value.

◆ mutable_request()

RestMethodRequest google_discovery_api::RestMethod::mutable_request ( )

inline

Gets a reference to a mutable value of the 'request' property.

The schema for the request.

Returns: The result can be modified to change the attribute value.

◆ mutable_response()

RestMethodResponse google_discovery_api::RestMethod::mutable_response ( )

inline

Gets a reference to a mutable value of the 'response' property.

The schema for the response.

Returns: The result can be modified to change the attribute value.

◆ mutable_scopes()

client::JsonCppArray<string > google_discovery_api::RestMethod::mutable_scopes ( )

inline

Gets a reference to a mutable value of the 'scopes' property.

OAuth 2.0 scopes applicable to this method.

Returns: The result can be modified to change the attribute value.

◆ New()

RestMethod * google_discovery_api::RestMethod::New ( )

static

Creates a new default instance.

Returns: Ownership is passed back to the caller.

◆ set_description()

void google_discovery_api::RestMethod::set_description ( const StringPiece & value )

inline

Change the 'description' attribute.

Description of this method.

Parameters

[in] value The new value.

◆ set_etag_required()

void google_discovery_api::RestMethod::set_etag_required ( bool value )

inline

Change the 'etagRequired' attribute.

Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header.

Parameters

[in] value The new value.

◆ set_http_method()

void google_discovery_api::RestMethod::set_http_method ( const StringPiece & value )

inline

Change the 'httpMethod' attribute.

HTTP method used by this method.

Parameters

[in] value The new value.

◆ set_id()

void google_discovery_api::RestMethod::set_id ( const StringPiece & value )

inline

Change the 'id' attribute.

A unique ID for this method. This property can be used to match methods between different versions of Discovery.

Parameters

[in] value The new value.

◆ set_path()

void google_discovery_api::RestMethod::set_path ( const StringPiece & value )

inline

Change the 'path' attribute.

The URI path of this REST method. Should be used in conjunction with the basePath property at the api-level.

Parameters

[in] value The new value.

◆ set_supports_media_download()

void google_discovery_api::RestMethod::set_supports_media_download ( bool value )

inline

Change the 'supportsMediaDownload' attribute.

Whether this method supports media downloads.

Parameters

[in] value The new value.

◆ set_supports_media_upload()

void google_discovery_api::RestMethod::set_supports_media_upload ( bool value )

inline

Change the 'supportsMediaUpload' attribute.

Whether this method supports media uploads.

Parameters

[in] value The new value.

◆ set_supports_subscription()

void google_discovery_api::RestMethod::set_supports_subscription ( bool value )

inline

Change the 'supportsSubscription' attribute.

Whether this method supports subscriptions.

Parameters

[in] value The new value.

◆ set_use_media_download_service()

void google_discovery_api::RestMethod::set_use_media_download_service ( bool value )

inline

Change the 'useMediaDownloadService' attribute.

Indicates that downloads from this method should use the download service URL (i.e. "/download"). Only applies if the method supports media download.

Parameters

[in] value The new value.

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

google/discovery_api/rest_method.h
google/discovery_api/rest_method.cc

Classes

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ RestMethod() [1/2]

◆ RestMethod() [2/2]

◆ ~RestMethod()

Member Function Documentation

◆ clear_description()

◆ clear_etag_required()

◆ clear_http_method()

◆ clear_id()

◆ clear_media_upload()

◆ clear_parameter_order()

◆ clear_parameters()

◆ clear_path()

◆ clear_request()

◆ clear_response()

◆ clear_scopes()

◆ clear_supports_media_download()

◆ clear_supports_media_upload()

◆ clear_supports_subscription()

◆ clear_use_media_download_service()

◆ get_description()

◆ get_etag_required()

◆ get_http_method()

◆ get_id()

◆ get_media_upload()

◆ get_parameter_order()

◆ get_parameters()

◆ get_path()

◆ get_request()

◆ get_response()

◆ get_scopes()

◆ get_supports_media_download()

◆ get_supports_media_upload()

◆ get_supports_subscription()

◆ get_use_media_download_service()

◆ GetTypeName()

◆ has_description()

◆ has_etag_required()

◆ has_http_method()

◆ has_id()

◆ has_media_upload()

◆ has_parameter_order()

◆ has_parameters()

◆ has_path()

◆ has_request()

◆ has_response()

◆ has_scopes()

◆ has_supports_media_download()

◆ has_supports_media_upload()

◆ has_supports_subscription()

◆ has_use_media_download_service()

◆ mutable_mediaUpload()

◆ mutable_parameterOrder()

◆ mutable_parameters()

◆ mutable_request()

◆ mutable_response()

◆ mutable_scopes()

◆ New()

◆ set_description()

◆ set_etag_required()

◆ set_http_method()

◆ set_id()

◆ set_path()

◆ set_supports_media_download()

◆ set_supports_media_upload()

◆ set_supports_subscription()

◆ set_use_media_download_service()