ComprehendRequest Class

Member Function Documentation

ComprehendRequest::ComprehendRequest(const Action action)

Constructs a ComprehendRequest object for Comprehend action.

ComprehendRequest::ComprehendRequest(const ComprehendRequest &other)

Constructs a copy of other.

[protected] ComprehendRequest::ComprehendRequest(ComprehendRequestPrivate * const d)

Constructs aa ComprehendRequest object with private implementation d.

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

Action ComprehendRequest::action() const

Returns the Comprehend action to be performed by this request.

See also setAction().

QString ComprehendRequest::actionString() const

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

QString ComprehendRequest::apiVersion() const

Returns the Comprehend API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void ComprehendRequest::setAction(const Action action)

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

See also action().

void ComprehendRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the ComprehendRequest object to be equal to other.

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