ShieldRequest Class
(QtAws::Shield::ShieldRequest)The ShieldRequest class provides an interface for Shield requests. More...
Public Types
| enum | Action { CreateProtectionAction, CreateSubscriptionAction, DeleteProtectionAction, DeleteSubscriptionAction, ..., ListProtectionsAction } |
| flags | Actions |
Public Functions
| ShieldRequest(const Action action) | |
| ShieldRequest(const ShieldRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| ShieldRequest & | operator=(const ShieldRequest &other) |
| virtual bool | operator==(const ShieldRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| ShieldRequest(ShieldRequestPrivate * 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 ShieldRequest class provides an interface for Shield requests.
Member Type Documentation
enum ShieldRequest::Action
flags ShieldRequest::Actions
This enum describes the actions that can be performed as Shield requests.
| Constant | Value | Description |
|---|---|---|
QtAws::Shield::ShieldRequest::CreateProtectionAction | 0 | Shield CreateProtection action. |
QtAws::Shield::ShieldRequest::CreateSubscriptionAction | 1 | Shield CreateSubscription action. |
QtAws::Shield::ShieldRequest::DeleteProtectionAction | 2 | Shield DeleteProtection action. |
QtAws::Shield::ShieldRequest::DeleteSubscriptionAction | 3 | Shield DeleteSubscription action. |
QtAws::Shield::ShieldRequest::DescribeAttackAction | 4 | Shield DescribeAttack action. |
QtAws::Shield::ShieldRequest::DescribeProtectionAction | 5 | Shield DescribeProtection action. |
QtAws::Shield::ShieldRequest::DescribeSubscriptionAction | 6 | Shield DescribeSubscription action. |
QtAws::Shield::ShieldRequest::GetSubscriptionStateAction | 7 | Shield GetSubscriptionState action. |
QtAws::Shield::ShieldRequest::ListAttacksAction | 8 | Shield ListAttacks action. |
QtAws::Shield::ShieldRequest::ListProtectionsAction | 9 | Shield ListProtections action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
ShieldRequest::ShieldRequest(const Action action)
Constructs a ShieldRequest object for Shield action.
ShieldRequest::ShieldRequest(const ShieldRequest &other)
Constructs a copy of other.
[protected] ShieldRequest::ShieldRequest(ShieldRequestPrivate * const d)
Constructs aa ShieldRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from ShieldRequestPrivate.
Action ShieldRequest::action() const
Returns the Shield action to be performed by this request.
See also setAction().
QString ShieldRequest::actionString() const
Returns the name of the Shield action to be performed by this request.
QString ShieldRequest::apiVersion() const
Returns the Shield API version implemented by this request.
See also setApiVersion().
[protected] int ShieldRequest::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 ShieldRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant ShieldRequest::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 &ShieldRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void ShieldRequest::setAction(const Action action)
Sets the Shield action to be performed by this request to action.
See also action().
void ShieldRequest::setApiVersion(const QString &version)
Sets the Shield API version to include in this request to version.
See also apiVersion().
[protected] void ShieldRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void ShieldRequest::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 ShieldRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the Shield request using the given endpoint.
This Shield 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.
ShieldRequest &ShieldRequest::operator=(const ShieldRequest &other)
Sets the ShieldRequest object to be equal to other.
[virtual] bool ShieldRequest::operator==(const ShieldRequest &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.