RekognitionRequest Class

(QtAws::Rekognition::RekognitionRequest)

The RekognitionRequest class provides an interface for Rekognition requests. More...

Header: #include <RekognitionRequest>
Inherits: QtAws::Core::AwsAbstractRequest
Inherited By:

QtAws::Rekognition::CompareFacesRequest, QtAws::Rekognition::CreateCollectionRequest, QtAws::Rekognition::CreateStreamProcessorRequest, QtAws::Rekognition::DeleteCollectionRequest, QtAws::Rekognition::DeleteFacesRequest, QtAws::Rekognition::DeleteStreamProcessorRequest, QtAws::Rekognition::DescribeStreamProcessorRequest, QtAws::Rekognition::DetectFacesRequest, QtAws::Rekognition::DetectLabelsRequest, QtAws::Rekognition::DetectModerationLabelsRequest, QtAws::Rekognition::DetectTextRequest, QtAws::Rekognition::GetCelebrityInfoRequest, QtAws::Rekognition::GetCelebrityRecognitionRequest, QtAws::Rekognition::GetContentModerationRequest, QtAws::Rekognition::GetFaceDetectionRequest, QtAws::Rekognition::GetFaceSearchRequest, QtAws::Rekognition::GetLabelDetectionRequest, QtAws::Rekognition::GetPersonTrackingRequest, QtAws::Rekognition::IndexFacesRequest, QtAws::Rekognition::ListCollectionsRequest, QtAws::Rekognition::ListFacesRequest, QtAws::Rekognition::ListStreamProcessorsRequest, QtAws::Rekognition::RecognizeCelebritiesRequest, QtAws::Rekognition::SearchFacesByImageRequest, QtAws::Rekognition::SearchFacesRequest, QtAws::Rekognition::StartCelebrityRecognitionRequest, QtAws::Rekognition::StartContentModerationRequest, QtAws::Rekognition::StartFaceDetectionRequest, QtAws::Rekognition::StartFaceSearchRequest, QtAws::Rekognition::StartLabelDetectionRequest, QtAws::Rekognition::StartPersonTrackingRequest, QtAws::Rekognition::StartStreamProcessorRequest, and QtAws::Rekognition::StopStreamProcessorRequest

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

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 &parameters)

Reimplemented Protected Functions

virtual QNetworkRequest unsignedRequest(const QUrl &endpoint) const override

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.

ConstantValueDescription
QtAws::Rekognition::RekognitionRequest::CompareFacesAction0Rekognition CompareFaces action.
QtAws::Rekognition::RekognitionRequest::CreateCollectionAction1Rekognition CreateCollection action.
QtAws::Rekognition::RekognitionRequest::CreateStreamProcessorAction2Rekognition CreateStreamProcessor action.
QtAws::Rekognition::RekognitionRequest::DeleteCollectionAction3Rekognition DeleteCollection action.
QtAws::Rekognition::RekognitionRequest::DeleteFacesAction4Rekognition DeleteFaces action.
QtAws::Rekognition::RekognitionRequest::DeleteStreamProcessorAction5Rekognition DeleteStreamProcessor action.
QtAws::Rekognition::RekognitionRequest::DescribeStreamProcessorAction6Rekognition DescribeStreamProcessor action.
QtAws::Rekognition::RekognitionRequest::DetectFacesAction7Rekognition DetectFaces action.
QtAws::Rekognition::RekognitionRequest::DetectLabelsAction8Rekognition DetectLabels action.
QtAws::Rekognition::RekognitionRequest::DetectModerationLabelsAction9Rekognition DetectModerationLabels action.
QtAws::Rekognition::RekognitionRequest::DetectTextAction10Rekognition DetectText action.
QtAws::Rekognition::RekognitionRequest::GetCelebrityInfoAction11Rekognition GetCelebrityInfo action.
QtAws::Rekognition::RekognitionRequest::GetCelebrityRecognitionAction12Rekognition GetCelebrityRecognition action.
QtAws::Rekognition::RekognitionRequest::GetContentModerationAction13Rekognition GetContentModeration action.
QtAws::Rekognition::RekognitionRequest::GetFaceDetectionAction14Rekognition GetFaceDetection action.
QtAws::Rekognition::RekognitionRequest::GetFaceSearchAction15Rekognition GetFaceSearch action.
QtAws::Rekognition::RekognitionRequest::GetLabelDetectionAction16Rekognition GetLabelDetection action.
QtAws::Rekognition::RekognitionRequest::GetPersonTrackingAction17Rekognition GetPersonTracking action.
QtAws::Rekognition::RekognitionRequest::IndexFacesAction18Rekognition IndexFaces action.
QtAws::Rekognition::RekognitionRequest::ListCollectionsAction19Rekognition ListCollections action.
QtAws::Rekognition::RekognitionRequest::ListFacesAction20Rekognition ListFaces action.
QtAws::Rekognition::RekognitionRequest::ListStreamProcessorsAction21Rekognition ListStreamProcessors action.
QtAws::Rekognition::RekognitionRequest::RecognizeCelebritiesAction22Rekognition RecognizeCelebrities action.
QtAws::Rekognition::RekognitionRequest::SearchFacesAction23Rekognition SearchFaces action.
QtAws::Rekognition::RekognitionRequest::SearchFacesByImageAction24Rekognition SearchFacesByImage action.
QtAws::Rekognition::RekognitionRequest::StartCelebrityRecognitionAction25Rekognition StartCelebrityRecognition action.
QtAws::Rekognition::RekognitionRequest::StartContentModerationAction26Rekognition StartContentModeration action.
QtAws::Rekognition::RekognitionRequest::StartFaceDetectionAction27Rekognition StartFaceDetection action.
QtAws::Rekognition::RekognitionRequest::StartFaceSearchAction28Rekognition StartFaceSearch action.
QtAws::Rekognition::RekognitionRequest::StartLabelDetectionAction29Rekognition StartLabelDetection action.
QtAws::Rekognition::RekognitionRequest::StartPersonTrackingAction30Rekognition StartPersonTracking action.
QtAws::Rekognition::RekognitionRequest::StartStreamProcessorAction31Rekognition StartStreamProcessor action.
QtAws::Rekognition::RekognitionRequest::StopStreamProcessorAction32Rekognition 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 &parameters)

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.