EcrRequest Class

Member Function Documentation

EcrRequest::EcrRequest(const Action action)

Constructs a EcrRequest object for ECR action.

EcrRequest::EcrRequest(const EcrRequest &other)

Constructs a copy of other.

[protected] EcrRequest::EcrRequest(EcrRequestPrivate * const d)

Constructs aa EcrRequest object with private implementation d.

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

Action EcrRequest::action() const

Returns the ECR action to be performed by this request.

See also setAction().

QString EcrRequest::actionString() const

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

QString EcrRequest::apiVersion() const

Returns the ECR API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void EcrRequest::setAction(const Action action)

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

See also action().

void EcrRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the EcrRequest object to be equal to other.

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