IoTAnalyticsRequest Class

Member Function Documentation

IoTAnalyticsRequest::IoTAnalyticsRequest(const Action action)

Constructs a IoTAnalyticsRequest object for IoTAnalytics action.

IoTAnalyticsRequest::IoTAnalyticsRequest(const IoTAnalyticsRequest &other)

Constructs a copy of other.

[protected] IoTAnalyticsRequest::IoTAnalyticsRequest(IoTAnalyticsRequestPrivate * const d)

Constructs aa IoTAnalyticsRequest object with private implementation d.

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

Action IoTAnalyticsRequest::action() const

Returns the IoTAnalytics action to be performed by this request.

See also setAction().

QString IoTAnalyticsRequest::actionString() const

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

QString IoTAnalyticsRequest::apiVersion() const

Returns the IoTAnalytics API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void IoTAnalyticsRequest::setAction(const Action action)

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

See also action().

void IoTAnalyticsRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the IoTAnalyticsRequest object to be equal to other.

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