LightsailRequest Class

Member Function Documentation

LightsailRequest::LightsailRequest(const Action action)

Constructs a LightsailRequest object for Lightsail action.

LightsailRequest::LightsailRequest(const LightsailRequest &other)

Constructs a copy of other.

[protected] LightsailRequest::LightsailRequest(LightsailRequestPrivate * const d)

Constructs aa LightsailRequest object with private implementation d.

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

Action LightsailRequest::action() const

Returns the Lightsail action to be performed by this request.

See also setAction().

QString LightsailRequest::actionString() const

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

QString LightsailRequest::apiVersion() const

Returns the Lightsail API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void LightsailRequest::setAction(const Action action)

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

See also action().

void LightsailRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the LightsailRequest object to be equal to other.

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