WafRequest Class

Member Function Documentation

WafRequest::WafRequest(const Action action)

Constructs a WafRequest object for WAF action.

WafRequest::WafRequest(const WafRequest &other)

Constructs a copy of other.

[protected] WafRequest::WafRequest(WafRequestPrivate * const d)

Constructs aa WafRequest object with private implementation d.

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

Action WafRequest::action() const

Returns the WAF action to be performed by this request.

See also setAction().

QString WafRequest::actionString() const

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

QString WafRequest::apiVersion() const

Returns the WAF API version implemented by this request.

See also setApiVersion().

[protected] int WafRequest::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 WafRequest::clearParameters()

Removes all parameters from the request.

[protected] QVariant WafRequest::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 &WafRequest::parameters() const

Returns the parameters included in this request.

See also setParameters().

void WafRequest::setAction(const Action action)

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

See also action().

void WafRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

[protected] void WafRequest::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 WafRequest::unsignedRequest(const QUrl &endpoint) const

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

This WAF 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.

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

Sets the WafRequest object to be equal to other.

[virtual] bool WafRequest::operator==(const WafRequest &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.