WAFRegionalRequest Class

Member Function Documentation

WAFRegionalRequest::WAFRegionalRequest(const Action action)

Constructs a WAFRegionalRequest object for WAFRegional action.

WAFRegionalRequest::WAFRegionalRequest(const WAFRegionalRequest &other)

Constructs a copy of other.

[protected] WAFRegionalRequest::WAFRegionalRequest(WAFRegionalRequestPrivate * const d)

Constructs aa WAFRegionalRequest object with private implementation d.

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

Action WAFRegionalRequest::action() const

Returns the WAFRegional action to be performed by this request.

See also setAction().

QString WAFRegionalRequest::actionString() const

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

QString WAFRegionalRequest::apiVersion() const

Returns the WAFRegional API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void WAFRegionalRequest::setAction(const Action action)

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

See also action().

void WAFRegionalRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the WAFRegionalRequest object to be equal to other.

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