/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include namespace Aws { template class AmazonWebServiceResult; namespace Utils { namespace Json { class JsonValue; } // namespace Json } // namespace Utils namespace Rekognition { namespace Model { class GetFaceSearchResult { public: AWS_REKOGNITION_API GetFaceSearchResult(); AWS_REKOGNITION_API GetFaceSearchResult(const Aws::AmazonWebServiceResult& result); AWS_REKOGNITION_API GetFaceSearchResult& operator=(const Aws::AmazonWebServiceResult& result); /** *

The current status of the face search job.

*/ inline const VideoJobStatus& GetJobStatus() const{ return m_jobStatus; } /** *

The current status of the face search job.

*/ inline void SetJobStatus(const VideoJobStatus& value) { m_jobStatus = value; } /** *

The current status of the face search job.

*/ inline void SetJobStatus(VideoJobStatus&& value) { m_jobStatus = std::move(value); } /** *

The current status of the face search job.

*/ inline GetFaceSearchResult& WithJobStatus(const VideoJobStatus& value) { SetJobStatus(value); return *this;} /** *

The current status of the face search job.

*/ inline GetFaceSearchResult& WithJobStatus(VideoJobStatus&& value) { SetJobStatus(std::move(value)); return *this;} /** *

If the job fails, StatusMessage provides a descriptive error * message.

*/ inline const Aws::String& GetStatusMessage() const{ return m_statusMessage; } /** *

If the job fails, StatusMessage provides a descriptive error * message.

*/ inline void SetStatusMessage(const Aws::String& value) { m_statusMessage = value; } /** *

If the job fails, StatusMessage provides a descriptive error * message.

*/ inline void SetStatusMessage(Aws::String&& value) { m_statusMessage = std::move(value); } /** *

If the job fails, StatusMessage provides a descriptive error * message.

*/ inline void SetStatusMessage(const char* value) { m_statusMessage.assign(value); } /** *

If the job fails, StatusMessage provides a descriptive error * message.

*/ inline GetFaceSearchResult& WithStatusMessage(const Aws::String& value) { SetStatusMessage(value); return *this;} /** *

If the job fails, StatusMessage provides a descriptive error * message.

*/ inline GetFaceSearchResult& WithStatusMessage(Aws::String&& value) { SetStatusMessage(std::move(value)); return *this;} /** *

If the job fails, StatusMessage provides a descriptive error * message.

*/ inline GetFaceSearchResult& WithStatusMessage(const char* value) { SetStatusMessage(value); return *this;} /** *

If the response is truncated, Amazon Rekognition Video returns this token * that you can use in the subsequent request to retrieve the next set of search * results.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

If the response is truncated, Amazon Rekognition Video returns this token * that you can use in the subsequent request to retrieve the next set of search * results.

*/ inline void SetNextToken(const Aws::String& value) { m_nextToken = value; } /** *

If the response is truncated, Amazon Rekognition Video returns this token * that you can use in the subsequent request to retrieve the next set of search * results.

*/ inline void SetNextToken(Aws::String&& value) { m_nextToken = std::move(value); } /** *

If the response is truncated, Amazon Rekognition Video returns this token * that you can use in the subsequent request to retrieve the next set of search * results.

*/ inline void SetNextToken(const char* value) { m_nextToken.assign(value); } /** *

If the response is truncated, Amazon Rekognition Video returns this token * that you can use in the subsequent request to retrieve the next set of search * results.

*/ inline GetFaceSearchResult& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

If the response is truncated, Amazon Rekognition Video returns this token * that you can use in the subsequent request to retrieve the next set of search * results.

*/ inline GetFaceSearchResult& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

If the response is truncated, Amazon Rekognition Video returns this token * that you can use in the subsequent request to retrieve the next set of search * results.

*/ inline GetFaceSearchResult& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

Information about a video that Amazon Rekognition analyzed. * Videometadata is returned in every page of paginated responses from * a Amazon Rekognition Video operation.

*/ inline const VideoMetadata& GetVideoMetadata() const{ return m_videoMetadata; } /** *

Information about a video that Amazon Rekognition analyzed. * Videometadata is returned in every page of paginated responses from * a Amazon Rekognition Video operation.

*/ inline void SetVideoMetadata(const VideoMetadata& value) { m_videoMetadata = value; } /** *

Information about a video that Amazon Rekognition analyzed. * Videometadata is returned in every page of paginated responses from * a Amazon Rekognition Video operation.

*/ inline void SetVideoMetadata(VideoMetadata&& value) { m_videoMetadata = std::move(value); } /** *

Information about a video that Amazon Rekognition analyzed. * Videometadata is returned in every page of paginated responses from * a Amazon Rekognition Video operation.

*/ inline GetFaceSearchResult& WithVideoMetadata(const VideoMetadata& value) { SetVideoMetadata(value); return *this;} /** *

Information about a video that Amazon Rekognition analyzed. * Videometadata is returned in every page of paginated responses from * a Amazon Rekognition Video operation.

*/ inline GetFaceSearchResult& WithVideoMetadata(VideoMetadata&& value) { SetVideoMetadata(std::move(value)); return *this;} /** *

An array of persons, PersonMatch, in the video whose face(s) match the * face(s) in an Amazon Rekognition collection. It also includes time information * for when persons are matched in the video. You specify the input collection in * an initial call to StartFaceSearch. Each Persons * element includes a time the person was matched, face match details * (FaceMatches) for matching faces in the collection, and person * information (Person) for the matched person.

*/ inline const Aws::Vector& GetPersons() const{ return m_persons; } /** *

An array of persons, PersonMatch, in the video whose face(s) match the * face(s) in an Amazon Rekognition collection. It also includes time information * for when persons are matched in the video. You specify the input collection in * an initial call to StartFaceSearch. Each Persons * element includes a time the person was matched, face match details * (FaceMatches) for matching faces in the collection, and person * information (Person) for the matched person.

*/ inline void SetPersons(const Aws::Vector& value) { m_persons = value; } /** *

An array of persons, PersonMatch, in the video whose face(s) match the * face(s) in an Amazon Rekognition collection. It also includes time information * for when persons are matched in the video. You specify the input collection in * an initial call to StartFaceSearch. Each Persons * element includes a time the person was matched, face match details * (FaceMatches) for matching faces in the collection, and person * information (Person) for the matched person.

*/ inline void SetPersons(Aws::Vector&& value) { m_persons = std::move(value); } /** *

An array of persons, PersonMatch, in the video whose face(s) match the * face(s) in an Amazon Rekognition collection. It also includes time information * for when persons are matched in the video. You specify the input collection in * an initial call to StartFaceSearch. Each Persons * element includes a time the person was matched, face match details * (FaceMatches) for matching faces in the collection, and person * information (Person) for the matched person.

*/ inline GetFaceSearchResult& WithPersons(const Aws::Vector& value) { SetPersons(value); return *this;} /** *

An array of persons, PersonMatch, in the video whose face(s) match the * face(s) in an Amazon Rekognition collection. It also includes time information * for when persons are matched in the video. You specify the input collection in * an initial call to StartFaceSearch. Each Persons * element includes a time the person was matched, face match details * (FaceMatches) for matching faces in the collection, and person * information (Person) for the matched person.

*/ inline GetFaceSearchResult& WithPersons(Aws::Vector&& value) { SetPersons(std::move(value)); return *this;} /** *

An array of persons, PersonMatch, in the video whose face(s) match the * face(s) in an Amazon Rekognition collection. It also includes time information * for when persons are matched in the video. You specify the input collection in * an initial call to StartFaceSearch. Each Persons * element includes a time the person was matched, face match details * (FaceMatches) for matching faces in the collection, and person * information (Person) for the matched person.

*/ inline GetFaceSearchResult& AddPersons(const PersonMatch& value) { m_persons.push_back(value); return *this; } /** *

An array of persons, PersonMatch, in the video whose face(s) match the * face(s) in an Amazon Rekognition collection. It also includes time information * for when persons are matched in the video. You specify the input collection in * an initial call to StartFaceSearch. Each Persons * element includes a time the person was matched, face match details * (FaceMatches) for matching faces in the collection, and person * information (Person) for the matched person.

*/ inline GetFaceSearchResult& AddPersons(PersonMatch&& value) { m_persons.push_back(std::move(value)); return *this; } /** *

Job identifier for the face search operation for which you want to obtain * results. The job identifer is returned by an initial call to * StartFaceSearch.

*/ inline const Aws::String& GetJobId() const{ return m_jobId; } /** *

Job identifier for the face search operation for which you want to obtain * results. The job identifer is returned by an initial call to * StartFaceSearch.

*/ inline void SetJobId(const Aws::String& value) { m_jobId = value; } /** *

Job identifier for the face search operation for which you want to obtain * results. The job identifer is returned by an initial call to * StartFaceSearch.

*/ inline void SetJobId(Aws::String&& value) { m_jobId = std::move(value); } /** *

Job identifier for the face search operation for which you want to obtain * results. The job identifer is returned by an initial call to * StartFaceSearch.

*/ inline void SetJobId(const char* value) { m_jobId.assign(value); } /** *

Job identifier for the face search operation for which you want to obtain * results. The job identifer is returned by an initial call to * StartFaceSearch.

*/ inline GetFaceSearchResult& WithJobId(const Aws::String& value) { SetJobId(value); return *this;} /** *

Job identifier for the face search operation for which you want to obtain * results. The job identifer is returned by an initial call to * StartFaceSearch.

*/ inline GetFaceSearchResult& WithJobId(Aws::String&& value) { SetJobId(std::move(value)); return *this;} /** *

Job identifier for the face search operation for which you want to obtain * results. The job identifer is returned by an initial call to * StartFaceSearch.

*/ inline GetFaceSearchResult& WithJobId(const char* value) { SetJobId(value); return *this;} inline const Video& GetVideo() const{ return m_video; } inline void SetVideo(const Video& value) { m_video = value; } inline void SetVideo(Video&& value) { m_video = std::move(value); } inline GetFaceSearchResult& WithVideo(const Video& value) { SetVideo(value); return *this;} inline GetFaceSearchResult& WithVideo(Video&& value) { SetVideo(std::move(value)); return *this;} /** *

A job identifier specified in the call to StartFaceSearch and returned in the * job completion notification sent to your Amazon Simple Notification Service * topic.

*/ inline const Aws::String& GetJobTag() const{ return m_jobTag; } /** *

A job identifier specified in the call to StartFaceSearch and returned in the * job completion notification sent to your Amazon Simple Notification Service * topic.

*/ inline void SetJobTag(const Aws::String& value) { m_jobTag = value; } /** *

A job identifier specified in the call to StartFaceSearch and returned in the * job completion notification sent to your Amazon Simple Notification Service * topic.

*/ inline void SetJobTag(Aws::String&& value) { m_jobTag = std::move(value); } /** *

A job identifier specified in the call to StartFaceSearch and returned in the * job completion notification sent to your Amazon Simple Notification Service * topic.

*/ inline void SetJobTag(const char* value) { m_jobTag.assign(value); } /** *

A job identifier specified in the call to StartFaceSearch and returned in the * job completion notification sent to your Amazon Simple Notification Service * topic.

*/ inline GetFaceSearchResult& WithJobTag(const Aws::String& value) { SetJobTag(value); return *this;} /** *

A job identifier specified in the call to StartFaceSearch and returned in the * job completion notification sent to your Amazon Simple Notification Service * topic.

*/ inline GetFaceSearchResult& WithJobTag(Aws::String&& value) { SetJobTag(std::move(value)); return *this;} /** *

A job identifier specified in the call to StartFaceSearch and returned in the * job completion notification sent to your Amazon Simple Notification Service * topic.

*/ inline GetFaceSearchResult& WithJobTag(const char* value) { SetJobTag(value); return *this;} inline const Aws::String& GetRequestId() const{ return m_requestId; } inline void SetRequestId(const Aws::String& value) { m_requestId = value; } inline void SetRequestId(Aws::String&& value) { m_requestId = std::move(value); } inline void SetRequestId(const char* value) { m_requestId.assign(value); } inline GetFaceSearchResult& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} inline GetFaceSearchResult& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} inline GetFaceSearchResult& WithRequestId(const char* value) { SetRequestId(value); return *this;} private: VideoJobStatus m_jobStatus; Aws::String m_statusMessage; Aws::String m_nextToken; VideoMetadata m_videoMetadata; Aws::Vector m_persons; Aws::String m_jobId; Video m_video; Aws::String m_jobTag; Aws::String m_requestId; }; } // namespace Model } // namespace Rekognition } // namespace Aws