ConfigServiceRequest Class

Member Function Documentation

ConfigServiceRequest::ConfigServiceRequest(const Action action)

Constructs a ConfigServiceRequest object for ConfigService action.

ConfigServiceRequest::ConfigServiceRequest(const ConfigServiceRequest &other)

Constructs a copy of other.

[protected] ConfigServiceRequest::ConfigServiceRequest(ConfigServiceRequestPrivate * const d)

Constructs aa ConfigServiceRequest object with private implementation d.

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

Action ConfigServiceRequest::action() const

Returns the ConfigService action to be performed by this request.

See also setAction().

QString ConfigServiceRequest::actionString() const

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

QString ConfigServiceRequest::apiVersion() const

Returns the ConfigService API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void ConfigServiceRequest::setAction(const Action action)

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

See also action().

void ConfigServiceRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the ConfigServiceRequest object to be equal to other.

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