AWS SDK for C++

AWS SDK for C++ Version 1.11.606

Loading...
Searching...
No Matches
HIT.h
1
6#pragma once
7#include <aws/mturk-requester/MTurk_EXPORTS.h>
8#include <aws/core/utils/memory/stl/AWSString.h>
9#include <aws/core/utils/DateTime.h>
10#include <aws/mturk-requester/model/HITStatus.h>
11#include <aws/core/utils/memory/stl/AWSVector.h>
12#include <aws/mturk-requester/model/HITReviewStatus.h>
13#include <aws/mturk-requester/model/QualificationRequirement.h>
14#include <utility>
15
16namespace Aws
17{
18namespace Utils
19{
20namespace Json
21{
22 class JsonValue;
23 class JsonView;
24} // namespace Json
25} // namespace Utils
26namespace MTurk
27{
28namespace Model
29{
30
38 class HIT
39 {
40 public:
41 AWS_MTURK_API HIT() = default;
42 AWS_MTURK_API HIT(Aws::Utils::Json::JsonView jsonValue);
43 AWS_MTURK_API HIT& operator=(Aws::Utils::Json::JsonView jsonValue);
44 AWS_MTURK_API Aws::Utils::Json::JsonValue Jsonize() const;
45
46
48
51 inline const Aws::String& GetHITId() const { return m_hITId; }
52 inline bool HITIdHasBeenSet() const { return m_hITIdHasBeenSet; }
53 template<typename HITIdT = Aws::String>
54 void SetHITId(HITIdT&& value) { m_hITIdHasBeenSet = true; m_hITId = std::forward<HITIdT>(value); }
55 template<typename HITIdT = Aws::String>
56 HIT& WithHITId(HITIdT&& value) { SetHITId(std::forward<HITIdT>(value)); return *this;}
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) { m_hITTypeIdHasBeenSet = true; m_hITTypeId = std::forward<HITTypeIdT>(value); }
67 template<typename HITTypeIdT = Aws::String>
68 HIT& WithHITTypeId(HITTypeIdT&& value) { SetHITTypeId(std::forward<HITTypeIdT>(value)); return *this;}
70
72
75 inline const Aws::String& GetHITGroupId() const { return m_hITGroupId; }
76 inline bool HITGroupIdHasBeenSet() const { return m_hITGroupIdHasBeenSet; }
77 template<typename HITGroupIdT = Aws::String>
78 void SetHITGroupId(HITGroupIdT&& value) { m_hITGroupIdHasBeenSet = true; m_hITGroupId = std::forward<HITGroupIdT>(value); }
79 template<typename HITGroupIdT = Aws::String>
80 HIT& WithHITGroupId(HITGroupIdT&& value) { SetHITGroupId(std::forward<HITGroupIdT>(value)); return *this;}
82
84
87 inline const Aws::String& GetHITLayoutId() const { return m_hITLayoutId; }
88 inline bool HITLayoutIdHasBeenSet() const { return m_hITLayoutIdHasBeenSet; }
89 template<typename HITLayoutIdT = Aws::String>
90 void SetHITLayoutId(HITLayoutIdT&& value) { m_hITLayoutIdHasBeenSet = true; m_hITLayoutId = std::forward<HITLayoutIdT>(value); }
91 template<typename HITLayoutIdT = Aws::String>
92 HIT& WithHITLayoutId(HITLayoutIdT&& value) { SetHITLayoutId(std::forward<HITLayoutIdT>(value)); return *this;}
94
96
99 inline const Aws::Utils::DateTime& GetCreationTime() const { return m_creationTime; }
100 inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; }
101 template<typename CreationTimeT = Aws::Utils::DateTime>
102 void SetCreationTime(CreationTimeT&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::forward<CreationTimeT>(value); }
103 template<typename CreationTimeT = Aws::Utils::DateTime>
104 HIT& WithCreationTime(CreationTimeT&& value) { SetCreationTime(std::forward<CreationTimeT>(value)); return *this;}
106
108
111 inline const Aws::String& GetTitle() const { return m_title; }
112 inline bool TitleHasBeenSet() const { return m_titleHasBeenSet; }
113 template<typename TitleT = Aws::String>
114 void SetTitle(TitleT&& value) { m_titleHasBeenSet = true; m_title = std::forward<TitleT>(value); }
115 template<typename TitleT = Aws::String>
116 HIT& WithTitle(TitleT&& value) { SetTitle(std::forward<TitleT>(value)); return *this;}
118
120
123 inline const Aws::String& GetDescription() const { return m_description; }
124 inline bool DescriptionHasBeenSet() const { return m_descriptionHasBeenSet; }
125 template<typename DescriptionT = Aws::String>
126 void SetDescription(DescriptionT&& value) { m_descriptionHasBeenSet = true; m_description = std::forward<DescriptionT>(value); }
127 template<typename DescriptionT = Aws::String>
128 HIT& WithDescription(DescriptionT&& value) { SetDescription(std::forward<DescriptionT>(value)); return *this;}
130
132
137 inline const Aws::String& GetQuestion() const { return m_question; }
138 inline bool QuestionHasBeenSet() const { return m_questionHasBeenSet; }
139 template<typename QuestionT = Aws::String>
140 void SetQuestion(QuestionT&& value) { m_questionHasBeenSet = true; m_question = std::forward<QuestionT>(value); }
141 template<typename QuestionT = Aws::String>
142 HIT& WithQuestion(QuestionT&& value) { SetQuestion(std::forward<QuestionT>(value)); return *this;}
144
146
151 inline const Aws::String& GetKeywords() const { return m_keywords; }
152 inline bool KeywordsHasBeenSet() const { return m_keywordsHasBeenSet; }
153 template<typename KeywordsT = Aws::String>
154 void SetKeywords(KeywordsT&& value) { m_keywordsHasBeenSet = true; m_keywords = std::forward<KeywordsT>(value); }
155 template<typename KeywordsT = Aws::String>
156 HIT& WithKeywords(KeywordsT&& value) { SetKeywords(std::forward<KeywordsT>(value)); return *this;}
158
160
164 inline HITStatus GetHITStatus() const { return m_hITStatus; }
165 inline bool HITStatusHasBeenSet() const { return m_hITStatusHasBeenSet; }
166 inline void SetHITStatus(HITStatus value) { m_hITStatusHasBeenSet = true; m_hITStatus = value; }
167 inline HIT& WithHITStatus(HITStatus value) { SetHITStatus(value); return *this;}
169
171
175 inline int GetMaxAssignments() const { return m_maxAssignments; }
176 inline bool MaxAssignmentsHasBeenSet() const { return m_maxAssignmentsHasBeenSet; }
177 inline void SetMaxAssignments(int value) { m_maxAssignmentsHasBeenSet = true; m_maxAssignments = value; }
178 inline HIT& WithMaxAssignments(int value) { SetMaxAssignments(value); return *this;}
180
182
183 inline const Aws::String& GetReward() const { return m_reward; }
184 inline bool RewardHasBeenSet() const { return m_rewardHasBeenSet; }
185 template<typename RewardT = Aws::String>
186 void SetReward(RewardT&& value) { m_rewardHasBeenSet = true; m_reward = std::forward<RewardT>(value); }
187 template<typename RewardT = Aws::String>
188 HIT& WithReward(RewardT&& value) { SetReward(std::forward<RewardT>(value)); return *this;}
190
192
198 inline long long GetAutoApprovalDelayInSeconds() const { return m_autoApprovalDelayInSeconds; }
199 inline bool AutoApprovalDelayInSecondsHasBeenSet() const { return m_autoApprovalDelayInSecondsHasBeenSet; }
200 inline void SetAutoApprovalDelayInSeconds(long long value) { m_autoApprovalDelayInSecondsHasBeenSet = true; m_autoApprovalDelayInSeconds = value; }
201 inline HIT& WithAutoApprovalDelayInSeconds(long long value) { SetAutoApprovalDelayInSeconds(value); return *this;}
203
205
208 inline const Aws::Utils::DateTime& GetExpiration() const { return m_expiration; }
209 inline bool ExpirationHasBeenSet() const { return m_expirationHasBeenSet; }
210 template<typename ExpirationT = Aws::Utils::DateTime>
211 void SetExpiration(ExpirationT&& value) { m_expirationHasBeenSet = true; m_expiration = std::forward<ExpirationT>(value); }
212 template<typename ExpirationT = Aws::Utils::DateTime>
213 HIT& WithExpiration(ExpirationT&& value) { SetExpiration(std::forward<ExpirationT>(value)); return *this;}
215
217
221 inline long long GetAssignmentDurationInSeconds() const { return m_assignmentDurationInSeconds; }
222 inline bool AssignmentDurationInSecondsHasBeenSet() const { return m_assignmentDurationInSecondsHasBeenSet; }
223 inline void SetAssignmentDurationInSeconds(long long value) { m_assignmentDurationInSecondsHasBeenSet = true; m_assignmentDurationInSeconds = value; }
224 inline HIT& WithAssignmentDurationInSeconds(long long value) { SetAssignmentDurationInSeconds(value); return *this;}
226
228
232 inline const Aws::String& GetRequesterAnnotation() const { return m_requesterAnnotation; }
233 inline bool RequesterAnnotationHasBeenSet() const { return m_requesterAnnotationHasBeenSet; }
234 template<typename RequesterAnnotationT = Aws::String>
235 void SetRequesterAnnotation(RequesterAnnotationT&& value) { m_requesterAnnotationHasBeenSet = true; m_requesterAnnotation = std::forward<RequesterAnnotationT>(value); }
236 template<typename RequesterAnnotationT = Aws::String>
237 HIT& WithRequesterAnnotation(RequesterAnnotationT&& value) { SetRequesterAnnotation(std::forward<RequesterAnnotationT>(value)); return *this;}
239
241
248 inline const Aws::Vector<QualificationRequirement>& GetQualificationRequirements() const { return m_qualificationRequirements; }
249 inline bool QualificationRequirementsHasBeenSet() const { return m_qualificationRequirementsHasBeenSet; }
250 template<typename QualificationRequirementsT = Aws::Vector<QualificationRequirement>>
251 void SetQualificationRequirements(QualificationRequirementsT&& value) { m_qualificationRequirementsHasBeenSet = true; m_qualificationRequirements = std::forward<QualificationRequirementsT>(value); }
252 template<typename QualificationRequirementsT = Aws::Vector<QualificationRequirement>>
253 HIT& WithQualificationRequirements(QualificationRequirementsT&& value) { SetQualificationRequirements(std::forward<QualificationRequirementsT>(value)); return *this;}
254 template<typename QualificationRequirementsT = QualificationRequirement>
255 HIT& AddQualificationRequirements(QualificationRequirementsT&& value) { m_qualificationRequirementsHasBeenSet = true; m_qualificationRequirements.emplace_back(std::forward<QualificationRequirementsT>(value)); return *this; }
257
259
263 inline HITReviewStatus GetHITReviewStatus() const { return m_hITReviewStatus; }
264 inline bool HITReviewStatusHasBeenSet() const { return m_hITReviewStatusHasBeenSet; }
265 inline void SetHITReviewStatus(HITReviewStatus value) { m_hITReviewStatusHasBeenSet = true; m_hITReviewStatus = value; }
266 inline HIT& WithHITReviewStatus(HITReviewStatus value) { SetHITReviewStatus(value); return *this;}
268
270
275 inline int GetNumberOfAssignmentsPending() const { return m_numberOfAssignmentsPending; }
276 inline bool NumberOfAssignmentsPendingHasBeenSet() const { return m_numberOfAssignmentsPendingHasBeenSet; }
277 inline void SetNumberOfAssignmentsPending(int value) { m_numberOfAssignmentsPendingHasBeenSet = true; m_numberOfAssignmentsPending = value; }
278 inline HIT& WithNumberOfAssignmentsPending(int value) { SetNumberOfAssignmentsPending(value); return *this;}
280
282
286 inline int GetNumberOfAssignmentsAvailable() const { return m_numberOfAssignmentsAvailable; }
287 inline bool NumberOfAssignmentsAvailableHasBeenSet() const { return m_numberOfAssignmentsAvailableHasBeenSet; }
288 inline void SetNumberOfAssignmentsAvailable(int value) { m_numberOfAssignmentsAvailableHasBeenSet = true; m_numberOfAssignmentsAvailable = value; }
289 inline HIT& WithNumberOfAssignmentsAvailable(int value) { SetNumberOfAssignmentsAvailable(value); return *this;}
291
293
297 inline int GetNumberOfAssignmentsCompleted() const { return m_numberOfAssignmentsCompleted; }
298 inline bool NumberOfAssignmentsCompletedHasBeenSet() const { return m_numberOfAssignmentsCompletedHasBeenSet; }
299 inline void SetNumberOfAssignmentsCompleted(int value) { m_numberOfAssignmentsCompletedHasBeenSet = true; m_numberOfAssignmentsCompleted = value; }
300 inline HIT& WithNumberOfAssignmentsCompleted(int value) { SetNumberOfAssignmentsCompleted(value); return *this;}
302 private:
303
304 Aws::String m_hITId;
305 bool m_hITIdHasBeenSet = false;
306
307 Aws::String m_hITTypeId;
308 bool m_hITTypeIdHasBeenSet = false;
309
310 Aws::String m_hITGroupId;
311 bool m_hITGroupIdHasBeenSet = false;
312
313 Aws::String m_hITLayoutId;
314 bool m_hITLayoutIdHasBeenSet = false;
315
316 Aws::Utils::DateTime m_creationTime{};
317 bool m_creationTimeHasBeenSet = false;
318
319 Aws::String m_title;
320 bool m_titleHasBeenSet = false;
321
322 Aws::String m_description;
323 bool m_descriptionHasBeenSet = false;
324
325 Aws::String m_question;
326 bool m_questionHasBeenSet = false;
327
328 Aws::String m_keywords;
329 bool m_keywordsHasBeenSet = false;
330
331 HITStatus m_hITStatus{HITStatus::NOT_SET};
332 bool m_hITStatusHasBeenSet = false;
333
334 int m_maxAssignments{0};
335 bool m_maxAssignmentsHasBeenSet = false;
336
337 Aws::String m_reward;
338 bool m_rewardHasBeenSet = false;
339
340 long long m_autoApprovalDelayInSeconds{0};
341 bool m_autoApprovalDelayInSecondsHasBeenSet = false;
342
343 Aws::Utils::DateTime m_expiration{};
344 bool m_expirationHasBeenSet = false;
345
346 long long m_assignmentDurationInSeconds{0};
347 bool m_assignmentDurationInSecondsHasBeenSet = false;
348
349 Aws::String m_requesterAnnotation;
350 bool m_requesterAnnotationHasBeenSet = false;
351
352 Aws::Vector<QualificationRequirement> m_qualificationRequirements;
353 bool m_qualificationRequirementsHasBeenSet = false;
354
355 HITReviewStatus m_hITReviewStatus{HITReviewStatus::NOT_SET};
356 bool m_hITReviewStatusHasBeenSet = false;
357
358 int m_numberOfAssignmentsPending{0};
359 bool m_numberOfAssignmentsPendingHasBeenSet = false;
360
361 int m_numberOfAssignmentsAvailable{0};
362 bool m_numberOfAssignmentsAvailableHasBeenSet = false;
363
364 int m_numberOfAssignmentsCompleted{0};
365 bool m_numberOfAssignmentsCompletedHasBeenSet = false;
366 };
367
368} // namespace Model
369} // namespace MTurk
370} // namespace Aws
HIT & WithAssignmentDurationInSeconds(long long value)
Definition HIT.h:224
void SetReward(RewardT &&value)
Definition HIT.h:186
const Aws::String & GetTitle() const
Definition HIT.h:111
const Aws::Utils::DateTime & GetExpiration() const
Definition HIT.h:208
const Aws::String & GetDescription() const
Definition HIT.h:123
const Aws::String & GetReward() const
Definition HIT.h:183
HIT & WithQualificationRequirements(QualificationRequirementsT &&value)
Definition HIT.h:253
void SetMaxAssignments(int value)
Definition HIT.h:177
bool DescriptionHasBeenSet() const
Definition HIT.h:124
bool CreationTimeHasBeenSet() const
Definition HIT.h:100
const Aws::String & GetHITLayoutId() const
Definition HIT.h:87
void SetNumberOfAssignmentsPending(int value)
Definition HIT.h:277
bool HITTypeIdHasBeenSet() const
Definition HIT.h:64
long long GetAutoApprovalDelayInSeconds() const
Definition HIT.h:198
const Aws::String & GetKeywords() const
Definition HIT.h:151
bool TitleHasBeenSet() const
Definition HIT.h:112
HIT & WithMaxAssignments(int value)
Definition HIT.h:178
HIT & WithHITStatus(HITStatus value)
Definition HIT.h:167
void SetAssignmentDurationInSeconds(long long value)
Definition HIT.h:223
bool HITGroupIdHasBeenSet() const
Definition HIT.h:76
HIT & AddQualificationRequirements(QualificationRequirementsT &&value)
Definition HIT.h:255
HIT & WithAutoApprovalDelayInSeconds(long long value)
Definition HIT.h:201
void SetHITStatus(HITStatus value)
Definition HIT.h:166
void SetNumberOfAssignmentsCompleted(int value)
Definition HIT.h:299
bool MaxAssignmentsHasBeenSet() const
Definition HIT.h:176
AWS_MTURK_API Aws::Utils::Json::JsonValue Jsonize() const
HIT & WithHITId(HITIdT &&value)
Definition HIT.h:56
bool NumberOfAssignmentsAvailableHasBeenSet() const
Definition HIT.h:287
HIT & WithRequesterAnnotation(RequesterAnnotationT &&value)
Definition HIT.h:237
HIT & WithDescription(DescriptionT &&value)
Definition HIT.h:128
HIT & WithHITLayoutId(HITLayoutIdT &&value)
Definition HIT.h:92
HIT & WithCreationTime(CreationTimeT &&value)
Definition HIT.h:104
HIT & WithQuestion(QuestionT &&value)
Definition HIT.h:142
bool HITLayoutIdHasBeenSet() const
Definition HIT.h:88
void SetDescription(DescriptionT &&value)
Definition HIT.h:126
bool HITIdHasBeenSet() const
Definition HIT.h:52
HIT & WithExpiration(ExpirationT &&value)
Definition HIT.h:213
int GetNumberOfAssignmentsPending() const
Definition HIT.h:275
HIT & WithKeywords(KeywordsT &&value)
Definition HIT.h:156
void SetExpiration(ExpirationT &&value)
Definition HIT.h:211
AWS_MTURK_API HIT()=default
AWS_MTURK_API HIT(Aws::Utils::Json::JsonView jsonValue)
void SetHITId(HITIdT &&value)
Definition HIT.h:54
HITStatus GetHITStatus() const
Definition HIT.h:164
HIT & WithNumberOfAssignmentsCompleted(int value)
Definition HIT.h:300
HIT & WithReward(RewardT &&value)
Definition HIT.h:188
HIT & WithHITReviewStatus(HITReviewStatus value)
Definition HIT.h:266
HIT & WithNumberOfAssignmentsPending(int value)
Definition HIT.h:278
bool NumberOfAssignmentsPendingHasBeenSet() const
Definition HIT.h:276
void SetKeywords(KeywordsT &&value)
Definition HIT.h:154
const Aws::String & GetQuestion() const
Definition HIT.h:137
int GetMaxAssignments() const
Definition HIT.h:175
bool RewardHasBeenSet() const
Definition HIT.h:184
const Aws::Vector< QualificationRequirement > & GetQualificationRequirements() const
Definition HIT.h:248
bool KeywordsHasBeenSet() const
Definition HIT.h:152
bool AutoApprovalDelayInSecondsHasBeenSet() const
Definition HIT.h:199
void SetAutoApprovalDelayInSeconds(long long value)
Definition HIT.h:200
const Aws::String & GetRequesterAnnotation() const
Definition HIT.h:232
int GetNumberOfAssignmentsCompleted() const
Definition HIT.h:297
void SetQuestion(QuestionT &&value)
Definition HIT.h:140
void SetNumberOfAssignmentsAvailable(int value)
Definition HIT.h:288
bool QualificationRequirementsHasBeenSet() const
Definition HIT.h:249
void SetTitle(TitleT &&value)
Definition HIT.h:114
void SetCreationTime(CreationTimeT &&value)
Definition HIT.h:102
bool QuestionHasBeenSet() const
Definition HIT.h:138
const Aws::String & GetHITGroupId() const
Definition HIT.h:75
const Aws::String & GetHITId() const
Definition HIT.h:51
AWS_MTURK_API HIT & operator=(Aws::Utils::Json::JsonView jsonValue)
void SetHITReviewStatus(HITReviewStatus value)
Definition HIT.h:265
long long GetAssignmentDurationInSeconds() const
Definition HIT.h:221
bool AssignmentDurationInSecondsHasBeenSet() const
Definition HIT.h:222
bool RequesterAnnotationHasBeenSet() const
Definition HIT.h:233
void SetHITTypeId(HITTypeIdT &&value)
Definition HIT.h:66
const Aws::String & GetHITTypeId() const
Definition HIT.h:63
bool ExpirationHasBeenSet() const
Definition HIT.h:209
int GetNumberOfAssignmentsAvailable() const
Definition HIT.h:286
void SetHITGroupId(HITGroupIdT &&value)
Definition HIT.h:78
bool HITReviewStatusHasBeenSet() const
Definition HIT.h:264
const Aws::Utils::DateTime & GetCreationTime() const
Definition HIT.h:99
bool HITStatusHasBeenSet() const
Definition HIT.h:165
bool NumberOfAssignmentsCompletedHasBeenSet() const
Definition HIT.h:298
HIT & WithHITTypeId(HITTypeIdT &&value)
Definition HIT.h:68
HITReviewStatus GetHITReviewStatus() const
Definition HIT.h:263
HIT & WithHITGroupId(HITGroupIdT &&value)
Definition HIT.h:80
HIT & WithTitle(TitleT &&value)
Definition HIT.h:116
void SetRequesterAnnotation(RequesterAnnotationT &&value)
Definition HIT.h:235
void SetQualificationRequirements(QualificationRequirementsT &&value)
Definition HIT.h:251
void SetHITLayoutId(HITLayoutIdT &&value)
Definition HIT.h:90
HIT & WithNumberOfAssignmentsAvailable(int value)
Definition HIT.h:289
std::basic_string< char, std::char_traits< char >, Aws::Allocator< char > > String
std::vector< T, Aws::Allocator< T > > Vector
Aws::Utils::Json::JsonValue JsonValue