ElasticTranscoderRequest Class
(QtAws::ElasticTranscoder::ElasticTranscoderRequest)The ElasticTranscoderRequest class provides an interface for ElasticTranscoder requests. More...
Public Types
| enum | Action { CancelJobAction, CreateJobAction, CreatePipelineAction, CreatePresetAction, ..., UpdatePipelineStatusAction } |
| flags | Actions |
Public Functions
| ElasticTranscoderRequest(const Action action) | |
| ElasticTranscoderRequest(const ElasticTranscoderRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| ElasticTranscoderRequest & | operator=(const ElasticTranscoderRequest &other) |
| virtual bool | operator==(const ElasticTranscoderRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| ElasticTranscoderRequest(ElasticTranscoderRequestPrivate * 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 ¶meters) |
Reimplemented Protected Functions
| virtual QNetworkRequest | unsignedRequest(const QUrl &endpoint) const override |
- 4 protected functions inherited from QtAws::Core::AwsAbstractRequest
Detailed Description
The ElasticTranscoderRequest class provides an interface for ElasticTranscoder requests.
Member Type Documentation
enum ElasticTranscoderRequest::Action
flags ElasticTranscoderRequest::Actions
This enum describes the actions that can be performed as ElasticTranscoder requests.
| Constant | Value | Description |
|---|---|---|
QtAws::ElasticTranscoder::ElasticTranscoderRequest::CancelJobAction | 0 | ElasticTranscoder CancelJob action. |
QtAws::ElasticTranscoder::ElasticTranscoderRequest::CreateJobAction | 1 | ElasticTranscoder CreateJob action. |
QtAws::ElasticTranscoder::ElasticTranscoderRequest::CreatePipelineAction | 2 | ElasticTranscoder CreatePipeline action. |
QtAws::ElasticTranscoder::ElasticTranscoderRequest::CreatePresetAction | 3 | ElasticTranscoder CreatePreset action. |
QtAws::ElasticTranscoder::ElasticTranscoderRequest::DeletePipelineAction | 4 | ElasticTranscoder DeletePipeline action. |
QtAws::ElasticTranscoder::ElasticTranscoderRequest::DeletePresetAction | 5 | ElasticTranscoder DeletePreset action. |
QtAws::ElasticTranscoder::ElasticTranscoderRequest::ListJobsByPipelineAction | 6 | ElasticTranscoder ListJobsByPipeline action. |
QtAws::ElasticTranscoder::ElasticTranscoderRequest::ListJobsByStatusAction | 7 | ElasticTranscoder ListJobsByStatus action. |
QtAws::ElasticTranscoder::ElasticTranscoderRequest::ListPipelinesAction | 8 | ElasticTranscoder ListPipelines action. |
QtAws::ElasticTranscoder::ElasticTranscoderRequest::ListPresetsAction | 9 | ElasticTranscoder ListPresets action. |
QtAws::ElasticTranscoder::ElasticTranscoderRequest::ReadJobAction | 10 | ElasticTranscoder ReadJob action. |
QtAws::ElasticTranscoder::ElasticTranscoderRequest::ReadPipelineAction | 11 | ElasticTranscoder ReadPipeline action. |
QtAws::ElasticTranscoder::ElasticTranscoderRequest::ReadPresetAction | 12 | ElasticTranscoder ReadPreset action. |
QtAws::ElasticTranscoder::ElasticTranscoderRequest::TestRoleAction | 13 | ElasticTranscoder TestRole action. |
QtAws::ElasticTranscoder::ElasticTranscoderRequest::UpdatePipelineAction | 14 | ElasticTranscoder UpdatePipeline action. |
QtAws::ElasticTranscoder::ElasticTranscoderRequest::UpdatePipelineNotificationsAction | 15 | ElasticTranscoder UpdatePipelineNotifications action. |
QtAws::ElasticTranscoder::ElasticTranscoderRequest::UpdatePipelineStatusAction | 16 | ElasticTranscoder UpdatePipelineStatus action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
ElasticTranscoderRequest::ElasticTranscoderRequest(const Action action)
Constructs a ElasticTranscoderRequest object for ElasticTranscoder action.
ElasticTranscoderRequest::ElasticTranscoderRequest(const ElasticTranscoderRequest &other)
Constructs a copy of other.
[protected] ElasticTranscoderRequest::ElasticTranscoderRequest(ElasticTranscoderRequestPrivate * const d)
Constructs aa ElasticTranscoderRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from ElasticTranscoderRequestPrivate.
Action ElasticTranscoderRequest::action() const
Returns the ElasticTranscoder action to be performed by this request.
See also setAction().
QString ElasticTranscoderRequest::actionString() const
Returns the name of the ElasticTranscoder action to be performed by this request.
QString ElasticTranscoderRequest::apiVersion() const
Returns the ElasticTranscoder API version implemented by this request.
See also setApiVersion().
[protected] int ElasticTranscoderRequest::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 ElasticTranscoderRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant ElasticTranscoderRequest::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 &ElasticTranscoderRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void ElasticTranscoderRequest::setAction(const Action action)
Sets the ElasticTranscoder action to be performed by this request to action.
See also action().
void ElasticTranscoderRequest::setApiVersion(const QString &version)
Sets the ElasticTranscoder API version to include in this request to version.
See also apiVersion().
[protected] void ElasticTranscoderRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void ElasticTranscoderRequest::setParameters(const QVariantMap ¶meters)
Sets the paramters for this request to parameters. Any request parameters set previously will be discarded.
See also parameters().
[override virtual protected] QNetworkRequest ElasticTranscoderRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the ElasticTranscoder request using the given endpoint.
This ElasticTranscoder 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.
ElasticTranscoderRequest &ElasticTranscoderRequest::operator=(const ElasticTranscoderRequest &other)
Sets the ElasticTranscoderRequest object to be equal to other.
[virtual] bool ElasticTranscoderRequest::operator==(const ElasticTranscoderRequest &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.