IoTDataPlaneRequest Class

Member Function Documentation

IoTDataPlaneRequest::IoTDataPlaneRequest(const Action action)

Constructs a IoTDataPlaneRequest object for IoTDataPlane action.

IoTDataPlaneRequest::IoTDataPlaneRequest(const IoTDataPlaneRequest &other)

Constructs a copy of other.

[protected] IoTDataPlaneRequest::IoTDataPlaneRequest(IoTDataPlaneRequestPrivate * const d)

Constructs aa IoTDataPlaneRequest object with private implementation d.

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

Action IoTDataPlaneRequest::action() const

Returns the IoTDataPlane action to be performed by this request.

See also setAction().

QString IoTDataPlaneRequest::actionString() const

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

QString IoTDataPlaneRequest::apiVersion() const

Returns the IoTDataPlane API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void IoTDataPlaneRequest::setAction(const Action action)

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

See also action().

void IoTDataPlaneRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the IoTDataPlaneRequest object to be equal to other.

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