GreengrassRequest Class

Member Function Documentation

GreengrassRequest::GreengrassRequest(const Action action)

Constructs a GreengrassRequest object for Greengrass action.

GreengrassRequest::GreengrassRequest(const GreengrassRequest &other)

Constructs a copy of other.

[protected] GreengrassRequest::GreengrassRequest(GreengrassRequestPrivate * const d)

Constructs aa GreengrassRequest object with private implementation d.

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

Action GreengrassRequest::action() const

Returns the Greengrass action to be performed by this request.

See also setAction().

QString GreengrassRequest::actionString() const

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

QString GreengrassRequest::apiVersion() const

Returns the Greengrass API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void GreengrassRequest::setAction(const Action action)

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

See also action().

void GreengrassRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the GreengrassRequest object to be equal to other.

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