KinesisVideoArchivedMediaRequest Class

Member Function Documentation

KinesisVideoArchivedMediaRequest::KinesisVideoArchivedMediaRequest(const Action action)

Constructs a KinesisVideoArchivedMediaRequest object for KinesisVideoArchivedMedia action.

KinesisVideoArchivedMediaRequest::KinesisVideoArchivedMediaRequest(const KinesisVideoArchivedMediaRequest &other)

Constructs a copy of other.

[protected] KinesisVideoArchivedMediaRequest::KinesisVideoArchivedMediaRequest(KinesisVideoArchivedMediaRequestPrivate * const d)

Constructs aa KinesisVideoArchivedMediaRequest object with private implementation d.

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

Action KinesisVideoArchivedMediaRequest::action() const

Returns the KinesisVideoArchivedMedia action to be performed by this request.

See also setAction().

QString KinesisVideoArchivedMediaRequest::actionString() const

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

QString KinesisVideoArchivedMediaRequest::apiVersion() const

Returns the KinesisVideoArchivedMedia API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void KinesisVideoArchivedMediaRequest::setAction(const Action action)

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

See also action().

void KinesisVideoArchivedMediaRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the KinesisVideoArchivedMediaRequest object to be equal to other.

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