IoTJobsDataPlaneRequest Class

Member Function Documentation

IoTJobsDataPlaneRequest::IoTJobsDataPlaneRequest(const Action action)

Constructs a IoTJobsDataPlaneRequest object for IoTJobsDataPlane action.

IoTJobsDataPlaneRequest::IoTJobsDataPlaneRequest(const IoTJobsDataPlaneRequest &other)

Constructs a copy of other.

[protected] IoTJobsDataPlaneRequest::IoTJobsDataPlaneRequest(IoTJobsDataPlaneRequestPrivate * const d)

Constructs aa IoTJobsDataPlaneRequest object with private implementation d.

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

Action IoTJobsDataPlaneRequest::action() const

Returns the IoTJobsDataPlane action to be performed by this request.

See also setAction().

QString IoTJobsDataPlaneRequest::actionString() const

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

QString IoTJobsDataPlaneRequest::apiVersion() const

Returns the IoTJobsDataPlane API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void IoTJobsDataPlaneRequest::setAction(const Action action)

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

See also action().

void IoTJobsDataPlaneRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the IoTJobsDataPlaneRequest object to be equal to other.

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