RdsRequest Class

Member Function Documentation

RdsRequest::RdsRequest(const Action action)

Constructs a RdsRequest object for RDS action.

RdsRequest::RdsRequest(const RdsRequest &other)

Constructs a copy of other.

[protected] RdsRequest::RdsRequest(RdsRequestPrivate * const d)

Constructs aa RdsRequest object with private implementation d.

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

Action RdsRequest::action() const

Returns the RDS action to be performed by this request.

See also setAction().

QString RdsRequest::actionString() const

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

QString RdsRequest::apiVersion() const

Returns the RDS API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void RdsRequest::setAction(const Action action)

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

See also action().

void RdsRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the RdsRequest object to be equal to other.

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