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

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 &parameters)

Reimplemented Protected Functions

virtual QNetworkRequest unsignedRequest(const QUrl &endpoint) const override

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.

ConstantValueDescription
QtAws::DynamoDB::DynamoDBRequest::BatchGetItemAction0DynamoDB BatchGetItem action.
QtAws::DynamoDB::DynamoDBRequest::BatchWriteItemAction1DynamoDB BatchWriteItem action.
QtAws::DynamoDB::DynamoDBRequest::CreateBackupAction2DynamoDB CreateBackup action.
QtAws::DynamoDB::DynamoDBRequest::CreateGlobalTableAction3DynamoDB CreateGlobalTable action.
QtAws::DynamoDB::DynamoDBRequest::CreateTableAction4DynamoDB CreateTable action.
QtAws::DynamoDB::DynamoDBRequest::DeleteBackupAction5DynamoDB DeleteBackup action.
QtAws::DynamoDB::DynamoDBRequest::DeleteItemAction6DynamoDB DeleteItem action.
QtAws::DynamoDB::DynamoDBRequest::DeleteTableAction7DynamoDB DeleteTable action.
QtAws::DynamoDB::DynamoDBRequest::DescribeBackupAction8DynamoDB DescribeBackup action.
QtAws::DynamoDB::DynamoDBRequest::DescribeContinuousBackupsAction9DynamoDB DescribeContinuousBackups action.
QtAws::DynamoDB::DynamoDBRequest::DescribeGlobalTableAction10DynamoDB DescribeGlobalTable action.
QtAws::DynamoDB::DynamoDBRequest::DescribeGlobalTableSettingsAction11DynamoDB DescribeGlobalTableSettings action.
QtAws::DynamoDB::DynamoDBRequest::DescribeLimitsAction12DynamoDB DescribeLimits action.
QtAws::DynamoDB::DynamoDBRequest::DescribeTableAction13DynamoDB DescribeTable action.
QtAws::DynamoDB::DynamoDBRequest::DescribeTimeToLiveAction14DynamoDB DescribeTimeToLive action.
QtAws::DynamoDB::DynamoDBRequest::GetItemAction15DynamoDB GetItem action.
QtAws::DynamoDB::DynamoDBRequest::ListBackupsAction16DynamoDB ListBackups action.
QtAws::DynamoDB::DynamoDBRequest::ListGlobalTablesAction17DynamoDB ListGlobalTables action.
QtAws::DynamoDB::DynamoDBRequest::ListTablesAction18DynamoDB ListTables action.
QtAws::DynamoDB::DynamoDBRequest::ListTagsOfResourceAction19DynamoDB ListTagsOfResource action.
QtAws::DynamoDB::DynamoDBRequest::PutItemAction20DynamoDB PutItem action.
QtAws::DynamoDB::DynamoDBRequest::QueryAction21DynamoDB Query action.
QtAws::DynamoDB::DynamoDBRequest::RestoreTableFromBackupAction22DynamoDB RestoreTableFromBackup action.
QtAws::DynamoDB::DynamoDBRequest::RestoreTableToPointInTimeAction23DynamoDB RestoreTableToPointInTime action.
QtAws::DynamoDB::DynamoDBRequest::ScanAction24DynamoDB Scan action.
QtAws::DynamoDB::DynamoDBRequest::TagResourceAction25DynamoDB TagResource action.
QtAws::DynamoDB::DynamoDBRequest::UntagResourceAction26DynamoDB UntagResource action.
QtAws::DynamoDB::DynamoDBRequest::UpdateContinuousBackupsAction27DynamoDB UpdateContinuousBackups action.
QtAws::DynamoDB::DynamoDBRequest::UpdateGlobalTableAction28DynamoDB UpdateGlobalTable action.
QtAws::DynamoDB::DynamoDBRequest::UpdateGlobalTableSettingsAction29DynamoDB UpdateGlobalTableSettings action.
QtAws::DynamoDB::DynamoDBRequest::UpdateItemAction30DynamoDB UpdateItem action.
QtAws::DynamoDB::DynamoDBRequest::UpdateTableAction31DynamoDB UpdateTable action.
QtAws::DynamoDB::DynamoDBRequest::UpdateTimeToLiveAction32DynamoDB 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 &parameters)

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.