KinesisAnalyticsRequest Class

Member Function Documentation

KinesisAnalyticsRequest::KinesisAnalyticsRequest(const Action action)

Constructs a KinesisAnalyticsRequest object for KinesisAnalytics action.

KinesisAnalyticsRequest::KinesisAnalyticsRequest(const KinesisAnalyticsRequest &other)

Constructs a copy of other.

[protected] KinesisAnalyticsRequest::KinesisAnalyticsRequest(KinesisAnalyticsRequestPrivate * const d)

Constructs aa KinesisAnalyticsRequest object with private implementation d.

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

Action KinesisAnalyticsRequest::action() const

Returns the KinesisAnalytics action to be performed by this request.

See also setAction().

QString KinesisAnalyticsRequest::actionString() const

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

QString KinesisAnalyticsRequest::apiVersion() const

Returns the KinesisAnalytics API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void KinesisAnalyticsRequest::setAction(const Action action)

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

See also action().

void KinesisAnalyticsRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the KinesisAnalyticsRequest object to be equal to other.

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