/** * 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 SearchUsersRequest : public RekognitionRequest { public: AWS_REKOGNITION_API SearchUsersRequest(); // 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 "SearchUsers"; } AWS_REKOGNITION_API Aws::String SerializePayload() const override; AWS_REKOGNITION_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The ID of an existing collection containing the UserID, used with a UserId or * FaceId. If a FaceId is provided, UserId isn’t required to be present in the * Collection.

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

The ID of an existing collection containing the UserID, used with a UserId or * FaceId. If a FaceId is provided, UserId isn’t required to be present in the * Collection.

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

The ID of an existing collection containing the UserID, used with a UserId or * FaceId. If a FaceId is provided, UserId isn’t required to be present in the * Collection.

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

The ID of an existing collection containing the UserID, used with a UserId or * FaceId. If a FaceId is provided, UserId isn’t required to be present in the * Collection.

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

The ID of an existing collection containing the UserID, used with a UserId or * FaceId. If a FaceId is provided, UserId isn’t required to be present in the * Collection.

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

The ID of an existing collection containing the UserID, used with a UserId or * FaceId. If a FaceId is provided, UserId isn’t required to be present in the * Collection.

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

The ID of an existing collection containing the UserID, used with a UserId or * FaceId. If a FaceId is provided, UserId isn’t required to be present in the * Collection.

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

The ID of an existing collection containing the UserID, used with a UserId or * FaceId. If a FaceId is provided, UserId isn’t required to be present in the * Collection.

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

ID for the existing User.

*/ inline const Aws::String& GetUserId() const{ return m_userId; } /** *

ID for the existing User.

*/ inline bool UserIdHasBeenSet() const { return m_userIdHasBeenSet; } /** *

ID for the existing User.

*/ inline void SetUserId(const Aws::String& value) { m_userIdHasBeenSet = true; m_userId = value; } /** *

ID for the existing User.

*/ inline void SetUserId(Aws::String&& value) { m_userIdHasBeenSet = true; m_userId = std::move(value); } /** *

ID for the existing User.

*/ inline void SetUserId(const char* value) { m_userIdHasBeenSet = true; m_userId.assign(value); } /** *

ID for the existing User.

*/ inline SearchUsersRequest& WithUserId(const Aws::String& value) { SetUserId(value); return *this;} /** *

ID for the existing User.

*/ inline SearchUsersRequest& WithUserId(Aws::String&& value) { SetUserId(std::move(value)); return *this;} /** *

ID for the existing User.

*/ inline SearchUsersRequest& WithUserId(const char* value) { SetUserId(value); return *this;} /** *

ID for the existing face.

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

ID for the existing face.

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

ID for the existing face.

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

ID for the existing face.

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

ID for the existing face.

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

ID for the existing face.

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

ID for the existing face.

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

ID for the existing face.

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

Optional value that specifies the minimum confidence in the matched UserID to * return. Default value of 80.

*/ inline double GetUserMatchThreshold() const{ return m_userMatchThreshold; } /** *

Optional value that specifies the minimum confidence in the matched UserID to * return. Default value of 80.

*/ inline bool UserMatchThresholdHasBeenSet() const { return m_userMatchThresholdHasBeenSet; } /** *

Optional value that specifies the minimum confidence in the matched UserID to * return. Default value of 80.

*/ inline void SetUserMatchThreshold(double value) { m_userMatchThresholdHasBeenSet = true; m_userMatchThreshold = value; } /** *

Optional value that specifies the minimum confidence in the matched UserID to * return. Default value of 80.

*/ inline SearchUsersRequest& WithUserMatchThreshold(double value) { SetUserMatchThreshold(value); return *this;} /** *

Maximum number of identities to return.

*/ inline int GetMaxUsers() const{ return m_maxUsers; } /** *

Maximum number of identities to return.

*/ inline bool MaxUsersHasBeenSet() const { return m_maxUsersHasBeenSet; } /** *

Maximum number of identities to return.

*/ inline void SetMaxUsers(int value) { m_maxUsersHasBeenSet = true; m_maxUsers = value; } /** *

Maximum number of identities to return.

*/ inline SearchUsersRequest& WithMaxUsers(int value) { SetMaxUsers(value); return *this;} private: Aws::String m_collectionId; bool m_collectionIdHasBeenSet = false; Aws::String m_userId; bool m_userIdHasBeenSet = false; Aws::String m_faceId; bool m_faceIdHasBeenSet = false; double m_userMatchThreshold; bool m_userMatchThresholdHasBeenSet = false; int m_maxUsers; bool m_maxUsersHasBeenSet = false; }; } // namespace Model } // namespace Rekognition } // namespace Aws