KinesisRequest Class

Member Function Documentation

KinesisRequest::KinesisRequest(const Action action)

Constructs a KinesisRequest object for Kinesis action.

KinesisRequest::KinesisRequest(const KinesisRequest &other)

Constructs a copy of other.

[protected] KinesisRequest::KinesisRequest(KinesisRequestPrivate * const d)

Constructs aa KinesisRequest object with private implementation d.

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

Action KinesisRequest::action() const

Returns the Kinesis action to be performed by this request.

See also setAction().

QString KinesisRequest::actionString() const

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

QString KinesisRequest::apiVersion() const

Returns the Kinesis API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void KinesisRequest::setAction(const Action action)

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

See also action().

void KinesisRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the KinesisRequest object to be equal to other.

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