RekognitionRequest Class
(QtAws::Rekognition::RekognitionRequest)The RekognitionRequest class provides an interface for Rekognition requests. More...
Public Types
| enum | Action { CompareFacesAction, CreateCollectionAction, CreateStreamProcessorAction, DeleteCollectionAction, ..., StopStreamProcessorAction } |
| flags | Actions |
Public Functions
| RekognitionRequest(const Action action) | |
| RekognitionRequest(const RekognitionRequest &other) | |
| Action | action() const |
| QString | actionString() const |
| QString | apiVersion() const |
| void | setAction(const Action action) |
| void | setApiVersion(const QString &version) |
| RekognitionRequest & | operator=(const RekognitionRequest &other) |
| virtual bool | operator==(const RekognitionRequest &other) const |
- 7 public functions inherited from QtAws::Core::AwsAbstractRequest
Protected Functions
| RekognitionRequest(RekognitionRequestPrivate * 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 RekognitionRequest class provides an interface for Rekognition requests.
Member Type Documentation
enum RekognitionRequest::Action
flags RekognitionRequest::Actions
This enum describes the actions that can be performed as Rekognition requests.
| Constant | Value | Description |
|---|---|---|
QtAws::Rekognition::RekognitionRequest::CompareFacesAction | 0 | Rekognition CompareFaces action. |
QtAws::Rekognition::RekognitionRequest::CreateCollectionAction | 1 | Rekognition CreateCollection action. |
QtAws::Rekognition::RekognitionRequest::CreateStreamProcessorAction | 2 | Rekognition CreateStreamProcessor action. |
QtAws::Rekognition::RekognitionRequest::DeleteCollectionAction | 3 | Rekognition DeleteCollection action. |
QtAws::Rekognition::RekognitionRequest::DeleteFacesAction | 4 | Rekognition DeleteFaces action. |
QtAws::Rekognition::RekognitionRequest::DeleteStreamProcessorAction | 5 | Rekognition DeleteStreamProcessor action. |
QtAws::Rekognition::RekognitionRequest::DescribeStreamProcessorAction | 6 | Rekognition DescribeStreamProcessor action. |
QtAws::Rekognition::RekognitionRequest::DetectFacesAction | 7 | Rekognition DetectFaces action. |
QtAws::Rekognition::RekognitionRequest::DetectLabelsAction | 8 | Rekognition DetectLabels action. |
QtAws::Rekognition::RekognitionRequest::DetectModerationLabelsAction | 9 | Rekognition DetectModerationLabels action. |
QtAws::Rekognition::RekognitionRequest::DetectTextAction | 10 | Rekognition DetectText action. |
QtAws::Rekognition::RekognitionRequest::GetCelebrityInfoAction | 11 | Rekognition GetCelebrityInfo action. |
QtAws::Rekognition::RekognitionRequest::GetCelebrityRecognitionAction | 12 | Rekognition GetCelebrityRecognition action. |
QtAws::Rekognition::RekognitionRequest::GetContentModerationAction | 13 | Rekognition GetContentModeration action. |
QtAws::Rekognition::RekognitionRequest::GetFaceDetectionAction | 14 | Rekognition GetFaceDetection action. |
QtAws::Rekognition::RekognitionRequest::GetFaceSearchAction | 15 | Rekognition GetFaceSearch action. |
QtAws::Rekognition::RekognitionRequest::GetLabelDetectionAction | 16 | Rekognition GetLabelDetection action. |
QtAws::Rekognition::RekognitionRequest::GetPersonTrackingAction | 17 | Rekognition GetPersonTracking action. |
QtAws::Rekognition::RekognitionRequest::IndexFacesAction | 18 | Rekognition IndexFaces action. |
QtAws::Rekognition::RekognitionRequest::ListCollectionsAction | 19 | Rekognition ListCollections action. |
QtAws::Rekognition::RekognitionRequest::ListFacesAction | 20 | Rekognition ListFaces action. |
QtAws::Rekognition::RekognitionRequest::ListStreamProcessorsAction | 21 | Rekognition ListStreamProcessors action. |
QtAws::Rekognition::RekognitionRequest::RecognizeCelebritiesAction | 22 | Rekognition RecognizeCelebrities action. |
QtAws::Rekognition::RekognitionRequest::SearchFacesAction | 23 | Rekognition SearchFaces action. |
QtAws::Rekognition::RekognitionRequest::SearchFacesByImageAction | 24 | Rekognition SearchFacesByImage action. |
QtAws::Rekognition::RekognitionRequest::StartCelebrityRecognitionAction | 25 | Rekognition StartCelebrityRecognition action. |
QtAws::Rekognition::RekognitionRequest::StartContentModerationAction | 26 | Rekognition StartContentModeration action. |
QtAws::Rekognition::RekognitionRequest::StartFaceDetectionAction | 27 | Rekognition StartFaceDetection action. |
QtAws::Rekognition::RekognitionRequest::StartFaceSearchAction | 28 | Rekognition StartFaceSearch action. |
QtAws::Rekognition::RekognitionRequest::StartLabelDetectionAction | 29 | Rekognition StartLabelDetection action. |
QtAws::Rekognition::RekognitionRequest::StartPersonTrackingAction | 30 | Rekognition StartPersonTracking action. |
QtAws::Rekognition::RekognitionRequest::StartStreamProcessorAction | 31 | Rekognition StartStreamProcessor action. |
QtAws::Rekognition::RekognitionRequest::StopStreamProcessorAction | 32 | Rekognition StopStreamProcessor action. |
The Actions type is a typedef for QFlags<Action>. It stores an OR combination of Action values.
Member Function Documentation
RekognitionRequest::RekognitionRequest(const Action action)
Constructs a RekognitionRequest object for Rekognition action.
RekognitionRequest::RekognitionRequest(const RekognitionRequest &other)
Constructs a copy of other.
[protected] RekognitionRequest::RekognitionRequest(RekognitionRequestPrivate * const d)
Constructs aa RekognitionRequest object with private implementation d.
This overload allows derived classes to provide their own private class implementation that inherits from RekognitionRequestPrivate.
Action RekognitionRequest::action() const
Returns the Rekognition action to be performed by this request.
See also setAction().
QString RekognitionRequest::actionString() const
Returns the name of the Rekognition action to be performed by this request.
QString RekognitionRequest::apiVersion() const
Returns the Rekognition API version implemented by this request.
See also setApiVersion().
[protected] int RekognitionRequest::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 RekognitionRequest::clearParameters()
Removes all parameters from the request.
[protected] QVariant RekognitionRequest::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 &RekognitionRequest::parameters() const
Returns the parameters included in this request.
See also setParameters().
void RekognitionRequest::setAction(const Action action)
Sets the Rekognition action to be performed by this request to action.
See also action().
void RekognitionRequest::setApiVersion(const QString &version)
Sets the Rekognition API version to include in this request to version.
See also apiVersion().
[protected] void RekognitionRequest::setParameter(const QString &name, const QVariant &value)
Sets the name parameter to value.
See also parameter().
[protected] void RekognitionRequest::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 RekognitionRequest::unsignedRequest(const QUrl &endpoint) const
Reimplemented from AwsAbstractRequest::unsignedRequest().
Returns a network request for the Rekognition request using the given endpoint.
This Rekognition 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.
RekognitionRequest &RekognitionRequest::operator=(const RekognitionRequest &other)
Sets the RekognitionRequest object to be equal to other.
[virtual] bool RekognitionRequest::operator==(const RekognitionRequest &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.