EmrRequest Class

Member Function Documentation

EmrRequest::EmrRequest(const Action action)

Constructs a EmrRequest object for EMR action.

EmrRequest::EmrRequest(const EmrRequest &other)

Constructs a copy of other.

[protected] EmrRequest::EmrRequest(EmrRequestPrivate * const d)

Constructs aa EmrRequest object with private implementation d.

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

Action EmrRequest::action() const

Returns the EMR action to be performed by this request.

See also setAction().

QString EmrRequest::actionString() const

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

QString EmrRequest::apiVersion() const

Returns the EMR API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void EmrRequest::setAction(const Action action)

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

See also action().

void EmrRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the EmrRequest object to be equal to other.

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