APIGatewayRequest Class

Member Function Documentation

APIGatewayRequest::APIGatewayRequest(const Action action)

Constructs a APIGatewayRequest object for APIGateway action.

APIGatewayRequest::APIGatewayRequest(const APIGatewayRequest &other)

Constructs a copy of other.

[protected] APIGatewayRequest::APIGatewayRequest(APIGatewayRequestPrivate * const d)

Constructs aa APIGatewayRequest object with private implementation d.

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

Action APIGatewayRequest::action() const

Returns the APIGateway action to be performed by this request.

See also setAction().

QString APIGatewayRequest::actionString() const

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

QString APIGatewayRequest::apiVersion() const

Returns the APIGateway API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void APIGatewayRequest::setAction(const Action action)

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

See also action().

void APIGatewayRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the APIGatewayRequest object to be equal to other.

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