GlueRequest Class

Member Function Documentation

GlueRequest::GlueRequest(const Action action)

Constructs a GlueRequest object for Glue action.

GlueRequest::GlueRequest(const GlueRequest &other)

Constructs a copy of other.

[protected] GlueRequest::GlueRequest(GlueRequestPrivate * const d)

Constructs aa GlueRequest object with private implementation d.

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

Action GlueRequest::action() const

Returns the Glue action to be performed by this request.

See also setAction().

QString GlueRequest::actionString() const

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

QString GlueRequest::apiVersion() const

Returns the Glue API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void GlueRequest::setAction(const Action action)

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

See also action().

void GlueRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the GlueRequest object to be equal to other.

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