InspectorRequest Class

Member Function Documentation

InspectorRequest::InspectorRequest(const Action action)

Constructs a InspectorRequest object for Inspector action.

InspectorRequest::InspectorRequest(const InspectorRequest &other)

Constructs a copy of other.

[protected] InspectorRequest::InspectorRequest(InspectorRequestPrivate * const d)

Constructs aa InspectorRequest object with private implementation d.

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

Action InspectorRequest::action() const

Returns the Inspector action to be performed by this request.

See also setAction().

QString InspectorRequest::actionString() const

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

QString InspectorRequest::apiVersion() const

Returns the Inspector API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void InspectorRequest::setAction(const Action action)

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

See also action().

void InspectorRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the InspectorRequest object to be equal to other.

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