CloudFormationRequest Class

Member Function Documentation

CloudFormationRequest::CloudFormationRequest(const Action action)

Constructs a CloudFormationRequest object for CloudFormation action.

CloudFormationRequest::CloudFormationRequest(const CloudFormationRequest &other)

Constructs a copy of other.

[protected] CloudFormationRequest::CloudFormationRequest(CloudFormationRequestPrivate * const d)

Constructs aa CloudFormationRequest object with private implementation d.

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

Action CloudFormationRequest::action() const

Returns the CloudFormation action to be performed by this request.

See also setAction().

QString CloudFormationRequest::actionString() const

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

QString CloudFormationRequest::apiVersion() const

Returns the CloudFormation API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void CloudFormationRequest::setAction(const Action action)

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

See also action().

void CloudFormationRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the CloudFormationRequest object to be equal to other.

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