DynamoDBStreamsRequest Class

(QtAws::DynamoDBStreams::DynamoDBStreamsRequest)

The DynamoDBStreamsRequest class provides an interface for DynamoDBStreams requests. More...

Public Types

enum Action { DescribeStreamAction, GetRecordsAction, GetShardIteratorAction, ListStreamsAction }
flags Actions

Public Functions

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

Protected Functions

DynamoDBStreamsRequest(DynamoDBStreamsRequestPrivate * 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 DynamoDBStreamsRequest class provides an interface for DynamoDBStreams requests.

Member Type Documentation

enum DynamoDBStreamsRequest::Action
flags DynamoDBStreamsRequest::Actions

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

ConstantValueDescription
QtAws::DynamoDBStreams::DynamoDBStreamsRequest::DescribeStreamAction0DynamoDBStreams DescribeStream action.
QtAws::DynamoDBStreams::DynamoDBStreamsRequest::GetRecordsAction1DynamoDBStreams GetRecords action.
QtAws::DynamoDBStreams::DynamoDBStreamsRequest::GetShardIteratorAction2DynamoDBStreams GetShardIterator action.
QtAws::DynamoDBStreams::DynamoDBStreamsRequest::ListStreamsAction3DynamoDBStreams ListStreams action.

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

Member Function Documentation

DynamoDBStreamsRequest::DynamoDBStreamsRequest(const Action action)

Constructs a DynamoDBStreamsRequest object for DynamoDBStreams action.

DynamoDBStreamsRequest::DynamoDBStreamsRequest(const DynamoDBStreamsRequest &other)

Constructs a copy of other.

[protected] DynamoDBStreamsRequest::DynamoDBStreamsRequest(DynamoDBStreamsRequestPrivate * const d)

Constructs aa DynamoDBStreamsRequest object with private implementation d.

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

Action DynamoDBStreamsRequest::action() const

Returns the DynamoDBStreams action to be performed by this request.

See also setAction().

QString DynamoDBStreamsRequest::actionString() const

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

QString DynamoDBStreamsRequest::apiVersion() const

Returns the DynamoDBStreams API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void DynamoDBStreamsRequest::setAction(const Action action)

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

See also action().

void DynamoDBStreamsRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the DynamoDBStreamsRequest object to be equal to other.

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