CloudSearchDomainRequest Class

(QtAws::CloudSearchDomain::CloudSearchDomainRequest)

The CloudSearchDomainRequest class provides an interface for CloudSearchDomain requests. More...

Public Types

enum Action { SearchAction, SuggestAction, UploadDocumentsAction }
flags Actions

Public Functions

CloudSearchDomainRequest(const Action action)
CloudSearchDomainRequest(const CloudSearchDomainRequest &other)
Action action() const
QString actionString() const
QString apiVersion() const
void setAction(const Action action)
void setApiVersion(const QString &version)
CloudSearchDomainRequest &operator=(const CloudSearchDomainRequest &other)
virtual bool operator==(const CloudSearchDomainRequest &other) const

Protected Functions

CloudSearchDomainRequest(CloudSearchDomainRequestPrivate * const d)
int clearParameter(const QString &name)
void clearParameters()
QVariant parameter(const QString &name, const QVariant &defaultValue = QVariant()) const
const QVariantMap &parameters() const
void setParameter(const QString &name, const QVariant &value)
void setParameters(const QVariantMap &parameters)

Reimplemented Protected Functions

virtual QNetworkRequest unsignedRequest(const QUrl &endpoint) const override

Detailed Description

The CloudSearchDomainRequest class provides an interface for CloudSearchDomain requests.

Member Type Documentation

enum CloudSearchDomainRequest::Action
flags CloudSearchDomainRequest::Actions

This enum describes the actions that can be performed as CloudSearchDomain requests.

ConstantValueDescription
QtAws::CloudSearchDomain::CloudSearchDomainRequest::SearchAction0CloudSearchDomain Search action.
QtAws::CloudSearchDomain::CloudSearchDomainRequest::SuggestAction1CloudSearchDomain Suggest action.
QtAws::CloudSearchDomain::CloudSearchDomainRequest::UploadDocumentsAction2CloudSearchDomain UploadDocuments action.

The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.

Member Function Documentation

CloudSearchDomainRequest::CloudSearchDomainRequest(const Action action)

Constructs a CloudSearchDomainRequest object for CloudSearchDomain action.

CloudSearchDomainRequest::CloudSearchDomainRequest(const CloudSearchDomainRequest &other)

Constructs a copy of other.

[protected] CloudSearchDomainRequest::CloudSearchDomainRequest(CloudSearchDomainRequestPrivate * const d)

Constructs aa CloudSearchDomainRequest object with private implementation d.

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

Action CloudSearchDomainRequest::action() const

Returns the CloudSearchDomain action to be performed by this request.

See also setAction().

QString CloudSearchDomainRequest::actionString() const

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

QString CloudSearchDomainRequest::apiVersion() const

Returns the CloudSearchDomain API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void CloudSearchDomainRequest::setAction(const Action action)

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

See also action().

void CloudSearchDomainRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the CloudSearchDomainRequest object to be equal to other.

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

© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.