IamRequest Class

Member Function Documentation

IamRequest::IamRequest(const Action action)

Constructs a IamRequest object for IAM action.

IamRequest::IamRequest(const IamRequest &other)

Constructs a copy of other.

[protected] IamRequest::IamRequest(IamRequestPrivate * const d)

Constructs aa IamRequest object with private implementation d.

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

Action IamRequest::action() const

Returns the IAM action to be performed by this request.

See also setAction().

QString IamRequest::actionString() const

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

QString IamRequest::apiVersion() const

Returns the IAM API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void IamRequest::setAction(const Action action)

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

See also action().

void IamRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the IamRequest object to be equal to other.

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