CloudHSMRequest Class

Member Function Documentation

CloudHSMRequest::CloudHSMRequest(const Action action)

Constructs a CloudHSMRequest object for CloudHSM action.

CloudHSMRequest::CloudHSMRequest(const CloudHSMRequest &other)

Constructs a copy of other.

[protected] CloudHSMRequest::CloudHSMRequest(CloudHSMRequestPrivate * const d)

Constructs aa CloudHSMRequest object with private implementation d.

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

Action CloudHSMRequest::action() const

Returns the CloudHSM action to be performed by this request.

See also setAction().

QString CloudHSMRequest::actionString() const

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

QString CloudHSMRequest::apiVersion() const

Returns the CloudHSM API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void CloudHSMRequest::setAction(const Action action)

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

See also action().

void CloudHSMRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the CloudHSMRequest object to be equal to other.

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