SnowballRequest Class

Member Function Documentation

SnowballRequest::SnowballRequest(const Action action)

Constructs a SnowballRequest object for Snowball action.

SnowballRequest::SnowballRequest(const SnowballRequest &other)

Constructs a copy of other.

[protected] SnowballRequest::SnowballRequest(SnowballRequestPrivate * const d)

Constructs aa SnowballRequest object with private implementation d.

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

Action SnowballRequest::action() const

Returns the Snowball action to be performed by this request.

See also setAction().

QString SnowballRequest::actionString() const

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

QString SnowballRequest::apiVersion() const

Returns the Snowball API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void SnowballRequest::setAction(const Action action)

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

See also action().

void SnowballRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the SnowballRequest object to be equal to other.

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