MediaConvertRequest Class

Member Function Documentation

MediaConvertRequest::MediaConvertRequest(const Action action)

Constructs a MediaConvertRequest object for MediaConvert action.

MediaConvertRequest::MediaConvertRequest(const MediaConvertRequest &other)

Constructs a copy of other.

[protected] MediaConvertRequest::MediaConvertRequest(MediaConvertRequestPrivate * const d)

Constructs aa MediaConvertRequest object with private implementation d.

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

Action MediaConvertRequest::action() const

Returns the MediaConvert action to be performed by this request.

See also setAction().

QString MediaConvertRequest::actionString() const

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

QString MediaConvertRequest::apiVersion() const

Returns the MediaConvert API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void MediaConvertRequest::setAction(const Action action)

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

See also action().

void MediaConvertRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the MediaConvertRequest object to be equal to other.

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