SsmRequest Class

Member Function Documentation

SsmRequest::SsmRequest(const Action action)

Constructs a SsmRequest object for SSM action.

SsmRequest::SsmRequest(const SsmRequest &other)

Constructs a copy of other.

[protected] SsmRequest::SsmRequest(SsmRequestPrivate * const d)

Constructs aa SsmRequest object with private implementation d.

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

Action SsmRequest::action() const

Returns the SSM action to be performed by this request.

See also setAction().

QString SsmRequest::actionString() const

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

QString SsmRequest::apiVersion() const

Returns the SSM API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void SsmRequest::setAction(const Action action)

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

See also action().

void SsmRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the SsmRequest object to be equal to other.

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