EcsRequest Class

Member Function Documentation

EcsRequest::EcsRequest(const Action action)

Constructs a EcsRequest object for ECS action.

EcsRequest::EcsRequest(const EcsRequest &other)

Constructs a copy of other.

[protected] EcsRequest::EcsRequest(EcsRequestPrivate * const d)

Constructs aa EcsRequest object with private implementation d.

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

Action EcsRequest::action() const

Returns the ECS action to be performed by this request.

See also setAction().

QString EcsRequest::actionString() const

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

QString EcsRequest::apiVersion() const

Returns the ECS API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void EcsRequest::setAction(const Action action)

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

See also action().

void EcsRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the EcsRequest object to be equal to other.

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