MediaPackageRequest Class

(QtAws::MediaPackage::MediaPackageRequest)

The MediaPackageRequest class provides an interface for MediaPackage requests. More...

Public Types

enum Action { CreateChannelAction, CreateOriginEndpointAction, DeleteChannelAction, DeleteOriginEndpointAction, ..., UpdateOriginEndpointAction }
flags Actions

Public Functions

MediaPackageRequest(const Action action)
MediaPackageRequest(const MediaPackageRequest &other)
Action action() const
QString actionString() const
QString apiVersion() const
void setAction(const Action action)
void setApiVersion(const QString &version)
MediaPackageRequest &operator=(const MediaPackageRequest &other)
virtual bool operator==(const MediaPackageRequest &other) const

Protected Functions

MediaPackageRequest(MediaPackageRequestPrivate * const d)
int clearParameter(const QString &name)
void clearParameters()
QVariant parameter(const QString &name, const QVariant &defaultValue = QVariant()) const
const QVariantMap &parameters() const
void setParameter(const QString &name, const QVariant &value)
void setParameters(const QVariantMap &parameters)

Reimplemented Protected Functions

virtual QNetworkRequest unsignedRequest(const QUrl &endpoint) const override

Detailed Description

The MediaPackageRequest class provides an interface for MediaPackage requests.

Member Type Documentation

enum MediaPackageRequest::Action
flags MediaPackageRequest::Actions

This enum describes the actions that can be performed as MediaPackage requests.

ConstantValueDescription
QtAws::MediaPackage::MediaPackageRequest::CreateChannelAction0MediaPackage CreateChannel action.
QtAws::MediaPackage::MediaPackageRequest::CreateOriginEndpointAction1MediaPackage CreateOriginEndpoint action.
QtAws::MediaPackage::MediaPackageRequest::DeleteChannelAction2MediaPackage DeleteChannel action.
QtAws::MediaPackage::MediaPackageRequest::DeleteOriginEndpointAction3MediaPackage DeleteOriginEndpoint action.
QtAws::MediaPackage::MediaPackageRequest::DescribeChannelAction4MediaPackage DescribeChannel action.
QtAws::MediaPackage::MediaPackageRequest::DescribeOriginEndpointAction5MediaPackage DescribeOriginEndpoint action.
QtAws::MediaPackage::MediaPackageRequest::ListChannelsAction6MediaPackage ListChannels action.
QtAws::MediaPackage::MediaPackageRequest::ListOriginEndpointsAction7MediaPackage ListOriginEndpoints action.
QtAws::MediaPackage::MediaPackageRequest::RotateChannelCredentialsAction8MediaPackage RotateChannelCredentials action.
QtAws::MediaPackage::MediaPackageRequest::UpdateChannelAction9MediaPackage UpdateChannel action.
QtAws::MediaPackage::MediaPackageRequest::UpdateOriginEndpointAction10MediaPackage UpdateOriginEndpoint action.

The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.

Member Function Documentation

MediaPackageRequest::MediaPackageRequest(const Action action)

Constructs a MediaPackageRequest object for MediaPackage action.

MediaPackageRequest::MediaPackageRequest(const MediaPackageRequest &other)

Constructs a copy of other.

[protected] MediaPackageRequest::MediaPackageRequest(MediaPackageRequestPrivate * const d)

Constructs aa MediaPackageRequest object with private implementation d.

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

Action MediaPackageRequest::action() const

Returns the MediaPackage action to be performed by this request.

See also setAction().

QString MediaPackageRequest::actionString() const

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

QString MediaPackageRequest::apiVersion() const

Returns the MediaPackage API version implemented by this request.

See also setApiVersion().

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

Removes all parameters from the request.

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

Returns the parameters included in this request.

See also setParameters().

void MediaPackageRequest::setAction(const Action action)

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

See also action().

void MediaPackageRequest::setApiVersion(const QString &version)

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

See also apiVersion().

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

Sets the name parameter to value.

See also parameter().

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

Reimplemented from AwsAbstractRequest::unsignedRequest().

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

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

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

Sets the MediaPackageRequest object to be equal to other.

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

© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.