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

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 &parameters)

Reimplemented Protected Functions

virtual QNetworkRequest unsignedRequest(const QUrl &endpoint) const override

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.

ConstantValueDescription
QtAws::CloudTrail::CloudTrailRequest::AddTagsAction0CloudTrail AddTags action.
QtAws::CloudTrail::CloudTrailRequest::CreateTrailAction1CloudTrail CreateTrail action.
QtAws::CloudTrail::CloudTrailRequest::DeleteTrailAction2CloudTrail DeleteTrail action.
QtAws::CloudTrail::CloudTrailRequest::DescribeTrailsAction3CloudTrail DescribeTrails action.
QtAws::CloudTrail::CloudTrailRequest::GetEventSelectorsAction4CloudTrail GetEventSelectors action.
QtAws::CloudTrail::CloudTrailRequest::GetTrailStatusAction5CloudTrail GetTrailStatus action.
QtAws::CloudTrail::CloudTrailRequest::ListPublicKeysAction6CloudTrail ListPublicKeys action.
QtAws::CloudTrail::CloudTrailRequest::ListTagsAction7CloudTrail ListTags action.
QtAws::CloudTrail::CloudTrailRequest::LookupEventsAction8CloudTrail LookupEvents action.
QtAws::CloudTrail::CloudTrailRequest::PutEventSelectorsAction9CloudTrail PutEventSelectors action.
QtAws::CloudTrail::CloudTrailRequest::RemoveTagsAction10CloudTrail RemoveTags action.
QtAws::CloudTrail::CloudTrailRequest::StartLoggingAction11CloudTrail StartLogging action.
QtAws::CloudTrail::CloudTrailRequest::StopLoggingAction12CloudTrail StopLogging action.
QtAws::CloudTrail::CloudTrailRequest::UpdateTrailAction13CloudTrail 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 &parameters)

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.