CloudTrailRequest Class
(QtAws::CloudTrail::CloudTrailRequest)The CloudTrailRequest class provides an interface for CloudTrail requests. More...
Public Types
| enum | Action { AddTagsAction, CreateTrailAction, DeleteTrailAction, DescribeTrailsAction, ..., UpdateTrailAction } |
| flags | Actions |
Public Functions
| CloudTrailRequest(const Action action) | |
| CloudTrailRequest(const CloudTrailRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| CloudTrailRequest & | operator=(const CloudTrailRequest &other) |
| virtual bool | operator==(const CloudTrailRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| CloudTrailRequest(CloudTrailRequestPrivate * 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 CloudTrailRequest class provides an interface for CloudTrail requests.
Member Type Documentation
enum CloudTrailRequest::Action
flags CloudTrailRequest::Actions
This enum describes the actions that can be performed as CloudTrail requests.
| Constant | Value | Description |
|---|---|---|
QtAws::CloudTrail::CloudTrailRequest::AddTagsAction | 0 | CloudTrail AddTags action. |
QtAws::CloudTrail::CloudTrailRequest::CreateTrailAction | 1 | CloudTrail CreateTrail action. |
QtAws::CloudTrail::CloudTrailRequest::DeleteTrailAction | 2 | CloudTrail DeleteTrail action. |
QtAws::CloudTrail::CloudTrailRequest::DescribeTrailsAction | 3 | CloudTrail DescribeTrails action. |
QtAws::CloudTrail::CloudTrailRequest::GetEventSelectorsAction | 4 | CloudTrail GetEventSelectors action. |
QtAws::CloudTrail::CloudTrailRequest::GetTrailStatusAction | 5 | CloudTrail GetTrailStatus action. |
QtAws::CloudTrail::CloudTrailRequest::ListPublicKeysAction | 6 | CloudTrail ListPublicKeys action. |
QtAws::CloudTrail::CloudTrailRequest::ListTagsAction | 7 | CloudTrail ListTags action. |
QtAws::CloudTrail::CloudTrailRequest::LookupEventsAction | 8 | CloudTrail LookupEvents action. |
QtAws::CloudTrail::CloudTrailRequest::PutEventSelectorsAction | 9 | CloudTrail PutEventSelectors action. |
QtAws::CloudTrail::CloudTrailRequest::RemoveTagsAction | 10 | CloudTrail RemoveTags action. |
QtAws::CloudTrail::CloudTrailRequest::StartLoggingAction | 11 | CloudTrail StartLogging action. |
QtAws::CloudTrail::CloudTrailRequest::StopLoggingAction | 12 | CloudTrail StopLogging action. |
QtAws::CloudTrail::CloudTrailRequest::UpdateTrailAction | 13 | CloudTrail UpdateTrail action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
CloudTrailRequest::CloudTrailRequest(const Action action)
Constructs a CloudTrailRequest object for CloudTrail action.
CloudTrailRequest::CloudTrailRequest(const CloudTrailRequest &other)
Constructs a copy of other.
[protected] CloudTrailRequest::CloudTrailRequest(CloudTrailRequestPrivate * const d)
Constructs aa CloudTrailRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from CloudTrailRequestPrivate.
Action CloudTrailRequest::action() const
Returns the CloudTrail action to be performed by this request.
See also setAction().
QString CloudTrailRequest::actionString() const
Returns the name of the CloudTrail action to be performed by this request.
QString CloudTrailRequest::apiVersion() const
Returns the CloudTrail API version implemented by this request.
See also setApiVersion().
[protected] int CloudTrailRequest::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 CloudTrailRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant CloudTrailRequest::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 &CloudTrailRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void CloudTrailRequest::setAction(const Action action)
Sets the CloudTrail action to be performed by this request to action.
See also action().
void CloudTrailRequest::setApiVersion(const QString &version)
Sets the CloudTrail API version to include in this request to version.
See also apiVersion().
[protected] void CloudTrailRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void CloudTrailRequest::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 CloudTrailRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the CloudTrail request using the given endpoint.
This CloudTrail 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.
CloudTrailRequest &CloudTrailRequest::operator=(const CloudTrailRequest &other)
Sets the CloudTrailRequest object to be equal to other.
[virtual] bool CloudTrailRequest::operator==(const CloudTrailRequest &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.