AthenaRequest Class

Member Function Documentation

AthenaRequest::AthenaRequest(const Action action)

Constructs a AthenaRequest object for Athena action.

AthenaRequest::AthenaRequest(const AthenaRequest &other)

Constructs a copy of other.

[protected] AthenaRequest::AthenaRequest(AthenaRequestPrivate * const d)

Constructs aa AthenaRequest object with private implementation d.

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

Action AthenaRequest::action() const

Returns the Athena action to be performed by this request.

See also setAction().

QString AthenaRequest::actionString() const

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

QString AthenaRequest::apiVersion() const

Returns the Athena API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void AthenaRequest::setAction(const Action action)

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

See also action().

void AthenaRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the AthenaRequest object to be equal to other.

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