ResourceGroupsTaggingAPIRequest Class

(QtAws::ResourceGroupsTaggingAPI::ResourceGroupsTaggingAPIRequest)

The ResourceGroupsTaggingAPIRequest class provides an interface for ResourceGroupsTaggingAPI requests. More...

Public Types

enum Action { GetResourcesAction, GetTagKeysAction, GetTagValuesAction, TagResourcesAction, UntagResourcesAction }
flags Actions

Public Functions

ResourceGroupsTaggingAPIRequest(const Action action)
ResourceGroupsTaggingAPIRequest(const ResourceGroupsTaggingAPIRequest &other)
Action action() const
QString actionString() const
QString apiVersion() const
void setAction(const Action action)
void setApiVersion(const QString &version)
ResourceGroupsTaggingAPIRequest &operator=(const ResourceGroupsTaggingAPIRequest &other)
virtual bool operator==(const ResourceGroupsTaggingAPIRequest &other) const

Protected Functions

ResourceGroupsTaggingAPIRequest(ResourceGroupsTaggingAPIRequestPrivate * const d)
int clearParameter(const QString &name)
void clearParameters()
QVariant parameter(const QString &name, const QVariant &defaultValue = QVariant()) const
const QVariantMap &parameters() const
void setParameter(const QString &name, const QVariant &value)
void setParameters(const QVariantMap &parameters)

Reimplemented Protected Functions

virtual QNetworkRequest unsignedRequest(const QUrl &endpoint) const override

Detailed Description

The ResourceGroupsTaggingAPIRequest class provides an interface for ResourceGroupsTaggingAPI requests.

Member Type Documentation

enum ResourceGroupsTaggingAPIRequest::Action
flags ResourceGroupsTaggingAPIRequest::Actions

This enum describes the actions that can be performed as ResourceGroupsTaggingAPI requests.

ConstantValueDescription
QtAws::ResourceGroupsTaggingAPI::ResourceGroupsTaggingAPIRequest::GetResourcesAction0ResourceGroupsTaggingAPI GetResources action.
QtAws::ResourceGroupsTaggingAPI::ResourceGroupsTaggingAPIRequest::GetTagKeysAction1ResourceGroupsTaggingAPI GetTagKeys action.
QtAws::ResourceGroupsTaggingAPI::ResourceGroupsTaggingAPIRequest::GetTagValuesAction2ResourceGroupsTaggingAPI GetTagValues action.
QtAws::ResourceGroupsTaggingAPI::ResourceGroupsTaggingAPIRequest::TagResourcesAction3ResourceGroupsTaggingAPI TagResources action.
QtAws::ResourceGroupsTaggingAPI::ResourceGroupsTaggingAPIRequest::UntagResourcesAction4ResourceGroupsTaggingAPI UntagResources action.

The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.

Member Function Documentation

ResourceGroupsTaggingAPIRequest::ResourceGroupsTaggingAPIRequest(const Action action)

Constructs a ResourceGroupsTaggingAPIRequest object for ResourceGroupsTaggingAPI action.

ResourceGroupsTaggingAPIRequest::ResourceGroupsTaggingAPIRequest(const ResourceGroupsTaggingAPIRequest &other)

Constructs a copy of other.

[protected] ResourceGroupsTaggingAPIRequest::ResourceGroupsTaggingAPIRequest(ResourceGroupsTaggingAPIRequestPrivate * const d)

Constructs aa ResourceGroupsTaggingAPIRequest object with private implementation d.

This overload allows derived classes to provide their own private class implementation that inherits from ResourceGroupsTaggingAPIRequestPrivate.

Action ResourceGroupsTaggingAPIRequest::action() const

Returns the ResourceGroupsTaggingAPI action to be performed by this request.

See also setAction().

QString ResourceGroupsTaggingAPIRequest::actionString() const

Returns the name of the ResourceGroupsTaggingAPI action to be performed by this request.

QString ResourceGroupsTaggingAPIRequest::apiVersion() const

Returns the ResourceGroupsTaggingAPI API version implemented by this request.

See also setApiVersion().

[protected] int ResourceGroupsTaggingAPIRequest::clearParameter(const QString &name)

Removes the a name parameter from the request, then returns the number of paramters removed (typically 0 or 1).

[protected] void ResourceGroupsTaggingAPIRequest::clearParameters()

Removes all parameters from the request.

[protected] QVariant ResourceGroupsTaggingAPIRequest::parameter(const QString &name, const QVariant &defaultValue = QVariant()) const

Returns the value of the name pararemter if set; defaultValue otherwise.

See also setParameter().

[protected] const QVariantMap &ResourceGroupsTaggingAPIRequest::parameters() const

Returns the parameters included in this request.

See also setParameters().

void ResourceGroupsTaggingAPIRequest::setAction(const Action action)

Sets the ResourceGroupsTaggingAPI action to be performed by this request to action.

See also action().

void ResourceGroupsTaggingAPIRequest::setApiVersion(const QString &version)

Sets the ResourceGroupsTaggingAPI API version to include in this request to version.

See also apiVersion().

[protected] void ResourceGroupsTaggingAPIRequest::setParameter(const QString &name, const QVariant &value)

Sets the name parameter to value.

See also parameter().

[protected] void ResourceGroupsTaggingAPIRequest::setParameters(const QVariantMap &parameters)

Sets the paramters for this request to parameters. Any request parameters set previously will be discarded.

See also parameters().

[override virtual protected] QNetworkRequest ResourceGroupsTaggingAPIRequest::unsignedRequest(const QUrl &endpoint) const

Reimplemented from AwsAbstractRequest::unsignedRequest().

Returns a network request for the ResourceGroupsTaggingAPI request using the given endpoint.

This ResourceGroupsTaggingAPI implementation builds request URLs by combining the common query parameters (such as Action and Version), with any that have been added (via setParameter) by child classes.

ResourceGroupsTaggingAPIRequest &ResourceGroupsTaggingAPIRequest::operator=(const ResourceGroupsTaggingAPIRequest &other)

Sets the ResourceGroupsTaggingAPIRequest object to be equal to other.

[virtual] bool ResourceGroupsTaggingAPIRequest::operator==(const ResourceGroupsTaggingAPIRequest &other) const

Returns true if this request is equal to other; false otherwise.

Note, most derived *Request classes do not need to provider their own implementations of this function, since most such request classes rely on this class' parameters functionality for all request parameters, and that parameters map is already checked via this implementation.

© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.