OpsWorksRequest Class

Member Function Documentation

OpsWorksRequest::OpsWorksRequest(const Action action)

Constructs a OpsWorksRequest object for OpsWorks action.

OpsWorksRequest::OpsWorksRequest(const OpsWorksRequest &other)

Constructs a copy of other.

[protected] OpsWorksRequest::OpsWorksRequest(OpsWorksRequestPrivate * const d)

Constructs aa OpsWorksRequest object with private implementation d.

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

Action OpsWorksRequest::action() const

Returns the OpsWorks action to be performed by this request.

See also setAction().

QString OpsWorksRequest::actionString() const

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

QString OpsWorksRequest::apiVersion() const

Returns the OpsWorks API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void OpsWorksRequest::setAction(const Action action)

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

See also action().

void OpsWorksRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the OpsWorksRequest object to be equal to other.

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