AWS SDK for C++

AWS SDK for C++ Version 1.11.440

Loading...
Searching...
No Matches
StartDocumentAnalysisRequest.h
1
6#pragma once
7#include <aws/textract/Textract_EXPORTS.h>
8#include <aws/textract/TextractRequest.h>
9#include <aws/textract/model/DocumentLocation.h>
10#include <aws/core/utils/memory/stl/AWSVector.h>
11#include <aws/core/utils/memory/stl/AWSString.h>
12#include <aws/textract/model/NotificationChannel.h>
13#include <aws/textract/model/OutputConfig.h>
14#include <aws/textract/model/QueriesConfig.h>
15#include <aws/textract/model/AdaptersConfig.h>
16#include <aws/textract/model/FeatureType.h>
17#include <utility>
18
19namespace Aws
20{
21namespace Textract
22{
23namespace Model
24{
25
29 {
30 public:
31 AWS_TEXTRACT_API StartDocumentAnalysisRequest();
32
33 // Service request name is the Operation name which will send this request out,
34 // each operation should has unique request name, so that we can get operation's name from this request.
35 // Note: this is not true for response, multiple operations may have the same response name,
36 // so we can not get operation's name from response.
37 inline virtual const char* GetServiceRequestName() const override { return "StartDocumentAnalysis"; }
38
39 AWS_TEXTRACT_API Aws::String SerializePayload() const override;
40
42
43
45
48 inline const DocumentLocation& GetDocumentLocation() const{ return m_documentLocation; }
49 inline bool DocumentLocationHasBeenSet() const { return m_documentLocationHasBeenSet; }
50 inline void SetDocumentLocation(const DocumentLocation& value) { m_documentLocationHasBeenSet = true; m_documentLocation = value; }
51 inline void SetDocumentLocation(DocumentLocation&& value) { m_documentLocationHasBeenSet = true; m_documentLocation = std::move(value); }
55
57
65 inline const Aws::Vector<FeatureType>& GetFeatureTypes() const{ return m_featureTypes; }
66 inline bool FeatureTypesHasBeenSet() const { return m_featureTypesHasBeenSet; }
67 inline void SetFeatureTypes(const Aws::Vector<FeatureType>& value) { m_featureTypesHasBeenSet = true; m_featureTypes = value; }
68 inline void SetFeatureTypes(Aws::Vector<FeatureType>&& value) { m_featureTypesHasBeenSet = true; m_featureTypes = std::move(value); }
71 inline StartDocumentAnalysisRequest& AddFeatureTypes(const FeatureType& value) { m_featureTypesHasBeenSet = true; m_featureTypes.push_back(value); return *this; }
72 inline StartDocumentAnalysisRequest& AddFeatureTypes(FeatureType&& value) { m_featureTypesHasBeenSet = true; m_featureTypes.push_back(std::move(value)); return *this; }
74
76
85 inline const Aws::String& GetClientRequestToken() const{ return m_clientRequestToken; }
86 inline bool ClientRequestTokenHasBeenSet() const { return m_clientRequestTokenHasBeenSet; }
87 inline void SetClientRequestToken(const Aws::String& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = value; }
88 inline void SetClientRequestToken(Aws::String&& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = std::move(value); }
89 inline void SetClientRequestToken(const char* value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken.assign(value); }
91 inline StartDocumentAnalysisRequest& WithClientRequestToken(Aws::String&& value) { SetClientRequestToken(std::move(value)); return *this;}
92 inline StartDocumentAnalysisRequest& WithClientRequestToken(const char* value) { SetClientRequestToken(value); return *this;}
94
96
102 inline const Aws::String& GetJobTag() const{ return m_jobTag; }
103 inline bool JobTagHasBeenSet() const { return m_jobTagHasBeenSet; }
104 inline void SetJobTag(const Aws::String& value) { m_jobTagHasBeenSet = true; m_jobTag = value; }
105 inline void SetJobTag(Aws::String&& value) { m_jobTagHasBeenSet = true; m_jobTag = std::move(value); }
106 inline void SetJobTag(const char* value) { m_jobTagHasBeenSet = true; m_jobTag.assign(value); }
107 inline StartDocumentAnalysisRequest& WithJobTag(const Aws::String& value) { SetJobTag(value); return *this;}
108 inline StartDocumentAnalysisRequest& WithJobTag(Aws::String&& value) { SetJobTag(std::move(value)); return *this;}
109 inline StartDocumentAnalysisRequest& WithJobTag(const char* value) { SetJobTag(value); return *this;}
111
113
117 inline const NotificationChannel& GetNotificationChannel() const{ return m_notificationChannel; }
118 inline bool NotificationChannelHasBeenSet() const { return m_notificationChannelHasBeenSet; }
119 inline void SetNotificationChannel(const NotificationChannel& value) { m_notificationChannelHasBeenSet = true; m_notificationChannel = value; }
120 inline void SetNotificationChannel(NotificationChannel&& value) { m_notificationChannelHasBeenSet = true; m_notificationChannel = std::move(value); }
124
126
131 inline const OutputConfig& GetOutputConfig() const{ return m_outputConfig; }
132 inline bool OutputConfigHasBeenSet() const { return m_outputConfigHasBeenSet; }
133 inline void SetOutputConfig(const OutputConfig& value) { m_outputConfigHasBeenSet = true; m_outputConfig = value; }
134 inline void SetOutputConfig(OutputConfig&& value) { m_outputConfigHasBeenSet = true; m_outputConfig = std::move(value); }
135 inline StartDocumentAnalysisRequest& WithOutputConfig(const OutputConfig& value) { SetOutputConfig(value); return *this;}
136 inline StartDocumentAnalysisRequest& WithOutputConfig(OutputConfig&& value) { SetOutputConfig(std::move(value)); return *this;}
138
140
147 inline const Aws::String& GetKMSKeyId() const{ return m_kMSKeyId; }
148 inline bool KMSKeyIdHasBeenSet() const { return m_kMSKeyIdHasBeenSet; }
149 inline void SetKMSKeyId(const Aws::String& value) { m_kMSKeyIdHasBeenSet = true; m_kMSKeyId = value; }
150 inline void SetKMSKeyId(Aws::String&& value) { m_kMSKeyIdHasBeenSet = true; m_kMSKeyId = std::move(value); }
151 inline void SetKMSKeyId(const char* value) { m_kMSKeyIdHasBeenSet = true; m_kMSKeyId.assign(value); }
152 inline StartDocumentAnalysisRequest& WithKMSKeyId(const Aws::String& value) { SetKMSKeyId(value); return *this;}
153 inline StartDocumentAnalysisRequest& WithKMSKeyId(Aws::String&& value) { SetKMSKeyId(std::move(value)); return *this;}
154 inline StartDocumentAnalysisRequest& WithKMSKeyId(const char* value) { SetKMSKeyId(value); return *this;}
156
158
159 inline const QueriesConfig& GetQueriesConfig() const{ return m_queriesConfig; }
160 inline bool QueriesConfigHasBeenSet() const { return m_queriesConfigHasBeenSet; }
161 inline void SetQueriesConfig(const QueriesConfig& value) { m_queriesConfigHasBeenSet = true; m_queriesConfig = value; }
162 inline void SetQueriesConfig(QueriesConfig&& value) { m_queriesConfigHasBeenSet = true; m_queriesConfig = std::move(value); }
164 inline StartDocumentAnalysisRequest& WithQueriesConfig(QueriesConfig&& value) { SetQueriesConfig(std::move(value)); return *this;}
166
168
171 inline const AdaptersConfig& GetAdaptersConfig() const{ return m_adaptersConfig; }
172 inline bool AdaptersConfigHasBeenSet() const { return m_adaptersConfigHasBeenSet; }
173 inline void SetAdaptersConfig(const AdaptersConfig& value) { m_adaptersConfigHasBeenSet = true; m_adaptersConfig = value; }
174 inline void SetAdaptersConfig(AdaptersConfig&& value) { m_adaptersConfigHasBeenSet = true; m_adaptersConfig = std::move(value); }
176 inline StartDocumentAnalysisRequest& WithAdaptersConfig(AdaptersConfig&& value) { SetAdaptersConfig(std::move(value)); return *this;}
178 private:
179
180 DocumentLocation m_documentLocation;
181 bool m_documentLocationHasBeenSet = false;
182
183 Aws::Vector<FeatureType> m_featureTypes;
184 bool m_featureTypesHasBeenSet = false;
185
186 Aws::String m_clientRequestToken;
187 bool m_clientRequestTokenHasBeenSet = false;
188
189 Aws::String m_jobTag;
190 bool m_jobTagHasBeenSet = false;
191
192 NotificationChannel m_notificationChannel;
193 bool m_notificationChannelHasBeenSet = false;
194
195 OutputConfig m_outputConfig;
196 bool m_outputConfigHasBeenSet = false;
197
198 Aws::String m_kMSKeyId;
199 bool m_kMSKeyIdHasBeenSet = false;
200
201 QueriesConfig m_queriesConfig;
202 bool m_queriesConfigHasBeenSet = false;
203
204 AdaptersConfig m_adaptersConfig;
205 bool m_adaptersConfigHasBeenSet = false;
206 };
207
208} // namespace Model
209} // namespace Textract
210} // namespace Aws
StartDocumentAnalysisRequest & AddFeatureTypes(FeatureType &&value)
StartDocumentAnalysisRequest & WithAdaptersConfig(const AdaptersConfig &value)
StartDocumentAnalysisRequest & WithOutputConfig(OutputConfig &&value)
StartDocumentAnalysisRequest & WithClientRequestToken(const char *value)
StartDocumentAnalysisRequest & WithQueriesConfig(const QueriesConfig &value)
StartDocumentAnalysisRequest & WithJobTag(Aws::String &&value)
StartDocumentAnalysisRequest & WithClientRequestToken(Aws::String &&value)
StartDocumentAnalysisRequest & WithQueriesConfig(QueriesConfig &&value)
StartDocumentAnalysisRequest & WithKMSKeyId(Aws::String &&value)
void SetFeatureTypes(const Aws::Vector< FeatureType > &value)
StartDocumentAnalysisRequest & WithClientRequestToken(const Aws::String &value)
AWS_TEXTRACT_API Aws::String SerializePayload() const override
const Aws::Vector< FeatureType > & GetFeatureTypes() const
StartDocumentAnalysisRequest & WithNotificationChannel(const NotificationChannel &value)
StartDocumentAnalysisRequest & AddFeatureTypes(const FeatureType &value)
void SetNotificationChannel(const NotificationChannel &value)
StartDocumentAnalysisRequest & WithAdaptersConfig(AdaptersConfig &&value)
StartDocumentAnalysisRequest & WithFeatureTypes(const Aws::Vector< FeatureType > &value)
StartDocumentAnalysisRequest & WithJobTag(const char *value)
StartDocumentAnalysisRequest & WithOutputConfig(const OutputConfig &value)
AWS_TEXTRACT_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
StartDocumentAnalysisRequest & WithFeatureTypes(Aws::Vector< FeatureType > &&value)
StartDocumentAnalysisRequest & WithDocumentLocation(const DocumentLocation &value)
StartDocumentAnalysisRequest & WithDocumentLocation(DocumentLocation &&value)
StartDocumentAnalysisRequest & WithJobTag(const Aws::String &value)
StartDocumentAnalysisRequest & WithNotificationChannel(NotificationChannel &&value)
StartDocumentAnalysisRequest & WithKMSKeyId(const Aws::String &value)
void SetFeatureTypes(Aws::Vector< FeatureType > &&value)
StartDocumentAnalysisRequest & WithKMSKeyId(const char *value)
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector