BatchRequest Class

Member Function Documentation

BatchRequest::BatchRequest(const Action action)

Constructs a BatchRequest object for Batch action.

BatchRequest::BatchRequest(const BatchRequest &other)

Constructs a copy of other.

[protected] BatchRequest::BatchRequest(BatchRequestPrivate * const d)

Constructs aa BatchRequest object with private implementation d.

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

Action BatchRequest::action() const

Returns the Batch action to be performed by this request.

See also setAction().

QString BatchRequest::actionString() const

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

QString BatchRequest::apiVersion() const

Returns the Batch API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void BatchRequest::setAction(const Action action)

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

See also action().

void BatchRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the BatchRequest object to be equal to other.

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