ImportExportRequest Class

Member Function Documentation

ImportExportRequest::ImportExportRequest(const Action action)

Constructs a ImportExportRequest object for ImportExport action.

ImportExportRequest::ImportExportRequest(const ImportExportRequest &other)

Constructs a copy of other.

[protected] ImportExportRequest::ImportExportRequest(ImportExportRequestPrivate * const d)

Constructs aa ImportExportRequest object with private implementation d.

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

Action ImportExportRequest::action() const

Returns the ImportExport action to be performed by this request.

See also setAction().

QString ImportExportRequest::actionString() const

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

QString ImportExportRequest::apiVersion() const

Returns the ImportExport API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void ImportExportRequest::setAction(const Action action)

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

See also action().

void ImportExportRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the ImportExportRequest object to be equal to other.

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