DynamoDBRequest Class
(QtAws::DynamoDB::DynamoDBRequest)The DynamoDBRequest class provides an interface for DynamoDB requests. More...
Public Types
| enum | Action { BatchGetItemAction, BatchWriteItemAction, CreateBackupAction, CreateGlobalTableAction, ..., UpdateTimeToLiveAction } |
| flags | Actions |
Public Functions
| DynamoDBRequest(const Action action) | |
| DynamoDBRequest(const DynamoDBRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| DynamoDBRequest & | operator=(const DynamoDBRequest &other) |
| virtual bool | operator==(const DynamoDBRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| DynamoDBRequest(DynamoDBRequestPrivate * 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 ¶meters) |
Reimplemented Protected Functions
| virtual QNetworkRequest | unsignedRequest(const QUrl &endpoint) const override |
- 4 protected functions inherited from QtAws::Core::AwsAbstractRequest
Detailed Description
The DynamoDBRequest class provides an interface for DynamoDB requests.
Member Type Documentation
enum DynamoDBRequest::Action
flags DynamoDBRequest::Actions
This enum describes the actions that can be performed as DynamoDB requests.
| Constant | Value | Description |
|---|---|---|
QtAws::DynamoDB::DynamoDBRequest::BatchGetItemAction | 0 | DynamoDB BatchGetItem action. |
QtAws::DynamoDB::DynamoDBRequest::BatchWriteItemAction | 1 | DynamoDB BatchWriteItem action. |
QtAws::DynamoDB::DynamoDBRequest::CreateBackupAction | 2 | DynamoDB CreateBackup action. |
QtAws::DynamoDB::DynamoDBRequest::CreateGlobalTableAction | 3 | DynamoDB CreateGlobalTable action. |
QtAws::DynamoDB::DynamoDBRequest::CreateTableAction | 4 | DynamoDB CreateTable action. |
QtAws::DynamoDB::DynamoDBRequest::DeleteBackupAction | 5 | DynamoDB DeleteBackup action. |
QtAws::DynamoDB::DynamoDBRequest::DeleteItemAction | 6 | DynamoDB DeleteItem action. |
QtAws::DynamoDB::DynamoDBRequest::DeleteTableAction | 7 | DynamoDB DeleteTable action. |
QtAws::DynamoDB::DynamoDBRequest::DescribeBackupAction | 8 | DynamoDB DescribeBackup action. |
QtAws::DynamoDB::DynamoDBRequest::DescribeContinuousBackupsAction | 9 | DynamoDB DescribeContinuousBackups action. |
QtAws::DynamoDB::DynamoDBRequest::DescribeGlobalTableAction | 10 | DynamoDB DescribeGlobalTable action. |
QtAws::DynamoDB::DynamoDBRequest::DescribeGlobalTableSettingsAction | 11 | DynamoDB DescribeGlobalTableSettings action. |
QtAws::DynamoDB::DynamoDBRequest::DescribeLimitsAction | 12 | DynamoDB DescribeLimits action. |
QtAws::DynamoDB::DynamoDBRequest::DescribeTableAction | 13 | DynamoDB DescribeTable action. |
QtAws::DynamoDB::DynamoDBRequest::DescribeTimeToLiveAction | 14 | DynamoDB DescribeTimeToLive action. |
QtAws::DynamoDB::DynamoDBRequest::GetItemAction | 15 | DynamoDB GetItem action. |
QtAws::DynamoDB::DynamoDBRequest::ListBackupsAction | 16 | DynamoDB ListBackups action. |
QtAws::DynamoDB::DynamoDBRequest::ListGlobalTablesAction | 17 | DynamoDB ListGlobalTables action. |
QtAws::DynamoDB::DynamoDBRequest::ListTablesAction | 18 | DynamoDB ListTables action. |
QtAws::DynamoDB::DynamoDBRequest::ListTagsOfResourceAction | 19 | DynamoDB ListTagsOfResource action. |
QtAws::DynamoDB::DynamoDBRequest::PutItemAction | 20 | DynamoDB PutItem action. |
QtAws::DynamoDB::DynamoDBRequest::QueryAction | 21 | DynamoDB Query action. |
QtAws::DynamoDB::DynamoDBRequest::RestoreTableFromBackupAction | 22 | DynamoDB RestoreTableFromBackup action. |
QtAws::DynamoDB::DynamoDBRequest::RestoreTableToPointInTimeAction | 23 | DynamoDB RestoreTableToPointInTime action. |
QtAws::DynamoDB::DynamoDBRequest::ScanAction | 24 | DynamoDB Scan action. |
QtAws::DynamoDB::DynamoDBRequest::TagResourceAction | 25 | DynamoDB TagResource action. |
QtAws::DynamoDB::DynamoDBRequest::UntagResourceAction | 26 | DynamoDB UntagResource action. |
QtAws::DynamoDB::DynamoDBRequest::UpdateContinuousBackupsAction | 27 | DynamoDB UpdateContinuousBackups action. |
QtAws::DynamoDB::DynamoDBRequest::UpdateGlobalTableAction | 28 | DynamoDB UpdateGlobalTable action. |
QtAws::DynamoDB::DynamoDBRequest::UpdateGlobalTableSettingsAction | 29 | DynamoDB UpdateGlobalTableSettings action. |
QtAws::DynamoDB::DynamoDBRequest::UpdateItemAction | 30 | DynamoDB UpdateItem action. |
QtAws::DynamoDB::DynamoDBRequest::UpdateTableAction | 31 | DynamoDB UpdateTable action. |
QtAws::DynamoDB::DynamoDBRequest::UpdateTimeToLiveAction | 32 | DynamoDB UpdateTimeToLive action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
DynamoDBRequest::DynamoDBRequest(const Action action)
Constructs a DynamoDBRequest object for DynamoDB action.
DynamoDBRequest::DynamoDBRequest(const DynamoDBRequest &other)
Constructs a copy of other.
[protected] DynamoDBRequest::DynamoDBRequest(DynamoDBRequestPrivate * const d)
Constructs aa DynamoDBRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from DynamoDBRequestPrivate.
Action DynamoDBRequest::action() const
Returns the DynamoDB action to be performed by this request.
See also setAction().
QString DynamoDBRequest::actionString() const
Returns the name of the DynamoDB action to be performed by this request.
QString DynamoDBRequest::apiVersion() const
Returns the DynamoDB API version implemented by this request.
See also setApiVersion().
[protected] int DynamoDBRequest::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 DynamoDBRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant DynamoDBRequest::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 &DynamoDBRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void DynamoDBRequest::setAction(const Action action)
Sets the DynamoDB action to be performed by this request to action.
See also action().
void DynamoDBRequest::setApiVersion(const QString &version)
Sets the DynamoDB API version to include in this request to version.
See also apiVersion().
[protected] void DynamoDBRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void DynamoDBRequest::setParameters(const QVariantMap ¶meters)
Sets the paramters for this request to parameters. Any request parameters set previously will be discarded.
See also parameters().
[override virtual protected] QNetworkRequest DynamoDBRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the DynamoDB request using the given endpoint.
This DynamoDB 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.
DynamoDBRequest &DynamoDBRequest::operator=(const DynamoDBRequest &other)
Sets the DynamoDBRequest object to be equal to other.
[virtual] bool DynamoDBRequest::operator==(const DynamoDBRequest &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.