/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Rekognition { namespace Model { /** */ class ListFacesRequest : public RekognitionRequest { public: AWS_REKOGNITION_API ListFacesRequest(); // 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 "ListFaces"; } AWS_REKOGNITION_API Aws::String SerializePayload() const override; AWS_REKOGNITION_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

ID of the collection from which to list the faces.

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

ID of the collection from which to list the faces.

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

ID of the collection from which to list the faces.

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

ID of the collection from which to list the faces.

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

ID of the collection from which to list the faces.

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

ID of the collection from which to list the faces.

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

ID of the collection from which to list the faces.

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

ID of the collection from which to list the faces.

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

If the previous response was incomplete (because there is more data to * retrieve), Amazon Rekognition returns a pagination token in the response. You * can use this pagination token to retrieve the next set of faces.

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

If the previous response was incomplete (because there is more data to * retrieve), Amazon Rekognition returns a pagination token in the response. You * can use this pagination token to retrieve the next set of faces.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

If the previous response was incomplete (because there is more data to * retrieve), Amazon Rekognition returns a pagination token in the response. You * can use this pagination token to retrieve the next set of faces.

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

If the previous response was incomplete (because there is more data to * retrieve), Amazon Rekognition returns a pagination token in the response. You * can use this pagination token to retrieve the next set of faces.

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

If the previous response was incomplete (because there is more data to * retrieve), Amazon Rekognition returns a pagination token in the response. You * can use this pagination token to retrieve the next set of faces.

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

If the previous response was incomplete (because there is more data to * retrieve), Amazon Rekognition returns a pagination token in the response. You * can use this pagination token to retrieve the next set of faces.

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

If the previous response was incomplete (because there is more data to * retrieve), Amazon Rekognition returns a pagination token in the response. You * can use this pagination token to retrieve the next set of faces.

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

If the previous response was incomplete (because there is more data to * retrieve), Amazon Rekognition returns a pagination token in the response. You * can use this pagination token to retrieve the next set of faces.

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

Maximum number of faces to return.

*/ inline int GetMaxResults() const{ return m_maxResults; } /** *

Maximum number of faces to return.

*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** *

Maximum number of faces to return.

*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** *

Maximum number of faces to return.

*/ inline ListFacesRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** *

An array of user IDs to match when listing faces in a collection.

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

An array of user IDs to match when listing faces in a collection.

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

An array of user IDs to match when listing faces in a collection.

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

An array of user IDs to match when listing faces in a collection.

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

An array of user IDs to match when listing faces in a collection.

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

An array of user IDs to match when listing faces in a collection.

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

An array of user IDs to match when listing faces in a collection.

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

An array of user IDs to match when listing faces in a collection.

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

An array of face IDs to match when listing faces in a collection.

*/ inline const Aws::Vector& GetFaceIds() const{ return m_faceIds; } /** *

An array of face IDs to match when listing faces in a collection.

*/ inline bool FaceIdsHasBeenSet() const { return m_faceIdsHasBeenSet; } /** *

An array of face IDs to match when listing faces in a collection.

*/ inline void SetFaceIds(const Aws::Vector& value) { m_faceIdsHasBeenSet = true; m_faceIds = value; } /** *

An array of face IDs to match when listing faces in a collection.

*/ inline void SetFaceIds(Aws::Vector&& value) { m_faceIdsHasBeenSet = true; m_faceIds = std::move(value); } /** *

An array of face IDs to match when listing faces in a collection.

*/ inline ListFacesRequest& WithFaceIds(const Aws::Vector& value) { SetFaceIds(value); return *this;} /** *

An array of face IDs to match when listing faces in a collection.

*/ inline ListFacesRequest& WithFaceIds(Aws::Vector&& value) { SetFaceIds(std::move(value)); return *this;} /** *

An array of face IDs to match when listing faces in a collection.

*/ inline ListFacesRequest& AddFaceIds(const Aws::String& value) { m_faceIdsHasBeenSet = true; m_faceIds.push_back(value); return *this; } /** *

An array of face IDs to match when listing faces in a collection.

*/ inline ListFacesRequest& AddFaceIds(Aws::String&& value) { m_faceIdsHasBeenSet = true; m_faceIds.push_back(std::move(value)); return *this; } /** *

An array of face IDs to match when listing faces in a collection.

*/ inline ListFacesRequest& AddFaceIds(const char* value) { m_faceIdsHasBeenSet = true; m_faceIds.push_back(value); return *this; } private: Aws::String m_collectionId; bool m_collectionIdHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_userId; bool m_userIdHasBeenSet = false; Aws::Vector m_faceIds; bool m_faceIdsHasBeenSet = false; }; } // namespace Model } // namespace Rekognition } // namespace Aws