ElastiCacheRequest Class

Member Function Documentation

ElastiCacheRequest::ElastiCacheRequest(const Action action)

Constructs a ElastiCacheRequest object for ElastiCache action.

ElastiCacheRequest::ElastiCacheRequest(const ElastiCacheRequest &other)

Constructs a copy of other.

[protected] ElastiCacheRequest::ElastiCacheRequest(ElastiCacheRequestPrivate * const d)

Constructs aa ElastiCacheRequest object with private implementation d.

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

Action ElastiCacheRequest::action() const

Returns the ElastiCache action to be performed by this request.

See also setAction().

QString ElastiCacheRequest::actionString() const

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

QString ElastiCacheRequest::apiVersion() const

Returns the ElastiCache API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void ElastiCacheRequest::setAction(const Action action)

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

See also action().

void ElastiCacheRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the ElastiCacheRequest object to be equal to other.

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