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

186 lines
7.5 KiB
C++

/**
* 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/core/utils/memory/stl/AWSString.h>
#include <utility>
namespace Aws
{
namespace Rekognition
{
namespace Model
{
/**
*/
class AWS_REKOGNITION_API GetFaceDetectionRequest : public RekognitionRequest
{
public:
GetFaceDetectionRequest();
// 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 "GetFaceDetection"; }
Aws::String SerializePayload() const override;
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
/**
* <p>Unique identifier for the face detection job. The <code>JobId</code> is
* returned from <code>StartFaceDetection</code>.</p>
*/
inline const Aws::String& GetJobId() const{ return m_jobId; }
/**
* <p>Unique identifier for the face detection job. The <code>JobId</code> is
* returned from <code>StartFaceDetection</code>.</p>
*/
inline bool JobIdHasBeenSet() const { return m_jobIdHasBeenSet; }
/**
* <p>Unique identifier for the face detection job. The <code>JobId</code> is
* returned from <code>StartFaceDetection</code>.</p>
*/
inline void SetJobId(const Aws::String& value) { m_jobIdHasBeenSet = true; m_jobId = value; }
/**
* <p>Unique identifier for the face detection job. The <code>JobId</code> is
* returned from <code>StartFaceDetection</code>.</p>
*/
inline void SetJobId(Aws::String&& value) { m_jobIdHasBeenSet = true; m_jobId = std::move(value); }
/**
* <p>Unique identifier for the face detection job. The <code>JobId</code> is
* returned from <code>StartFaceDetection</code>.</p>
*/
inline void SetJobId(const char* value) { m_jobIdHasBeenSet = true; m_jobId.assign(value); }
/**
* <p>Unique identifier for the face detection job. The <code>JobId</code> is
* returned from <code>StartFaceDetection</code>.</p>
*/
inline GetFaceDetectionRequest& WithJobId(const Aws::String& value) { SetJobId(value); return *this;}
/**
* <p>Unique identifier for the face detection job. The <code>JobId</code> is
* returned from <code>StartFaceDetection</code>.</p>
*/
inline GetFaceDetectionRequest& WithJobId(Aws::String&& value) { SetJobId(std::move(value)); return *this;}
/**
* <p>Unique identifier for the face detection job. The <code>JobId</code> is
* returned from <code>StartFaceDetection</code>.</p>
*/
inline GetFaceDetectionRequest& WithJobId(const char* value) { SetJobId(value); return *this;}
/**
* <p>Maximum number of results to return per paginated call. The largest value you
* can specify is 1000. If you specify a value greater than 1000, a maximum of 1000
* results is returned. The default value is 1000.</p>
*/
inline int GetMaxResults() const{ return m_maxResults; }
/**
* <p>Maximum number of results to return per paginated call. The largest value you
* can specify is 1000. If you specify a value greater than 1000, a maximum of 1000
* results is returned. The default value is 1000.</p>
*/
inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
/**
* <p>Maximum number of results to return per paginated call. The largest value you
* can specify is 1000. If you specify a value greater than 1000, a maximum of 1000
* results is returned. The default value is 1000.</p>
*/
inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
/**
* <p>Maximum number of results to return per paginated call. The largest value you
* can specify is 1000. If you specify a value greater than 1000, a maximum of 1000
* results is returned. The default value is 1000.</p>
*/
inline GetFaceDetectionRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;}
/**
* <p>If the previous response was incomplete (because there are more faces to
* retrieve), Amazon Rekognition Video returns a pagination token in the response.
* You can use this pagination token to retrieve the next set of faces.</p>
*/
inline const Aws::String& GetNextToken() const{ return m_nextToken; }
/**
* <p>If the previous response was incomplete (because there are more faces to
* retrieve), Amazon Rekognition Video returns a pagination token in the response.
* You can use this pagination token to retrieve the next set of faces.</p>
*/
inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
/**
* <p>If the previous response was incomplete (because there are more faces to
* retrieve), Amazon Rekognition Video returns a pagination token in the response.
* You can use this pagination token to retrieve the next set of faces.</p>
*/
inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
/**
* <p>If the previous response was incomplete (because there are more faces to
* retrieve), Amazon Rekognition Video returns a pagination token in the response.
* You can use this pagination token to retrieve the next set of faces.</p>
*/
inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
/**
* <p>If the previous response was incomplete (because there are more faces to
* retrieve), Amazon Rekognition Video returns a pagination token in the response.
* You can use this pagination token to retrieve the next set of faces.</p>
*/
inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
/**
* <p>If the previous response was incomplete (because there are more faces to
* retrieve), Amazon Rekognition Video returns a pagination token in the response.
* You can use this pagination token to retrieve the next set of faces.</p>
*/
inline GetFaceDetectionRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
/**
* <p>If the previous response was incomplete (because there are more faces to
* retrieve), Amazon Rekognition Video returns a pagination token in the response.
* You can use this pagination token to retrieve the next set of faces.</p>
*/
inline GetFaceDetectionRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
/**
* <p>If the previous response was incomplete (because there are more faces to
* retrieve), Amazon Rekognition Video returns a pagination token in the response.
* You can use this pagination token to retrieve the next set of faces.</p>
*/
inline GetFaceDetectionRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
private:
Aws::String m_jobId;
bool m_jobIdHasBeenSet;
int m_maxResults;
bool m_maxResultsHasBeenSet;
Aws::String m_nextToken;
bool m_nextTokenHasBeenSet;
};
} // namespace Model
} // namespace Rekognition
} // namespace Aws