SimpleDBRequest Class

(QtAws::SimpleDB::SimpleDBRequest)

The SimpleDBRequest class provides an interface for SimpleDB requests. More...

Header:	#include <SimpleDBRequest>
Inherits:	QtAws::Core::AwsAbstractRequest
Inherited By:	QtAws::SimpleDB::BatchDeleteAttributesRequest, QtAws::SimpleDB::BatchPutAttributesRequest, QtAws::SimpleDB::CreateDomainRequest, QtAws::SimpleDB::DeleteAttributesRequest, QtAws::SimpleDB::DeleteDomainRequest, QtAws::SimpleDB::DomainMetadataRequest, QtAws::SimpleDB::GetAttributesRequest, QtAws::SimpleDB::ListDomainsRequest, QtAws::SimpleDB::PutAttributesRequest, and QtAws::SimpleDB::SelectRequest

List of all members, including inherited members

Public Types

enum	Action { BatchDeleteAttributesAction, BatchPutAttributesAction, CreateDomainAction, DeleteAttributesAction, ..., SelectAction }
flags	Actions

Public Functions

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

7 public functions inherited from QtAws::Core::AwsAbstractRequest

Protected Functions

	SimpleDBRequest(SimpleDBRequestPrivate * 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

4 protected functions inherited from QtAws::Core::AwsAbstractRequest

Detailed Description

The SimpleDBRequest class provides an interface for SimpleDB requests.

Member Type Documentation

enum SimpleDBRequest::Action
flags SimpleDBRequest::Actions

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

Constant	Value	Description
`QtAws::SimpleDB::SimpleDBRequest::BatchDeleteAttributesAction`	`0`	SimpleDB BatchDeleteAttributes action.
`QtAws::SimpleDB::SimpleDBRequest::BatchPutAttributesAction`	`1`	SimpleDB BatchPutAttributes action.
`QtAws::SimpleDB::SimpleDBRequest::CreateDomainAction`	`2`	SimpleDB CreateDomain action.
`QtAws::SimpleDB::SimpleDBRequest::DeleteAttributesAction`	`3`	SimpleDB DeleteAttributes action.
`QtAws::SimpleDB::SimpleDBRequest::DeleteDomainAction`	`4`	SimpleDB DeleteDomain action.
`QtAws::SimpleDB::SimpleDBRequest::DomainMetadataAction`	`5`	SimpleDB DomainMetadata action.
`QtAws::SimpleDB::SimpleDBRequest::GetAttributesAction`	`6`	SimpleDB GetAttributes action.
`QtAws::SimpleDB::SimpleDBRequest::ListDomainsAction`	`7`	SimpleDB ListDomains action.
`QtAws::SimpleDB::SimpleDBRequest::PutAttributesAction`	`8`	SimpleDB PutAttributes action.
`QtAws::SimpleDB::SimpleDBRequest::SelectAction`	`9`	SimpleDB Select action.

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

Member Function Documentation

SimpleDBRequest::SimpleDBRequest(const Action action)

Constructs a SimpleDBRequest object for SimpleDB action.

SimpleDBRequest::SimpleDBRequest(const SimpleDBRequest &other)

Constructs a copy of other.

`[protected]` SimpleDBRequest::SimpleDBRequest(SimpleDBRequestPrivate * const d)

Constructs aa SimpleDBRequest object with private implementation d.

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

Action SimpleDBRequest::action() const

Returns the SimpleDB action to be performed by this request.

See also setAction().

QString SimpleDBRequest::actionString() const

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

QString SimpleDBRequest::apiVersion() const

Returns the SimpleDB API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void SimpleDBRequest::setAction(const Action action)

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

See also action().

void SimpleDBRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the SimpleDBRequest object to be equal to other.

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

Contents