MigrationHubRequest Class

Member Function Documentation

MigrationHubRequest::MigrationHubRequest(const Action action)

Constructs a MigrationHubRequest object for MigrationHub action.

MigrationHubRequest::MigrationHubRequest(const MigrationHubRequest &other)

Constructs a copy of other.

[protected] MigrationHubRequest::MigrationHubRequest(MigrationHubRequestPrivate * const d)

Constructs aa MigrationHubRequest object with private implementation d.

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

Action MigrationHubRequest::action() const

Returns the MigrationHub action to be performed by this request.

See also setAction().

QString MigrationHubRequest::actionString() const

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

QString MigrationHubRequest::apiVersion() const

Returns the MigrationHub API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void MigrationHubRequest::setAction(const Action action)

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

See also action().

void MigrationHubRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the MigrationHubRequest object to be equal to other.

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