This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-rekognition/include/aws/rekognition/model/DetectFacesRequest.h

224 lines
12 KiB
C
Raw Normal View History

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/rekognition/Rekognition_EXPORTS.h>
#include <aws/rekognition/RekognitionRequest.h>
#include <aws/rekognition/model/Image.h>
#include <aws/core/utils/memory/stl/AWSVector.h>
#include <aws/rekognition/model/Attribute.h>
#include <utility>
namespace Aws
{
namespace Rekognition
{
namespace Model
{
/**
*/
class AWS_REKOGNITION_API DetectFacesRequest : public RekognitionRequest
{
public:
DetectFacesRequest();
// 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 "DetectFaces"; }
Aws::String SerializePayload() const override;
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
/**
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS
* CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is
* not supported. </p> <p>If you are using an AWS SDK to call Amazon Rekognition,
* you might not need to base64-encode image bytes passed using the
* <code>Bytes</code> field. For more information, see Images in the Amazon
* Rekognition developer guide.</p>
*/
inline const Image& GetImage() const{ return m_image; }
/**
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS
* CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is
* not supported. </p> <p>If you are using an AWS SDK to call Amazon Rekognition,
* you might not need to base64-encode image bytes passed using the
* <code>Bytes</code> field. For more information, see Images in the Amazon
* Rekognition developer guide.</p>
*/
inline bool ImageHasBeenSet() const { return m_imageHasBeenSet; }
/**
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS
* CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is
* not supported. </p> <p>If you are using an AWS SDK to call Amazon Rekognition,
* you might not need to base64-encode image bytes passed using the
* <code>Bytes</code> field. For more information, see Images in the Amazon
* Rekognition developer guide.</p>
*/
inline void SetImage(const Image& value) { m_imageHasBeenSet = true; m_image = value; }
/**
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS
* CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is
* not supported. </p> <p>If you are using an AWS SDK to call Amazon Rekognition,
* you might not need to base64-encode image bytes passed using the
* <code>Bytes</code> field. For more information, see Images in the Amazon
* Rekognition developer guide.</p>
*/
inline void SetImage(Image&& value) { m_imageHasBeenSet = true; m_image = std::move(value); }
/**
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS
* CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is
* not supported. </p> <p>If you are using an AWS SDK to call Amazon Rekognition,
* you might not need to base64-encode image bytes passed using the
* <code>Bytes</code> field. For more information, see Images in the Amazon
* Rekognition developer guide.</p>
*/
inline DetectFacesRequest& WithImage(const Image& value) { SetImage(value); return *this;}
/**
* <p>The input image as base64-encoded bytes or an S3 object. If you use the AWS
* CLI to call Amazon Rekognition operations, passing base64-encoded image bytes is
* not supported. </p> <p>If you are using an AWS SDK to call Amazon Rekognition,
* you might not need to base64-encode image bytes passed using the
* <code>Bytes</code> field. For more information, see Images in the Amazon
* Rekognition developer guide.</p>
*/
inline DetectFacesRequest& WithImage(Image&& value) { SetImage(std::move(value)); return *this;}
/**
* <p>An array of facial attributes you want to be returned. This can be the
* default list of attributes or all attributes. If you don't specify a value for
* <code>Attributes</code> or if you specify <code>["DEFAULT"]</code>, the API
* returns the following subset of facial attributes: <code>BoundingBox</code>,
* <code>Confidence</code>, <code>Pose</code>, <code>Quality</code>, and
* <code>Landmarks</code>. If you provide <code>["ALL"]</code>, all facial
* attributes are returned, but the operation takes longer to complete.</p> <p>If
* you provide both, <code>["ALL", "DEFAULT"]</code>, the service uses a logical
* AND operator to determine which attributes to return (in this case, all
* attributes). </p>
*/
inline const Aws::Vector<Attribute>& GetAttributes() const{ return m_attributes; }
/**
* <p>An array of facial attributes you want to be returned. This can be the
* default list of attributes or all attributes. If you don't specify a value for
* <code>Attributes</code> or if you specify <code>["DEFAULT"]</code>, the API
* returns the following subset of facial attributes: <code>BoundingBox</code>,
* <code>Confidence</code>, <code>Pose</code>, <code>Quality</code>, and
* <code>Landmarks</code>. If you provide <code>["ALL"]</code>, all facial
* attributes are returned, but the operation takes longer to complete.</p> <p>If
* you provide both, <code>["ALL", "DEFAULT"]</code>, the service uses a logical
* AND operator to determine which attributes to return (in this case, all
* attributes). </p>
*/
inline bool AttributesHasBeenSet() const { return m_attributesHasBeenSet; }
/**
* <p>An array of facial attributes you want to be returned. This can be the
* default list of attributes or all attributes. If you don't specify a value for
* <code>Attributes</code> or if you specify <code>["DEFAULT"]</code>, the API
* returns the following subset of facial attributes: <code>BoundingBox</code>,
* <code>Confidence</code>, <code>Pose</code>, <code>Quality</code>, and
* <code>Landmarks</code>. If you provide <code>["ALL"]</code>, all facial
* attributes are returned, but the operation takes longer to complete.</p> <p>If
* you provide both, <code>["ALL", "DEFAULT"]</code>, the service uses a logical
* AND operator to determine which attributes to return (in this case, all
* attributes). </p>
*/
inline void SetAttributes(const Aws::Vector<Attribute>& value) { m_attributesHasBeenSet = true; m_attributes = value; }
/**
* <p>An array of facial attributes you want to be returned. This can be the
* default list of attributes or all attributes. If you don't specify a value for
* <code>Attributes</code> or if you specify <code>["DEFAULT"]</code>, the API
* returns the following subset of facial attributes: <code>BoundingBox</code>,
* <code>Confidence</code>, <code>Pose</code>, <code>Quality</code>, and
* <code>Landmarks</code>. If you provide <code>["ALL"]</code>, all facial
* attributes are returned, but the operation takes longer to complete.</p> <p>If
* you provide both, <code>["ALL", "DEFAULT"]</code>, the service uses a logical
* AND operator to determine which attributes to return (in this case, all
* attributes). </p>
*/
inline void SetAttributes(Aws::Vector<Attribute>&& value) { m_attributesHasBeenSet = true; m_attributes = std::move(value); }
/**
* <p>An array of facial attributes you want to be returned. This can be the
* default list of attributes or all attributes. If you don't specify a value for
* <code>Attributes</code> or if you specify <code>["DEFAULT"]</code>, the API
* returns the following subset of facial attributes: <code>BoundingBox</code>,
* <code>Confidence</code>, <code>Pose</code>, <code>Quality</code>, and
* <code>Landmarks</code>. If you provide <code>["ALL"]</code>, all facial
* attributes are returned, but the operation takes longer to complete.</p> <p>If
* you provide both, <code>["ALL", "DEFAULT"]</code>, the service uses a logical
* AND operator to determine which attributes to return (in this case, all
* attributes). </p>
*/
inline DetectFacesRequest& WithAttributes(const Aws::Vector<Attribute>& value) { SetAttributes(value); return *this;}
/**
* <p>An array of facial attributes you want to be returned. This can be the
* default list of attributes or all attributes. If you don't specify a value for
* <code>Attributes</code> or if you specify <code>["DEFAULT"]</code>, the API
* returns the following subset of facial attributes: <code>BoundingBox</code>,
* <code>Confidence</code>, <code>Pose</code>, <code>Quality</code>, and
* <code>Landmarks</code>. If you provide <code>["ALL"]</code>, all facial
* attributes are returned, but the operation takes longer to complete.</p> <p>If
* you provide both, <code>["ALL", "DEFAULT"]</code>, the service uses a logical
* AND operator to determine which attributes to return (in this case, all
* attributes). </p>
*/
inline DetectFacesRequest& WithAttributes(Aws::Vector<Attribute>&& value) { SetAttributes(std::move(value)); return *this;}
/**
* <p>An array of facial attributes you want to be returned. This can be the
* default list of attributes or all attributes. If you don't specify a value for
* <code>Attributes</code> or if you specify <code>["DEFAULT"]</code>, the API
* returns the following subset of facial attributes: <code>BoundingBox</code>,
* <code>Confidence</code>, <code>Pose</code>, <code>Quality</code>, and
* <code>Landmarks</code>. If you provide <code>["ALL"]</code>, all facial
* attributes are returned, but the operation takes longer to complete.</p> <p>If
* you provide both, <code>["ALL", "DEFAULT"]</code>, the service uses a logical
* AND operator to determine which attributes to return (in this case, all
* attributes). </p>
*/
inline DetectFacesRequest& AddAttributes(const Attribute& value) { m_attributesHasBeenSet = true; m_attributes.push_back(value); return *this; }
/**
* <p>An array of facial attributes you want to be returned. This can be the
* default list of attributes or all attributes. If you don't specify a value for
* <code>Attributes</code> or if you specify <code>["DEFAULT"]</code>, the API
* returns the following subset of facial attributes: <code>BoundingBox</code>,
* <code>Confidence</code>, <code>Pose</code>, <code>Quality</code>, and
* <code>Landmarks</code>. If you provide <code>["ALL"]</code>, all facial
* attributes are returned, but the operation takes longer to complete.</p> <p>If
* you provide both, <code>["ALL", "DEFAULT"]</code>, the service uses a logical
* AND operator to determine which attributes to return (in this case, all
* attributes). </p>
*/
inline DetectFacesRequest& AddAttributes(Attribute&& value) { m_attributesHasBeenSet = true; m_attributes.push_back(std::move(value)); return *this; }
private:
Image m_image;
bool m_imageHasBeenSet;
Aws::Vector<Attribute> m_attributes;
bool m_attributesHasBeenSet;
};
} // namespace Model
} // namespace Rekognition
} // namespace Aws