TranscribeServiceRequest Class
(QtAws::TranscribeService::TranscribeServiceRequest)The TranscribeServiceRequest class provides an interface for TranscribeService requests. More...
Public Types
| enum | Action { CreateVocabularyAction, DeleteVocabularyAction, GetTranscriptionJobAction, GetVocabularyAction, ..., UpdateVocabularyAction } |
| flags | Actions |
Public Functions
| TranscribeServiceRequest(const Action action) | |
| TranscribeServiceRequest(const TranscribeServiceRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| TranscribeServiceRequest & | operator=(const TranscribeServiceRequest &other) |
| virtual bool | operator==(const TranscribeServiceRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| TranscribeServiceRequest(TranscribeServiceRequestPrivate * 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 TranscribeServiceRequest class provides an interface for TranscribeService requests.
Member Type Documentation
enum TranscribeServiceRequest::Action
flags TranscribeServiceRequest::Actions
This enum describes the actions that can be performed as TranscribeService requests.
| Constant | Value | Description |
|---|---|---|
QtAws::TranscribeService::TranscribeServiceRequest::CreateVocabularyAction | 0 | TranscribeService CreateVocabulary action. |
QtAws::TranscribeService::TranscribeServiceRequest::DeleteVocabularyAction | 1 | TranscribeService DeleteVocabulary action. |
QtAws::TranscribeService::TranscribeServiceRequest::GetTranscriptionJobAction | 2 | TranscribeService GetTranscriptionJob action. |
QtAws::TranscribeService::TranscribeServiceRequest::GetVocabularyAction | 3 | TranscribeService GetVocabulary action. |
QtAws::TranscribeService::TranscribeServiceRequest::ListTranscriptionJobsAction | 4 | TranscribeService ListTranscriptionJobs action. |
QtAws::TranscribeService::TranscribeServiceRequest::ListVocabulariesAction | 5 | TranscribeService ListVocabularies action. |
QtAws::TranscribeService::TranscribeServiceRequest::StartTranscriptionJobAction | 6 | TranscribeService StartTranscriptionJob action. |
QtAws::TranscribeService::TranscribeServiceRequest::UpdateVocabularyAction | 7 | TranscribeService UpdateVocabulary action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
TranscribeServiceRequest::TranscribeServiceRequest(const Action action)
Constructs a TranscribeServiceRequest object for TranscribeService action.
TranscribeServiceRequest::TranscribeServiceRequest(const TranscribeServiceRequest &other)
Constructs a copy of other.
[protected] TranscribeServiceRequest::TranscribeServiceRequest(TranscribeServiceRequestPrivate * const d)
Constructs aa TranscribeServiceRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from TranscribeServiceRequestPrivate.
Action TranscribeServiceRequest::action() const
Returns the TranscribeService action to be performed by this request.
See also setAction().
QString TranscribeServiceRequest::actionString() const
Returns the name of the TranscribeService action to be performed by this request.
QString TranscribeServiceRequest::apiVersion() const
Returns the TranscribeService API version implemented by this request.
See also setApiVersion().
[protected] int TranscribeServiceRequest::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 TranscribeServiceRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant TranscribeServiceRequest::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 &TranscribeServiceRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void TranscribeServiceRequest::setAction(const Action action)
Sets the TranscribeService action to be performed by this request to action.
See also action().
void TranscribeServiceRequest::setApiVersion(const QString &version)
Sets the TranscribeService API version to include in this request to version.
See also apiVersion().
[protected] void TranscribeServiceRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void TranscribeServiceRequest::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 TranscribeServiceRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the TranscribeService request using the given endpoint.
This TranscribeService 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.
TranscribeServiceRequest &TranscribeServiceRequest::operator=(const TranscribeServiceRequest &other)
Sets the TranscribeServiceRequest object to be equal to other.
[virtual] bool TranscribeServiceRequest::operator==(const TranscribeServiceRequest &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.