ResourceGroupsRequest Class
(QtAws::ResourceGroups::ResourceGroupsRequest)The ResourceGroupsRequest class provides an interface for ResourceGroups requests. More...
Public Types
| enum | Action { CreateGroupAction, DeleteGroupAction, GetGroupAction, GetGroupQueryAction, ..., UpdateGroupQueryAction } |
| flags | Actions |
Public Functions
| ResourceGroupsRequest(const Action action) | |
| ResourceGroupsRequest(const ResourceGroupsRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| ResourceGroupsRequest & | operator=(const ResourceGroupsRequest &other) |
| virtual bool | operator==(const ResourceGroupsRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| ResourceGroupsRequest(ResourceGroupsRequestPrivate * 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 ¶meters) |
Reimplemented Protected Functions
| virtual QNetworkRequest | unsignedRequest(const QUrl &endpoint) const override |
- 4 protected functions inherited from QtAws::Core::AwsAbstractRequest
Detailed Description
The ResourceGroupsRequest class provides an interface for ResourceGroups requests.
Member Type Documentation
enum ResourceGroupsRequest::Action
flags ResourceGroupsRequest::Actions
This enum describes the actions that can be performed as ResourceGroups requests.
| Constant | Value | Description |
|---|---|---|
QtAws::ResourceGroups::ResourceGroupsRequest::CreateGroupAction | 0 | ResourceGroups CreateGroup action. |
QtAws::ResourceGroups::ResourceGroupsRequest::DeleteGroupAction | 1 | ResourceGroups DeleteGroup action. |
QtAws::ResourceGroups::ResourceGroupsRequest::GetGroupAction | 2 | ResourceGroups GetGroup action. |
QtAws::ResourceGroups::ResourceGroupsRequest::GetGroupQueryAction | 3 | ResourceGroups GetGroupQuery action. |
QtAws::ResourceGroups::ResourceGroupsRequest::GetTagsAction | 4 | ResourceGroups GetTags action. |
QtAws::ResourceGroups::ResourceGroupsRequest::ListGroupResourcesAction | 5 | ResourceGroups ListGroupResources action. |
QtAws::ResourceGroups::ResourceGroupsRequest::ListGroupsAction | 6 | ResourceGroups ListGroups action. |
QtAws::ResourceGroups::ResourceGroupsRequest::SearchResourcesAction | 7 | ResourceGroups SearchResources action. |
QtAws::ResourceGroups::ResourceGroupsRequest::TagAction | 8 | ResourceGroups Tag action. |
QtAws::ResourceGroups::ResourceGroupsRequest::UntagAction | 9 | ResourceGroups Untag action. |
QtAws::ResourceGroups::ResourceGroupsRequest::UpdateGroupAction | 10 | ResourceGroups UpdateGroup action. |
QtAws::ResourceGroups::ResourceGroupsRequest::UpdateGroupQueryAction | 11 | ResourceGroups UpdateGroupQuery action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
ResourceGroupsRequest::ResourceGroupsRequest(const Action action)
Constructs a ResourceGroupsRequest object for ResourceGroups action.
ResourceGroupsRequest::ResourceGroupsRequest(const ResourceGroupsRequest &other)
Constructs a copy of other.
[protected] ResourceGroupsRequest::ResourceGroupsRequest(ResourceGroupsRequestPrivate * const d)
Constructs aa ResourceGroupsRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from ResourceGroupsRequestPrivate.
Action ResourceGroupsRequest::action() const
Returns the ResourceGroups action to be performed by this request.
See also setAction().
QString ResourceGroupsRequest::actionString() const
Returns the name of the ResourceGroups action to be performed by this request.
QString ResourceGroupsRequest::apiVersion() const
Returns the ResourceGroups API version implemented by this request.
See also setApiVersion().
[protected] int ResourceGroupsRequest::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 ResourceGroupsRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant ResourceGroupsRequest::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 &ResourceGroupsRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void ResourceGroupsRequest::setAction(const Action action)
Sets the ResourceGroups action to be performed by this request to action.
See also action().
void ResourceGroupsRequest::setApiVersion(const QString &version)
Sets the ResourceGroups API version to include in this request to version.
See also apiVersion().
[protected] void ResourceGroupsRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void ResourceGroupsRequest::setParameters(const QVariantMap ¶meters)
Sets the paramters for this request to parameters. Any request parameters set previously will be discarded.
See also parameters().
[override virtual protected] QNetworkRequest ResourceGroupsRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the ResourceGroups request using the given endpoint.
This ResourceGroups 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.
ResourceGroupsRequest &ResourceGroupsRequest::operator=(const ResourceGroupsRequest &other)
Sets the ResourceGroupsRequest object to be equal to other.
[virtual] bool ResourceGroupsRequest::operator==(const ResourceGroupsRequest &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.