AWS SDK for C++  1.8.126
AWS SDK for C++
StartPiiEntitiesDetectionJobRequest.h
Go to the documentation of this file.
1 
6 #pragma once
15 #include <utility>
16 #include <aws/core/utils/UUID.h>
17 
18 namespace Aws
19 {
20 namespace Comprehend
21 {
22 namespace Model
23 {
24 
28  {
29  public:
31 
32  // Service request name is the Operation name which will send this request out,
33  // each operation should has unique request name, so that we can get operation's name from this request.
34  // Note: this is not true for response, multiple operations may have the same response name,
35  // so we can not get operation's name from response.
36  inline virtual const char* GetServiceRequestName() const override { return "StartPiiEntitiesDetectionJob"; }
37 
38  Aws::String SerializePayload() const override;
39 
41 
42 
46  inline const InputDataConfig& GetInputDataConfig() const{ return m_inputDataConfig; }
47 
51  inline bool InputDataConfigHasBeenSet() const { return m_inputDataConfigHasBeenSet; }
52 
56  inline void SetInputDataConfig(const InputDataConfig& value) { m_inputDataConfigHasBeenSet = true; m_inputDataConfig = value; }
57 
61  inline void SetInputDataConfig(InputDataConfig&& value) { m_inputDataConfigHasBeenSet = true; m_inputDataConfig = std::move(value); }
62 
66  inline StartPiiEntitiesDetectionJobRequest& WithInputDataConfig(const InputDataConfig& value) { SetInputDataConfig(value); return *this;}
67 
71  inline StartPiiEntitiesDetectionJobRequest& WithInputDataConfig(InputDataConfig&& value) { SetInputDataConfig(std::move(value)); return *this;}
72 
73 
78  inline const OutputDataConfig& GetOutputDataConfig() const{ return m_outputDataConfig; }
79 
84  inline bool OutputDataConfigHasBeenSet() const { return m_outputDataConfigHasBeenSet; }
85 
90  inline void SetOutputDataConfig(const OutputDataConfig& value) { m_outputDataConfigHasBeenSet = true; m_outputDataConfig = value; }
91 
96  inline void SetOutputDataConfig(OutputDataConfig&& value) { m_outputDataConfigHasBeenSet = true; m_outputDataConfig = std::move(value); }
97 
102  inline StartPiiEntitiesDetectionJobRequest& WithOutputDataConfig(const OutputDataConfig& value) { SetOutputDataConfig(value); return *this;}
103 
108  inline StartPiiEntitiesDetectionJobRequest& WithOutputDataConfig(OutputDataConfig&& value) { SetOutputDataConfig(std::move(value)); return *this;}
109 
110 
115  inline const PiiEntitiesDetectionMode& GetMode() const{ return m_mode; }
116 
121  inline bool ModeHasBeenSet() const { return m_modeHasBeenSet; }
122 
127  inline void SetMode(const PiiEntitiesDetectionMode& value) { m_modeHasBeenSet = true; m_mode = value; }
128 
133  inline void SetMode(PiiEntitiesDetectionMode&& value) { m_modeHasBeenSet = true; m_mode = std::move(value); }
134 
139  inline StartPiiEntitiesDetectionJobRequest& WithMode(const PiiEntitiesDetectionMode& value) { SetMode(value); return *this;}
140 
145  inline StartPiiEntitiesDetectionJobRequest& WithMode(PiiEntitiesDetectionMode&& value) { SetMode(std::move(value)); return *this;}
146 
147 
155  inline const RedactionConfig& GetRedactionConfig() const{ return m_redactionConfig; }
156 
164  inline bool RedactionConfigHasBeenSet() const { return m_redactionConfigHasBeenSet; }
165 
173  inline void SetRedactionConfig(const RedactionConfig& value) { m_redactionConfigHasBeenSet = true; m_redactionConfig = value; }
174 
182  inline void SetRedactionConfig(RedactionConfig&& value) { m_redactionConfigHasBeenSet = true; m_redactionConfig = std::move(value); }
183 
191  inline StartPiiEntitiesDetectionJobRequest& WithRedactionConfig(const RedactionConfig& value) { SetRedactionConfig(value); return *this;}
192 
200  inline StartPiiEntitiesDetectionJobRequest& WithRedactionConfig(RedactionConfig&& value) { SetRedactionConfig(std::move(value)); return *this;}
201 
202 
207  inline const Aws::String& GetDataAccessRoleArn() const{ return m_dataAccessRoleArn; }
208 
213  inline bool DataAccessRoleArnHasBeenSet() const { return m_dataAccessRoleArnHasBeenSet; }
214 
219  inline void SetDataAccessRoleArn(const Aws::String& value) { m_dataAccessRoleArnHasBeenSet = true; m_dataAccessRoleArn = value; }
220 
225  inline void SetDataAccessRoleArn(Aws::String&& value) { m_dataAccessRoleArnHasBeenSet = true; m_dataAccessRoleArn = std::move(value); }
226 
231  inline void SetDataAccessRoleArn(const char* value) { m_dataAccessRoleArnHasBeenSet = true; m_dataAccessRoleArn.assign(value); }
232 
237  inline StartPiiEntitiesDetectionJobRequest& WithDataAccessRoleArn(const Aws::String& value) { SetDataAccessRoleArn(value); return *this;}
238 
243  inline StartPiiEntitiesDetectionJobRequest& WithDataAccessRoleArn(Aws::String&& value) { SetDataAccessRoleArn(std::move(value)); return *this;}
244 
249  inline StartPiiEntitiesDetectionJobRequest& WithDataAccessRoleArn(const char* value) { SetDataAccessRoleArn(value); return *this;}
250 
251 
255  inline const Aws::String& GetJobName() const{ return m_jobName; }
256 
260  inline bool JobNameHasBeenSet() const { return m_jobNameHasBeenSet; }
261 
265  inline void SetJobName(const Aws::String& value) { m_jobNameHasBeenSet = true; m_jobName = value; }
266 
270  inline void SetJobName(Aws::String&& value) { m_jobNameHasBeenSet = true; m_jobName = std::move(value); }
271 
275  inline void SetJobName(const char* value) { m_jobNameHasBeenSet = true; m_jobName.assign(value); }
276 
280  inline StartPiiEntitiesDetectionJobRequest& WithJobName(const Aws::String& value) { SetJobName(value); return *this;}
281 
285  inline StartPiiEntitiesDetectionJobRequest& WithJobName(Aws::String&& value) { SetJobName(std::move(value)); return *this;}
286 
290  inline StartPiiEntitiesDetectionJobRequest& WithJobName(const char* value) { SetJobName(value); return *this;}
291 
292 
296  inline const LanguageCode& GetLanguageCode() const{ return m_languageCode; }
297 
301  inline bool LanguageCodeHasBeenSet() const { return m_languageCodeHasBeenSet; }
302 
306  inline void SetLanguageCode(const LanguageCode& value) { m_languageCodeHasBeenSet = true; m_languageCode = value; }
307 
311  inline void SetLanguageCode(LanguageCode&& value) { m_languageCodeHasBeenSet = true; m_languageCode = std::move(value); }
312 
316  inline StartPiiEntitiesDetectionJobRequest& WithLanguageCode(const LanguageCode& value) { SetLanguageCode(value); return *this;}
317 
321  inline StartPiiEntitiesDetectionJobRequest& WithLanguageCode(LanguageCode&& value) { SetLanguageCode(std::move(value)); return *this;}
322 
323 
328  inline const Aws::String& GetClientRequestToken() const{ return m_clientRequestToken; }
329 
334  inline bool ClientRequestTokenHasBeenSet() const { return m_clientRequestTokenHasBeenSet; }
335 
340  inline void SetClientRequestToken(const Aws::String& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = value; }
341 
346  inline void SetClientRequestToken(Aws::String&& value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken = std::move(value); }
347 
352  inline void SetClientRequestToken(const char* value) { m_clientRequestTokenHasBeenSet = true; m_clientRequestToken.assign(value); }
353 
358  inline StartPiiEntitiesDetectionJobRequest& WithClientRequestToken(const Aws::String& value) { SetClientRequestToken(value); return *this;}
359 
364  inline StartPiiEntitiesDetectionJobRequest& WithClientRequestToken(Aws::String&& value) { SetClientRequestToken(std::move(value)); return *this;}
365 
370  inline StartPiiEntitiesDetectionJobRequest& WithClientRequestToken(const char* value) { SetClientRequestToken(value); return *this;}
371 
372  private:
373 
374  InputDataConfig m_inputDataConfig;
375  bool m_inputDataConfigHasBeenSet;
376 
377  OutputDataConfig m_outputDataConfig;
378  bool m_outputDataConfigHasBeenSet;
379 
381  bool m_modeHasBeenSet;
382 
383  RedactionConfig m_redactionConfig;
384  bool m_redactionConfigHasBeenSet;
385 
386  Aws::String m_dataAccessRoleArn;
387  bool m_dataAccessRoleArnHasBeenSet;
388 
389  Aws::String m_jobName;
390  bool m_jobNameHasBeenSet;
391 
392  LanguageCode m_languageCode;
393  bool m_languageCodeHasBeenSet;
394 
395  Aws::String m_clientRequestToken;
396  bool m_clientRequestTokenHasBeenSet;
397  };
398 
399 } // namespace Model
400 } // namespace Comprehend
401 } // namespace Aws
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::OutputDataConfigHasBeenSet
bool OutputDataConfigHasBeenSet() const
Definition: StartPiiEntitiesDetectionJobRequest.h:84
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::GetInputDataConfig
const InputDataConfig & GetInputDataConfig() const
Definition: StartPiiEntitiesDetectionJobRequest.h:46
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetInputDataConfig
void SetInputDataConfig(InputDataConfig &&value)
Definition: StartPiiEntitiesDetectionJobRequest.h:61
Aws::Comprehend::ComprehendRequest
Definition: ComprehendRequest.h:17
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetRedactionConfig
void SetRedactionConfig(const RedactionConfig &value)
Definition: StartPiiEntitiesDetectionJobRequest.h:173
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::StartPiiEntitiesDetectionJobRequest
StartPiiEntitiesDetectionJobRequest()
AWS_COMPREHEND_API
#define AWS_COMPREHEND_API
Definition: Comprehend_EXPORTS.h:28
Aws::Http::HeaderValueCollection
Aws::Map< Aws::String, Aws::String > HeaderValueCollection
Definition: HttpTypes.h:53
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetRedactionConfig
void SetRedactionConfig(RedactionConfig &&value)
Definition: StartPiiEntitiesDetectionJobRequest.h:182
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithMode
StartPiiEntitiesDetectionJobRequest & WithMode(const PiiEntitiesDetectionMode &value)
Definition: StartPiiEntitiesDetectionJobRequest.h:139
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetJobName
void SetJobName(Aws::String &&value)
Definition: StartPiiEntitiesDetectionJobRequest.h:270
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetLanguageCode
void SetLanguageCode(LanguageCode &&value)
Definition: StartPiiEntitiesDetectionJobRequest.h:311
Aws::Comprehend::Model::OutputDataConfig
Definition: OutputDataConfig.h:33
Aws::Comprehend::Model::RedactionConfig
Definition: RedactionConfig.h:36
Aws::Comprehend::Model::InputDataConfig
Definition: InputDataConfig.h:33
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::RedactionConfigHasBeenSet
bool RedactionConfigHasBeenSet() const
Definition: StartPiiEntitiesDetectionJobRequest.h:164
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithDataAccessRoleArn
StartPiiEntitiesDetectionJobRequest & WithDataAccessRoleArn(const Aws::String &value)
Definition: StartPiiEntitiesDetectionJobRequest.h:237
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithDataAccessRoleArn
StartPiiEntitiesDetectionJobRequest & WithDataAccessRoleArn(Aws::String &&value)
Definition: StartPiiEntitiesDetectionJobRequest.h:243
RedactionConfig.h
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetClientRequestToken
void SetClientRequestToken(Aws::String &&value)
Definition: StartPiiEntitiesDetectionJobRequest.h:346
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithInputDataConfig
StartPiiEntitiesDetectionJobRequest & WithInputDataConfig(InputDataConfig &&value)
Definition: StartPiiEntitiesDetectionJobRequest.h:71
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithDataAccessRoleArn
StartPiiEntitiesDetectionJobRequest & WithDataAccessRoleArn(const char *value)
Definition: StartPiiEntitiesDetectionJobRequest.h:249
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::GetRequestSpecificHeaders
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::GetClientRequestToken
const Aws::String & GetClientRequestToken() const
Definition: StartPiiEntitiesDetectionJobRequest.h:328
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::GetDataAccessRoleArn
const Aws::String & GetDataAccessRoleArn() const
Definition: StartPiiEntitiesDetectionJobRequest.h:207
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::JobNameHasBeenSet
bool JobNameHasBeenSet() const
Definition: StartPiiEntitiesDetectionJobRequest.h:260
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetClientRequestToken
void SetClientRequestToken(const Aws::String &value)
Definition: StartPiiEntitiesDetectionJobRequest.h:340
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetClientRequestToken
void SetClientRequestToken(const char *value)
Definition: StartPiiEntitiesDetectionJobRequest.h:352
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::GetServiceRequestName
virtual const char * GetServiceRequestName() const override
Definition: StartPiiEntitiesDetectionJobRequest.h:36
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::GetJobName
const Aws::String & GetJobName() const
Definition: StartPiiEntitiesDetectionJobRequest.h:255
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetInputDataConfig
void SetInputDataConfig(const InputDataConfig &value)
Definition: StartPiiEntitiesDetectionJobRequest.h:56
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithInputDataConfig
StartPiiEntitiesDetectionJobRequest & WithInputDataConfig(const InputDataConfig &value)
Definition: StartPiiEntitiesDetectionJobRequest.h:66
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetDataAccessRoleArn
void SetDataAccessRoleArn(Aws::String &&value)
Definition: StartPiiEntitiesDetectionJobRequest.h:225
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::ModeHasBeenSet
bool ModeHasBeenSet() const
Definition: StartPiiEntitiesDetectionJobRequest.h:121
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetLanguageCode
void SetLanguageCode(const LanguageCode &value)
Definition: StartPiiEntitiesDetectionJobRequest.h:306
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithJobName
StartPiiEntitiesDetectionJobRequest & WithJobName(const Aws::String &value)
Definition: StartPiiEntitiesDetectionJobRequest.h:280
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::GetRedactionConfig
const RedactionConfig & GetRedactionConfig() const
Definition: StartPiiEntitiesDetectionJobRequest.h:155
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithClientRequestToken
StartPiiEntitiesDetectionJobRequest & WithClientRequestToken(const Aws::String &value)
Definition: StartPiiEntitiesDetectionJobRequest.h:358
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest
Definition: StartPiiEntitiesDetectionJobRequest.h:28
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithOutputDataConfig
StartPiiEntitiesDetectionJobRequest & WithOutputDataConfig(OutputDataConfig &&value)
Definition: StartPiiEntitiesDetectionJobRequest.h:108
InputDataConfig.h
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithLanguageCode
StartPiiEntitiesDetectionJobRequest & WithLanguageCode(const LanguageCode &value)
Definition: StartPiiEntitiesDetectionJobRequest.h:316
Aws::Comprehend::Model::LanguageCode
LanguageCode
Definition: LanguageCode.h:17
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::LanguageCodeHasBeenSet
bool LanguageCodeHasBeenSet() const
Definition: StartPiiEntitiesDetectionJobRequest.h:301
Aws::Comprehend::Model::PiiEntitiesDetectionMode
PiiEntitiesDetectionMode
Definition: PiiEntitiesDetectionMode.h:17
AWSString.h
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::DataAccessRoleArnHasBeenSet
bool DataAccessRoleArnHasBeenSet() const
Definition: StartPiiEntitiesDetectionJobRequest.h:213
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetJobName
void SetJobName(const Aws::String &value)
Definition: StartPiiEntitiesDetectionJobRequest.h:265
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithMode
StartPiiEntitiesDetectionJobRequest & WithMode(PiiEntitiesDetectionMode &&value)
Definition: StartPiiEntitiesDetectionJobRequest.h:145
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithOutputDataConfig
StartPiiEntitiesDetectionJobRequest & WithOutputDataConfig(const OutputDataConfig &value)
Definition: StartPiiEntitiesDetectionJobRequest.h:102
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetMode
void SetMode(const PiiEntitiesDetectionMode &value)
Definition: StartPiiEntitiesDetectionJobRequest.h:127
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithClientRequestToken
StartPiiEntitiesDetectionJobRequest & WithClientRequestToken(Aws::String &&value)
Definition: StartPiiEntitiesDetectionJobRequest.h:364
OutputDataConfig.h
LanguageCode.h
ComprehendRequest.h
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::InputDataConfigHasBeenSet
bool InputDataConfigHasBeenSet() const
Definition: StartPiiEntitiesDetectionJobRequest.h:51
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithJobName
StartPiiEntitiesDetectionJobRequest & WithJobName(const char *value)
Definition: StartPiiEntitiesDetectionJobRequest.h:290
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetDataAccessRoleArn
void SetDataAccessRoleArn(const Aws::String &value)
Definition: StartPiiEntitiesDetectionJobRequest.h:219
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithClientRequestToken
StartPiiEntitiesDetectionJobRequest & WithClientRequestToken(const char *value)
Definition: StartPiiEntitiesDetectionJobRequest.h:370
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetOutputDataConfig
void SetOutputDataConfig(const OutputDataConfig &value)
Definition: StartPiiEntitiesDetectionJobRequest.h:90
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::ClientRequestTokenHasBeenSet
bool ClientRequestTokenHasBeenSet() const
Definition: StartPiiEntitiesDetectionJobRequest.h:334
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetJobName
void SetJobName(const char *value)
Definition: StartPiiEntitiesDetectionJobRequest.h:275
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetOutputDataConfig
void SetOutputDataConfig(OutputDataConfig &&value)
Definition: StartPiiEntitiesDetectionJobRequest.h:96
Comprehend_EXPORTS.h
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithRedactionConfig
StartPiiEntitiesDetectionJobRequest & WithRedactionConfig(RedactionConfig &&value)
Definition: StartPiiEntitiesDetectionJobRequest.h:200
Aws
Definition: AccessManagementClient.h:15
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithLanguageCode
StartPiiEntitiesDetectionJobRequest & WithLanguageCode(LanguageCode &&value)
Definition: StartPiiEntitiesDetectionJobRequest.h:321
Aws::String
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
Definition: AWSString.h:97
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::GetOutputDataConfig
const OutputDataConfig & GetOutputDataConfig() const
Definition: StartPiiEntitiesDetectionJobRequest.h:78
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithRedactionConfig
StartPiiEntitiesDetectionJobRequest & WithRedactionConfig(const RedactionConfig &value)
Definition: StartPiiEntitiesDetectionJobRequest.h:191
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetMode
void SetMode(PiiEntitiesDetectionMode &&value)
Definition: StartPiiEntitiesDetectionJobRequest.h:133
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SetDataAccessRoleArn
void SetDataAccessRoleArn(const char *value)
Definition: StartPiiEntitiesDetectionJobRequest.h:231
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::WithJobName
StartPiiEntitiesDetectionJobRequest & WithJobName(Aws::String &&value)
Definition: StartPiiEntitiesDetectionJobRequest.h:285
UUID.h
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::GetMode
const PiiEntitiesDetectionMode & GetMode() const
Definition: StartPiiEntitiesDetectionJobRequest.h:115
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::SerializePayload
Aws::String SerializePayload() const override
PiiEntitiesDetectionMode.h
Aws::Comprehend::Model::StartPiiEntitiesDetectionJobRequest::GetLanguageCode
const LanguageCode & GetLanguageCode() const
Definition: StartPiiEntitiesDetectionJobRequest.h:296