EfsRequest Class

Member Function Documentation

EfsRequest::EfsRequest(const Action action)

Constructs a EfsRequest object for EFS action.

EfsRequest::EfsRequest(const EfsRequest &other)

Constructs a copy of other.

[protected] EfsRequest::EfsRequest(EfsRequestPrivate * const d)

Constructs aa EfsRequest object with private implementation d.

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

Action EfsRequest::action() const

Returns the EFS action to be performed by this request.

See also setAction().

QString EfsRequest::actionString() const

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

QString EfsRequest::apiVersion() const

Returns the EFS API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void EfsRequest::setAction(const Action action)

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

See also action().

void EfsRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the EfsRequest object to be equal to other.

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