GuardDutyRequest Class

Member Function Documentation

GuardDutyRequest::GuardDutyRequest(const Action action)

Constructs a GuardDutyRequest object for GuardDuty action.

GuardDutyRequest::GuardDutyRequest(const GuardDutyRequest &other)

Constructs a copy of other.

[protected] GuardDutyRequest::GuardDutyRequest(GuardDutyRequestPrivate * const d)

Constructs aa GuardDutyRequest object with private implementation d.

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

Action GuardDutyRequest::action() const

Returns the GuardDuty action to be performed by this request.

See also setAction().

QString GuardDutyRequest::actionString() const

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

QString GuardDutyRequest::apiVersion() const

Returns the GuardDuty API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void GuardDutyRequest::setAction(const Action action)

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

See also action().

void GuardDutyRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the GuardDutyRequest object to be equal to other.

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