MachineLearningRequest Class

Member Function Documentation

MachineLearningRequest::MachineLearningRequest(const Action action)

Constructs a MachineLearningRequest object for MachineLearning action.

MachineLearningRequest::MachineLearningRequest(const MachineLearningRequest &other)

Constructs a copy of other.

[protected] MachineLearningRequest::MachineLearningRequest(MachineLearningRequestPrivate * const d)

Constructs aa MachineLearningRequest object with private implementation d.

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

Action MachineLearningRequest::action() const

Returns the MachineLearning action to be performed by this request.

See also setAction().

QString MachineLearningRequest::actionString() const

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

QString MachineLearningRequest::apiVersion() const

Returns the MachineLearning API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void MachineLearningRequest::setAction(const Action action)

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

See also action().

void MachineLearningRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the MachineLearningRequest object to be equal to other.

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