AWS SDK for C++

AWS SDK for C++ Version 1.11.771

Loading...
Searching...
No Matches
HIT.h
1
6#pragma once
7#include <aws/core/utils/DateTime.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/core/utils/memory/stl/AWSVector.h>
10#include <aws/mturk-requester/MTurk_EXPORTS.h>
11#include <aws/mturk-requester/model/HITReviewStatus.h>
12#include <aws/mturk-requester/model/HITStatus.h>
13#include <aws/mturk-requester/model/QualificationRequirement.h>
14
15#include <utility>
16
17namespace Aws {
18namespace Utils {
19namespace Json {
20class JsonValue;
21class JsonView;
22} // namespace Json
23} // namespace Utils
24namespace MTurk {
25namespace Model {
26
34class HIT {
35 public:
36 AWS_MTURK_API HIT() = default;
37 AWS_MTURK_API HIT(Aws::Utils::Json::JsonView jsonValue);
38 AWS_MTURK_API HIT& operator=(Aws::Utils::Json::JsonView jsonValue);
39 AWS_MTURK_API Aws::Utils::Json::JsonValue Jsonize() const;
40
42
45 inline const Aws::String& GetHITId() const { return m_hITId; }
46 inline bool HITIdHasBeenSet() const { return m_hITIdHasBeenSet; }
47 template <typename HITIdT = Aws::String>
48 void SetHITId(HITIdT&& value) {
49 m_hITIdHasBeenSet = true;
50 m_hITId = std::forward<HITIdT>(value);
51 }
52 template <typename HITIdT = Aws::String>
53 HIT& WithHITId(HITIdT&& value) {
54 SetHITId(std::forward<HITIdT>(value));
55 return *this;
56 }
58
60
63 inline const Aws::String& GetHITTypeId() const { return m_hITTypeId; }
64 inline bool HITTypeIdHasBeenSet() const { return m_hITTypeIdHasBeenSet; }
65 template <typename HITTypeIdT = Aws::String>
66 void SetHITTypeId(HITTypeIdT&& value) {
67 m_hITTypeIdHasBeenSet = true;
68 m_hITTypeId = std::forward<HITTypeIdT>(value);
69 }
70 template <typename HITTypeIdT = Aws::String>
71 HIT& WithHITTypeId(HITTypeIdT&& value) {
72 SetHITTypeId(std::forward<HITTypeIdT>(value));
73 return *this;
74 }
76
78
81 inline const Aws::String& GetHITGroupId() const { return m_hITGroupId; }
82 inline bool HITGroupIdHasBeenSet() const { return m_hITGroupIdHasBeenSet; }
83 template <typename HITGroupIdT = Aws::String>
84 void SetHITGroupId(HITGroupIdT&& value) {
85 m_hITGroupIdHasBeenSet = true;
86 m_hITGroupId = std::forward<HITGroupIdT>(value);
87 }
88 template <typename HITGroupIdT = Aws::String>
89 HIT& WithHITGroupId(HITGroupIdT&& value) {
90 SetHITGroupId(std::forward<HITGroupIdT>(value));
91 return *this;
92 }
94
96
99 inline const Aws::String& GetHITLayoutId() const { return m_hITLayoutId; }
100 inline bool HITLayoutIdHasBeenSet() const { return m_hITLayoutIdHasBeenSet; }
101 template <typename HITLayoutIdT = Aws::String>
102 void SetHITLayoutId(HITLayoutIdT&& value) {
103 m_hITLayoutIdHasBeenSet = true;
104 m_hITLayoutId = std::forward<HITLayoutIdT>(value);
105 }
106 template <typename HITLayoutIdT = Aws::String>
107 HIT& WithHITLayoutId(HITLayoutIdT&& value) {
108 SetHITLayoutId(std::forward<HITLayoutIdT>(value));
109 return *this;
110 }
112
114
117 inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; }
118 inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; }
119 template <typename CreationTimeT = Aws::Utils::DateTime>
120 void SetCreationTime(CreationTimeT&& value) {
121 m_creationTimeHasBeenSet = true;
122 m_creationTime = std::forward<CreationTimeT>(value);
123 }
124 template <typename CreationTimeT = Aws::Utils::DateTime>
125 HIT& WithCreationTime(CreationTimeT&& value) {
126 SetCreationTime(std::forward<CreationTimeT>(value));
127 return *this;
128 }
130
132
135 inline const Aws::String& GetTitle() const { return m_title; }
136 inline bool TitleHasBeenSet() const { return m_titleHasBeenSet; }
137 template <typename TitleT = Aws::String>
138 void SetTitle(TitleT&& value) {
139 m_titleHasBeenSet = true;
140 m_title = std::forward<TitleT>(value);
141 }
142 template <typename TitleT = Aws::String>
143 HIT& WithTitle(TitleT&& value) {
144 SetTitle(std::forward<TitleT>(value));
145 return *this;
146 }
148
150
153 inline const Aws::String& GetDescription() const { return m_description; }
154 inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
155 template <typename DescriptionT = Aws::String>
156 void SetDescription(DescriptionT&& value) {
157 m_descriptionHasBeenSet = true;
158 m_description = std::forward<DescriptionT>(value);
159 }
160 template <typename DescriptionT = Aws::String>
161 HIT& WithDescription(DescriptionT&& value) {
162 SetDescription(std::forward<DescriptionT>(value));
163 return *this;
164 }
166
168
173 inline const Aws::String& GetQuestion() const { return m_question; }
174 inline bool QuestionHasBeenSet() const { return m_questionHasBeenSet; }
175 template <typename QuestionT = Aws::String>
176 void SetQuestion(QuestionT&& value) {
177 m_questionHasBeenSet = true;
178 m_question = std::forward<QuestionT>(value);
179 }
180 template <typename QuestionT = Aws::String>
181 HIT& WithQuestion(QuestionT&& value) {
182 SetQuestion(std::forward<QuestionT>(value));
183 return *this;
184 }
186
188
193 inline const Aws::String& GetKeywords() const { return m_keywords; }
194 inline bool KeywordsHasBeenSet() const { return m_keywordsHasBeenSet; }
195 template <typename KeywordsT = Aws::String>
196 void SetKeywords(KeywordsT&& value) {
197 m_keywordsHasBeenSet = true;
198 m_keywords = std::forward<KeywordsT>(value);
199 }
200 template <typename KeywordsT = Aws::String>
201 HIT& WithKeywords(KeywordsT&& value) {
202 SetKeywords(std::forward<KeywordsT>(value));
203 return *this;
204 }
206
208
212 inline HITStatus GetHITStatus() const { return m_hITStatus; }
213 inline bool HITStatusHasBeenSet() const { return m_hITStatusHasBeenSet; }
214 inline void SetHITStatus(HITStatus value) {
215 m_hITStatusHasBeenSet = true;
216 m_hITStatus = value;
217 }
218 inline HIT& WithHITStatus(HITStatus value) {
219 SetHITStatus(value);
220 return *this;
221 }
223
225
229 inline int GetMaxAssignments() const { return m_maxAssignments; }
230 inline bool MaxAssignmentsHasBeenSet() const { return m_maxAssignmentsHasBeenSet; }
231 inline void SetMaxAssignments(int value) {
232 m_maxAssignmentsHasBeenSet = true;
233 m_maxAssignments = value;
234 }
235 inline HIT& WithMaxAssignments(int value) {
236 SetMaxAssignments(value);
237 return *this;
238 }
240
242
243 inline const Aws::String& GetReward() const { return m_reward; }
244 inline bool RewardHasBeenSet() const { return m_rewardHasBeenSet; }
245 template <typename RewardT = Aws::String>
246 void SetReward(RewardT&& value) {
247 m_rewardHasBeenSet = true;
248 m_reward = std::forward<RewardT>(value);
249 }
250 template <typename RewardT = Aws::String>
251 HIT& WithReward(RewardT&& value) {
252 SetReward(std::forward<RewardT>(value));
253 return *this;
254 }
256
258
264 inline long long GetAutoApprovalDelayInSeconds() const { return m_autoApprovalDelayInSeconds; }
265 inline bool AutoApprovalDelayInSecondsHasBeenSet() const { return m_autoApprovalDelayInSecondsHasBeenSet; }
266 inline void SetAutoApprovalDelayInSeconds(long long value) {
267 m_autoApprovalDelayInSecondsHasBeenSet = true;
268 m_autoApprovalDelayInSeconds = value;
269 }
270 inline HIT& WithAutoApprovalDelayInSeconds(long long value) {
272 return *this;
273 }
275
277
280 inline const Aws::Utils::DateTime& GetExpiration() const { return m_expiration; }
281 inline bool ExpirationHasBeenSet() const { return m_expirationHasBeenSet; }
282 template <typename ExpirationT = Aws::Utils::DateTime>
283 void SetExpiration(ExpirationT&& value) {
284 m_expirationHasBeenSet = true;
285 m_expiration = std::forward<ExpirationT>(value);
286 }
287 template <typename ExpirationT = Aws::Utils::DateTime>
288 HIT& WithExpiration(ExpirationT&& value) {
289 SetExpiration(std::forward<ExpirationT>(value));
290 return *this;
291 }
293
295
299 inline long long GetAssignmentDurationInSeconds() const { return m_assignmentDurationInSeconds; }
300 inline bool AssignmentDurationInSecondsHasBeenSet() const { return m_assignmentDurationInSecondsHasBeenSet; }
301 inline void SetAssignmentDurationInSeconds(long long value) {
302 m_assignmentDurationInSecondsHasBeenSet = true;
303 m_assignmentDurationInSeconds = value;
304 }
305 inline HIT& WithAssignmentDurationInSeconds(long long value) {
307 return *this;
308 }
310
312
316 inline const Aws::String& GetRequesterAnnotation() const { return m_requesterAnnotation; }
317 inline bool RequesterAnnotationHasBeenSet() const { return m_requesterAnnotationHasBeenSet; }
318 template <typename RequesterAnnotationT = Aws::String>
319 void SetRequesterAnnotation(RequesterAnnotationT&& value) {
320 m_requesterAnnotationHasBeenSet = true;
321 m_requesterAnnotation = std::forward<RequesterAnnotationT>(value);
322 }
323 template <typename RequesterAnnotationT = Aws::String>
324 HIT& WithRequesterAnnotation(RequesterAnnotationT&& value) {
325 SetRequesterAnnotation(std::forward<RequesterAnnotationT>(value));
326 return *this;
327 }
329
331
338 inline const Aws::Vector<QualificationRequirement>& GetQualificationRequirements() const { return m_qualificationRequirements; }
339 inline bool QualificationRequirementsHasBeenSet() const { return m_qualificationRequirementsHasBeenSet; }
340 template <typename QualificationRequirementsT = Aws::Vector<QualificationRequirement>>
341 void SetQualificationRequirements(QualificationRequirementsT&& value) {
342 m_qualificationRequirementsHasBeenSet = true;
343 m_qualificationRequirements = std::forward<QualificationRequirementsT>(value);
344 }
345 template <typename QualificationRequirementsT = Aws::Vector<QualificationRequirement>>
346 HIT& WithQualificationRequirements(QualificationRequirementsT&& value) {
347 SetQualificationRequirements(std::forward<QualificationRequirementsT>(value));
348 return *this;
349 }
350 template <typename QualificationRequirementsT = QualificationRequirement>
351 HIT& AddQualificationRequirements(QualificationRequirementsT&& value) {
352 m_qualificationRequirementsHasBeenSet = true;
353 m_qualificationRequirements.emplace_back(std::forward<QualificationRequirementsT>(value));
354 return *this;
355 }
357
359
363 inline HITReviewStatus GetHITReviewStatus() const { return m_hITReviewStatus; }
364 inline bool HITReviewStatusHasBeenSet() const { return m_hITReviewStatusHasBeenSet; }
366 m_hITReviewStatusHasBeenSet = true;
367 m_hITReviewStatus = value;
368 }
370 SetHITReviewStatus(value);
371 return *this;
372 }
374
376
381 inline int GetNumberOfAssignmentsPending() const { return m_numberOfAssignmentsPending; }
382 inline bool NumberOfAssignmentsPendingHasBeenSet() const { return m_numberOfAssignmentsPendingHasBeenSet; }
383 inline void SetNumberOfAssignmentsPending(int value) {
384 m_numberOfAssignmentsPendingHasBeenSet = true;
385 m_numberOfAssignmentsPending = value;
386 }
389 return *this;
390 }
392
394
398 inline int GetNumberOfAssignmentsAvailable() const { return m_numberOfAssignmentsAvailable; }
399 inline bool NumberOfAssignmentsAvailableHasBeenSet() const { return m_numberOfAssignmentsAvailableHasBeenSet; }
400 inline void SetNumberOfAssignmentsAvailable(int value) {
401 m_numberOfAssignmentsAvailableHasBeenSet = true;
402 m_numberOfAssignmentsAvailable = value;
403 }
406 return *this;
407 }
409
411
415 inline int GetNumberOfAssignmentsCompleted() const { return m_numberOfAssignmentsCompleted; }
416 inline bool NumberOfAssignmentsCompletedHasBeenSet() const { return m_numberOfAssignmentsCompletedHasBeenSet; }
417 inline void SetNumberOfAssignmentsCompleted(int value) {
418 m_numberOfAssignmentsCompletedHasBeenSet = true;
419 m_numberOfAssignmentsCompleted = value;
420 }
423 return *this;
424 }
426 private:
427 Aws::String m_hITId;
428
429 Aws::String m_hITTypeId;
430
431 Aws::String m_hITGroupId;
432
433 Aws::String m_hITLayoutId;
434
435 Aws::Utils::DateTime m_creationTime{};
436
437 Aws::String m_title;
438
439 Aws::String m_description;
440
441 Aws::String m_question;
442
443 Aws::String m_keywords;
444
445 HITStatus m_hITStatus{HITStatus::NOT_SET};
446
447 int m_maxAssignments{0};
448
449 Aws::String m_reward;
450
451 long long m_autoApprovalDelayInSeconds{0};
452
453 Aws::Utils::DateTime m_expiration{};
454
455 long long m_assignmentDurationInSeconds{0};
456
457 Aws::String m_requesterAnnotation;
458
459 Aws::Vector<QualificationRequirement> m_qualificationRequirements;
460
461 HITReviewStatus m_hITReviewStatus{HITReviewStatus::NOT_SET};
462
463 int m_numberOfAssignmentsPending{0};
464
465 int m_numberOfAssignmentsAvailable{0};
466
467 int m_numberOfAssignmentsCompleted{0};
468 bool m_hITIdHasBeenSet = false;
469 bool m_hITTypeIdHasBeenSet = false;
470 bool m_hITGroupIdHasBeenSet = false;
471 bool m_hITLayoutIdHasBeenSet = false;
472 bool m_creationTimeHasBeenSet = false;
473 bool m_titleHasBeenSet = false;
474 bool m_descriptionHasBeenSet = false;
475 bool m_questionHasBeenSet = false;
476 bool m_keywordsHasBeenSet = false;
477 bool m_hITStatusHasBeenSet = false;
478 bool m_maxAssignmentsHasBeenSet = false;
479 bool m_rewardHasBeenSet = false;
480 bool m_autoApprovalDelayInSecondsHasBeenSet = false;
481 bool m_expirationHasBeenSet = false;
482 bool m_assignmentDurationInSecondsHasBeenSet = false;
483 bool m_requesterAnnotationHasBeenSet = false;
484 bool m_qualificationRequirementsHasBeenSet = false;
485 bool m_hITReviewStatusHasBeenSet = false;
486 bool m_numberOfAssignmentsPendingHasBeenSet = false;
487 bool m_numberOfAssignmentsAvailableHasBeenSet = false;
488 bool m_numberOfAssignmentsCompletedHasBeenSet = false;
489};
490
491} // namespace Model
492} // namespace MTurk
493} // namespace Aws
HIT & WithAssignmentDurationInSeconds(long long value)
Definition HIT.h:305
void SetReward(RewardT &&value)
Definition HIT.h:246
const Aws::String & GetTitle() const
Definition HIT.h:135
const Aws::Utils::DateTime & GetExpiration() const
Definition HIT.h:280
const Aws::String & GetDescription() const
Definition HIT.h:153
const Aws::String & GetReward() const
Definition HIT.h:243
HIT & WithQualificationRequirements(QualificationRequirementsT &&value)
Definition HIT.h:346
void SetMaxAssignments(int value)
Definition HIT.h:231
bool DescriptionHasBeenSet() const
Definition HIT.h:154
bool CreationTimeHasBeenSet() const
Definition HIT.h:118
const Aws::String & GetHITLayoutId() const
Definition HIT.h:99
void SetNumberOfAssignmentsPending(int value)
Definition HIT.h:383
bool HITTypeIdHasBeenSet() const
Definition HIT.h:64
long long GetAutoApprovalDelayInSeconds() const
Definition HIT.h:264
const Aws::String & GetKeywords() const
Definition HIT.h:193
bool TitleHasBeenSet() const
Definition HIT.h:136
HIT & WithMaxAssignments(int value)
Definition HIT.h:235
HIT & WithHITStatus(HITStatus value)
Definition HIT.h:218
void SetAssignmentDurationInSeconds(long long value)
Definition HIT.h:301
bool HITGroupIdHasBeenSet() const
Definition HIT.h:82
HIT & AddQualificationRequirements(QualificationRequirementsT &&value)
Definition HIT.h:351
HIT & WithAutoApprovalDelayInSeconds(long long value)
Definition HIT.h:270
void SetHITStatus(HITStatus value)
Definition HIT.h:214
void SetNumberOfAssignmentsCompleted(int value)
Definition HIT.h:417
bool MaxAssignmentsHasBeenSet() const
Definition HIT.h:230
AWS_MTURK_API Aws::Utils::Json::JsonValue Jsonize() const
HIT & WithHITId(HITIdT &&value)
Definition HIT.h:53
bool NumberOfAssignmentsAvailableHasBeenSet() const
Definition HIT.h:399
HIT & WithRequesterAnnotation(RequesterAnnotationT &&value)
Definition HIT.h:324
HIT & WithDescription(DescriptionT &&value)
Definition HIT.h:161
HIT & WithHITLayoutId(HITLayoutIdT &&value)
Definition HIT.h:107
HIT & WithCreationTime(CreationTimeT &&value)
Definition HIT.h:125
HIT & WithQuestion(QuestionT &&value)
Definition HIT.h:181
bool HITLayoutIdHasBeenSet() const
Definition HIT.h:100
void SetDescription(DescriptionT &&value)
Definition HIT.h:156
bool HITIdHasBeenSet() const
Definition HIT.h:46
HIT & WithExpiration(ExpirationT &&value)
Definition HIT.h:288
int GetNumberOfAssignmentsPending() const
Definition HIT.h:381
HIT & WithKeywords(KeywordsT &&value)
Definition HIT.h:201
void SetExpiration(ExpirationT &&value)
Definition HIT.h:283
AWS_MTURK_API HIT()=default
AWS_MTURK_API HIT(Aws::Utils::Json::JsonView jsonValue)
void SetHITId(HITIdT &&value)
Definition HIT.h:48
HITStatus GetHITStatus() const
Definition HIT.h:212
HIT & WithNumberOfAssignmentsCompleted(int value)
Definition HIT.h:421
HIT & WithReward(RewardT &&value)
Definition HIT.h:251
HIT & WithHITReviewStatus(HITReviewStatus value)
Definition HIT.h:369
HIT & WithNumberOfAssignmentsPending(int value)
Definition HIT.h:387
bool NumberOfAssignmentsPendingHasBeenSet() const
Definition HIT.h:382
void SetKeywords(KeywordsT &&value)
Definition HIT.h:196
const Aws::String & GetQuestion() const
Definition HIT.h:173
int GetMaxAssignments() const
Definition HIT.h:229
bool RewardHasBeenSet() const
Definition HIT.h:244
const Aws::Vector< QualificationRequirement > & GetQualificationRequirements() const
Definition HIT.h:338
bool KeywordsHasBeenSet() const
Definition HIT.h:194
bool AutoApprovalDelayInSecondsHasBeenSet() const
Definition HIT.h:265
void SetAutoApprovalDelayInSeconds(long long value)
Definition HIT.h:266
const Aws::String & GetRequesterAnnotation() const
Definition HIT.h:316
int GetNumberOfAssignmentsCompleted() const
Definition HIT.h:415
void SetQuestion(QuestionT &&value)
Definition HIT.h:176
void SetNumberOfAssignmentsAvailable(int value)
Definition HIT.h:400
bool QualificationRequirementsHasBeenSet() const
Definition HIT.h:339
void SetTitle(TitleT &&value)
Definition HIT.h:138
void SetCreationTime(CreationTimeT &&value)
Definition HIT.h:120
bool QuestionHasBeenSet() const
Definition HIT.h:174
const Aws::String & GetHITGroupId() const
Definition HIT.h:81
const Aws::String & GetHITId() const
Definition HIT.h:45
AWS_MTURK_API HIT & operator=(Aws::Utils::Json::JsonView jsonValue)
void SetHITReviewStatus(HITReviewStatus value)
Definition HIT.h:365
long long GetAssignmentDurationInSeconds() const
Definition HIT.h:299
bool AssignmentDurationInSecondsHasBeenSet() const
Definition HIT.h:300
bool RequesterAnnotationHasBeenSet() const
Definition HIT.h:317
void SetHITTypeId(HITTypeIdT &&value)
Definition HIT.h:66
const Aws::String & GetHITTypeId() const
Definition HIT.h:63
bool ExpirationHasBeenSet() const
Definition HIT.h:281
int GetNumberOfAssignmentsAvailable() const
Definition HIT.h:398
void SetHITGroupId(HITGroupIdT &&value)
Definition HIT.h:84
bool HITReviewStatusHasBeenSet() const
Definition HIT.h:364
const Aws::Utils::DateTime & GetCreationTime() const
Definition HIT.h:117
bool HITStatusHasBeenSet() const
Definition HIT.h:213
bool NumberOfAssignmentsCompletedHasBeenSet() const
Definition HIT.h:416
HIT & WithHITTypeId(HITTypeIdT &&value)
Definition HIT.h:71
HITReviewStatus GetHITReviewStatus() const
Definition HIT.h:363
HIT & WithHITGroupId(HITGroupIdT &&value)
Definition HIT.h:89
HIT & WithTitle(TitleT &&value)
Definition HIT.h:143
void SetRequesterAnnotation(RequesterAnnotationT &&value)
Definition HIT.h:319
void SetQualificationRequirements(QualificationRequirementsT &&value)
Definition HIT.h:341
void SetHITLayoutId(HITLayoutIdT &&value)
Definition HIT.h:102
HIT & WithNumberOfAssignmentsAvailable(int value)
Definition HIT.h:404
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector
Aws::Utils::Json::JsonValue JsonValue