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/DetectTextRequest.h

141 lines
5.8 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/rekognition/model/DetectTextFilters.h>
#include <utility>
namespace Aws
{
namespace Rekognition
{
namespace Model
{
/**
*/
class AWS_REKOGNITION_API DetectTextRequest : public RekognitionRequest
{
public:
DetectTextRequest();
// 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 "DetectText"; }
Aws::String SerializePayload() const override;
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
/**
* <p>The input image as base64-encoded bytes or an Amazon S3 object. If you use
* the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.
* </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 Amazon S3 object. If you use
* the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.
* </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 Amazon S3 object. If you use
* the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.
* </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 Amazon S3 object. If you use
* the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.
* </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 Amazon S3 object. If you use
* the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.
* </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 DetectTextRequest& WithImage(const Image& value) { SetImage(value); return *this;}
/**
* <p>The input image as base64-encoded bytes or an Amazon S3 object. If you use
* the AWS CLI to call Amazon Rekognition operations, you can't pass image bytes.
* </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 DetectTextRequest& WithImage(Image&& value) { SetImage(std::move(value)); return *this;}
/**
* <p>Optional parameters that let you set the criteria that the text must meet to
* be included in your response.</p>
*/
inline const DetectTextFilters& GetFilters() const{ return m_filters; }
/**
* <p>Optional parameters that let you set the criteria that the text must meet to
* be included in your response.</p>
*/
inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; }
/**
* <p>Optional parameters that let you set the criteria that the text must meet to
* be included in your response.</p>
*/
inline void SetFilters(const DetectTextFilters& value) { m_filtersHasBeenSet = true; m_filters = value; }
/**
* <p>Optional parameters that let you set the criteria that the text must meet to
* be included in your response.</p>
*/
inline void SetFilters(DetectTextFilters&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); }
/**
* <p>Optional parameters that let you set the criteria that the text must meet to
* be included in your response.</p>
*/
inline DetectTextRequest& WithFilters(const DetectTextFilters& value) { SetFilters(value); return *this;}
/**
* <p>Optional parameters that let you set the criteria that the text must meet to
* be included in your response.</p>
*/
inline DetectTextRequest& WithFilters(DetectTextFilters&& value) { SetFilters(std::move(value)); return *this;}
private:
Image m_image;
bool m_imageHasBeenSet;
DetectTextFilters m_filters;
bool m_filtersHasBeenSet;
};
} // namespace Model
} // namespace Rekognition
} // namespace Aws