/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace Rekognition { namespace Model { /** */ class SearchFacesRequest : public RekognitionRequest { public: AWS_REKOGNITION_API SearchFacesRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "SearchFaces"; } AWS_REKOGNITION_API Aws::String SerializePayload() const override; AWS_REKOGNITION_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

ID of the collection the face belongs to.

*/ inline const Aws::String& GetCollectionId() const{ return m_collectionId; } /** *

ID of the collection the face belongs to.

*/ inline bool CollectionIdHasBeenSet() const { return m_collectionIdHasBeenSet; } /** *

ID of the collection the face belongs to.

*/ inline void SetCollectionId(const Aws::String& value) { m_collectionIdHasBeenSet = true; m_collectionId = value; } /** *

ID of the collection the face belongs to.

*/ inline void SetCollectionId(Aws::String&& value) { m_collectionIdHasBeenSet = true; m_collectionId = std::move(value); } /** *

ID of the collection the face belongs to.

*/ inline void SetCollectionId(const char* value) { m_collectionIdHasBeenSet = true; m_collectionId.assign(value); } /** *

ID of the collection the face belongs to.

*/ inline SearchFacesRequest& WithCollectionId(const Aws::String& value) { SetCollectionId(value); return *this;} /** *

ID of the collection the face belongs to.

*/ inline SearchFacesRequest& WithCollectionId(Aws::String&& value) { SetCollectionId(std::move(value)); return *this;} /** *

ID of the collection the face belongs to.

*/ inline SearchFacesRequest& WithCollectionId(const char* value) { SetCollectionId(value); return *this;} /** *

ID of a face to find matches for in the collection.

*/ inline const Aws::String& GetFaceId() const{ return m_faceId; } /** *

ID of a face to find matches for in the collection.

*/ inline bool FaceIdHasBeenSet() const { return m_faceIdHasBeenSet; } /** *

ID of a face to find matches for in the collection.

*/ inline void SetFaceId(const Aws::String& value) { m_faceIdHasBeenSet = true; m_faceId = value; } /** *

ID of a face to find matches for in the collection.

*/ inline void SetFaceId(Aws::String&& value) { m_faceIdHasBeenSet = true; m_faceId = std::move(value); } /** *

ID of a face to find matches for in the collection.

*/ inline void SetFaceId(const char* value) { m_faceIdHasBeenSet = true; m_faceId.assign(value); } /** *

ID of a face to find matches for in the collection.

*/ inline SearchFacesRequest& WithFaceId(const Aws::String& value) { SetFaceId(value); return *this;} /** *

ID of a face to find matches for in the collection.

*/ inline SearchFacesRequest& WithFaceId(Aws::String&& value) { SetFaceId(std::move(value)); return *this;} /** *

ID of a face to find matches for in the collection.

*/ inline SearchFacesRequest& WithFaceId(const char* value) { SetFaceId(value); return *this;} /** *

Maximum number of faces to return. The operation returns the maximum number * of faces with the highest confidence in the match.

*/ inline int GetMaxFaces() const{ return m_maxFaces; } /** *

Maximum number of faces to return. The operation returns the maximum number * of faces with the highest confidence in the match.

*/ inline bool MaxFacesHasBeenSet() const { return m_maxFacesHasBeenSet; } /** *

Maximum number of faces to return. The operation returns the maximum number * of faces with the highest confidence in the match.

*/ inline void SetMaxFaces(int value) { m_maxFacesHasBeenSet = true; m_maxFaces = value; } /** *

Maximum number of faces to return. The operation returns the maximum number * of faces with the highest confidence in the match.

*/ inline SearchFacesRequest& WithMaxFaces(int value) { SetMaxFaces(value); return *this;} /** *

Optional value specifying the minimum confidence in the face match to return. * For example, don't return any matches where confidence in matches is less than * 70%. The default value is 80%.

*/ inline double GetFaceMatchThreshold() const{ return m_faceMatchThreshold; } /** *

Optional value specifying the minimum confidence in the face match to return. * For example, don't return any matches where confidence in matches is less than * 70%. The default value is 80%.

*/ inline bool FaceMatchThresholdHasBeenSet() const { return m_faceMatchThresholdHasBeenSet; } /** *

Optional value specifying the minimum confidence in the face match to return. * For example, don't return any matches where confidence in matches is less than * 70%. The default value is 80%.

*/ inline void SetFaceMatchThreshold(double value) { m_faceMatchThresholdHasBeenSet = true; m_faceMatchThreshold = value; } /** *

Optional value specifying the minimum confidence in the face match to return. * For example, don't return any matches where confidence in matches is less than * 70%. The default value is 80%.

*/ inline SearchFacesRequest& WithFaceMatchThreshold(double value) { SetFaceMatchThreshold(value); return *this;} private: Aws::String m_collectionId; bool m_collectionIdHasBeenSet = false; Aws::String m_faceId; bool m_faceIdHasBeenSet = false; int m_maxFaces; bool m_maxFacesHasBeenSet = false; double m_faceMatchThreshold; bool m_faceMatchThresholdHasBeenSet = false; }; } // namespace Model } // namespace Rekognition } // namespace Aws