OpsWorksCMRequest Class

Member Function Documentation

OpsWorksCMRequest::OpsWorksCMRequest(const Action action)

Constructs a OpsWorksCMRequest object for OpsWorksCM action.

OpsWorksCMRequest::OpsWorksCMRequest(const OpsWorksCMRequest &other)

Constructs a copy of other.

[protected] OpsWorksCMRequest::OpsWorksCMRequest(OpsWorksCMRequestPrivate * const d)

Constructs aa OpsWorksCMRequest object with private implementation d.

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

Action OpsWorksCMRequest::action() const

Returns the OpsWorksCM action to be performed by this request.

See also setAction().

QString OpsWorksCMRequest::actionString() const

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

QString OpsWorksCMRequest::apiVersion() const

Returns the OpsWorksCM API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void OpsWorksCMRequest::setAction(const Action action)

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

See also action().

void OpsWorksCMRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the OpsWorksCMRequest object to be equal to other.

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