SecretsManagerRequest Class

Member Function Documentation

SecretsManagerRequest::SecretsManagerRequest(const Action action)

Constructs a SecretsManagerRequest object for SecretsManager action.

SecretsManagerRequest::SecretsManagerRequest(const SecretsManagerRequest &other)

Constructs a copy of other.

[protected] SecretsManagerRequest::SecretsManagerRequest(SecretsManagerRequestPrivate * const d)

Constructs aa SecretsManagerRequest object with private implementation d.

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

Action SecretsManagerRequest::action() const

Returns the SecretsManager action to be performed by this request.

See also setAction().

QString SecretsManagerRequest::actionString() const

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

QString SecretsManagerRequest::apiVersion() const

Returns the SecretsManager API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void SecretsManagerRequest::setAction(const Action action)

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

See also action().

void SecretsManagerRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the SecretsManagerRequest object to be equal to other.

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