CloudSearchRequest Class

Member Function Documentation

CloudSearchRequest::CloudSearchRequest(const Action action)

Constructs a CloudSearchRequest object for CloudSearch action.

CloudSearchRequest::CloudSearchRequest(const CloudSearchRequest &other)

Constructs a copy of other.

[protected] CloudSearchRequest::CloudSearchRequest(CloudSearchRequestPrivate * const d)

Constructs aa CloudSearchRequest object with private implementation d.

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

Action CloudSearchRequest::action() const

Returns the CloudSearch action to be performed by this request.

See also setAction().

QString CloudSearchRequest::actionString() const

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

QString CloudSearchRequest::apiVersion() const

Returns the CloudSearch API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void CloudSearchRequest::setAction(const Action action)

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

See also action().

void CloudSearchRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the CloudSearchRequest object to be equal to other.

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