AWS SDK for C++  1.9.132
AWS SDK for C++
Public Member Functions | List of all members
Aws::MTurk::Model::HIT Class Reference

#include <HIT.h>

Public Member Functions

 HIT ()
 
 HIT (Aws::Utils::Json::JsonView jsonValue)
 
HIToperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetHITId () const
 
bool HITIdHasBeenSet () const
 
void SetHITId (const Aws::String &value)
 
void SetHITId (Aws::String &&value)
 
void SetHITId (const char *value)
 
HITWithHITId (const Aws::String &value)
 
HITWithHITId (Aws::String &&value)
 
HITWithHITId (const char *value)
 
const Aws::StringGetHITTypeId () const
 
bool HITTypeIdHasBeenSet () const
 
void SetHITTypeId (const Aws::String &value)
 
void SetHITTypeId (Aws::String &&value)
 
void SetHITTypeId (const char *value)
 
HITWithHITTypeId (const Aws::String &value)
 
HITWithHITTypeId (Aws::String &&value)
 
HITWithHITTypeId (const char *value)
 
const Aws::StringGetHITGroupId () const
 
bool HITGroupIdHasBeenSet () const
 
void SetHITGroupId (const Aws::String &value)
 
void SetHITGroupId (Aws::String &&value)
 
void SetHITGroupId (const char *value)
 
HITWithHITGroupId (const Aws::String &value)
 
HITWithHITGroupId (Aws::String &&value)
 
HITWithHITGroupId (const char *value)
 
const Aws::StringGetHITLayoutId () const
 
bool HITLayoutIdHasBeenSet () const
 
void SetHITLayoutId (const Aws::String &value)
 
void SetHITLayoutId (Aws::String &&value)
 
void SetHITLayoutId (const char *value)
 
HITWithHITLayoutId (const Aws::String &value)
 
HITWithHITLayoutId (Aws::String &&value)
 
HITWithHITLayoutId (const char *value)
 
const Aws::Utils::DateTimeGetCreationTime () const
 
bool CreationTimeHasBeenSet () const
 
void SetCreationTime (const Aws::Utils::DateTime &value)
 
void SetCreationTime (Aws::Utils::DateTime &&value)
 
HITWithCreationTime (const Aws::Utils::DateTime &value)
 
HITWithCreationTime (Aws::Utils::DateTime &&value)
 
const Aws::StringGetTitle () const
 
bool TitleHasBeenSet () const
 
void SetTitle (const Aws::String &value)
 
void SetTitle (Aws::String &&value)
 
void SetTitle (const char *value)
 
HITWithTitle (const Aws::String &value)
 
HITWithTitle (Aws::String &&value)
 
HITWithTitle (const char *value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
HITWithDescription (const Aws::String &value)
 
HITWithDescription (Aws::String &&value)
 
HITWithDescription (const char *value)
 
const Aws::StringGetQuestion () const
 
bool QuestionHasBeenSet () const
 
void SetQuestion (const Aws::String &value)
 
void SetQuestion (Aws::String &&value)
 
void SetQuestion (const char *value)
 
HITWithQuestion (const Aws::String &value)
 
HITWithQuestion (Aws::String &&value)
 
HITWithQuestion (const char *value)
 
const Aws::StringGetKeywords () const
 
bool KeywordsHasBeenSet () const
 
void SetKeywords (const Aws::String &value)
 
void SetKeywords (Aws::String &&value)
 
void SetKeywords (const char *value)
 
HITWithKeywords (const Aws::String &value)
 
HITWithKeywords (Aws::String &&value)
 
HITWithKeywords (const char *value)
 
const HITStatusGetHITStatus () const
 
bool HITStatusHasBeenSet () const
 
void SetHITStatus (const HITStatus &value)
 
void SetHITStatus (HITStatus &&value)
 
HITWithHITStatus (const HITStatus &value)
 
HITWithHITStatus (HITStatus &&value)
 
int GetMaxAssignments () const
 
bool MaxAssignmentsHasBeenSet () const
 
void SetMaxAssignments (int value)
 
HITWithMaxAssignments (int value)
 
const Aws::StringGetReward () const
 
bool RewardHasBeenSet () const
 
void SetReward (const Aws::String &value)
 
void SetReward (Aws::String &&value)
 
void SetReward (const char *value)
 
HITWithReward (const Aws::String &value)
 
HITWithReward (Aws::String &&value)
 
HITWithReward (const char *value)
 
long long GetAutoApprovalDelayInSeconds () const
 
bool AutoApprovalDelayInSecondsHasBeenSet () const
 
void SetAutoApprovalDelayInSeconds (long long value)
 
HITWithAutoApprovalDelayInSeconds (long long value)
 
const Aws::Utils::DateTimeGetExpiration () const
 
bool ExpirationHasBeenSet () const
 
void SetExpiration (const Aws::Utils::DateTime &value)
 
void SetExpiration (Aws::Utils::DateTime &&value)
 
HITWithExpiration (const Aws::Utils::DateTime &value)
 
HITWithExpiration (Aws::Utils::DateTime &&value)
 
long long GetAssignmentDurationInSeconds () const
 
bool AssignmentDurationInSecondsHasBeenSet () const
 
void SetAssignmentDurationInSeconds (long long value)
 
HITWithAssignmentDurationInSeconds (long long value)
 
const Aws::StringGetRequesterAnnotation () const
 
bool RequesterAnnotationHasBeenSet () const
 
void SetRequesterAnnotation (const Aws::String &value)
 
void SetRequesterAnnotation (Aws::String &&value)
 
void SetRequesterAnnotation (const char *value)
 
HITWithRequesterAnnotation (const Aws::String &value)
 
HITWithRequesterAnnotation (Aws::String &&value)
 
HITWithRequesterAnnotation (const char *value)
 
const Aws::Vector< QualificationRequirement > & GetQualificationRequirements () const
 
bool QualificationRequirementsHasBeenSet () const
 
void SetQualificationRequirements (const Aws::Vector< QualificationRequirement > &value)
 
void SetQualificationRequirements (Aws::Vector< QualificationRequirement > &&value)
 
HITWithQualificationRequirements (const Aws::Vector< QualificationRequirement > &value)
 
HITWithQualificationRequirements (Aws::Vector< QualificationRequirement > &&value)
 
HITAddQualificationRequirements (const QualificationRequirement &value)
 
HITAddQualificationRequirements (QualificationRequirement &&value)
 
const HITReviewStatusGetHITReviewStatus () const
 
bool HITReviewStatusHasBeenSet () const
 
void SetHITReviewStatus (const HITReviewStatus &value)
 
void SetHITReviewStatus (HITReviewStatus &&value)
 
HITWithHITReviewStatus (const HITReviewStatus &value)
 
HITWithHITReviewStatus (HITReviewStatus &&value)
 
int GetNumberOfAssignmentsPending () const
 
bool NumberOfAssignmentsPendingHasBeenSet () const
 
void SetNumberOfAssignmentsPending (int value)
 
HITWithNumberOfAssignmentsPending (int value)
 
int GetNumberOfAssignmentsAvailable () const
 
bool NumberOfAssignmentsAvailableHasBeenSet () const
 
void SetNumberOfAssignmentsAvailable (int value)
 
HITWithNumberOfAssignmentsAvailable (int value)
 
int GetNumberOfAssignmentsCompleted () const
 
bool NumberOfAssignmentsCompletedHasBeenSet () const
 
void SetNumberOfAssignmentsCompleted (int value)
 
HITWithNumberOfAssignmentsCompleted (int value)
 

Detailed Description

The HIT data structure represents a single HIT, including all the information necessary for a Worker to accept and complete the HIT.

See Also:

AWS API Reference

Definition at line 38 of file HIT.h.

Constructor & Destructor Documentation

◆ HIT() [1/2]

Aws::MTurk::Model::HIT::HIT ( )

◆ HIT() [2/2]

Aws::MTurk::Model::HIT::HIT ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddQualificationRequirements() [1/2]

HIT& Aws::MTurk::Model::HIT::AddQualificationRequirements ( const QualificationRequirement value)
inline

Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure.

Definition at line 724 of file HIT.h.

◆ AddQualificationRequirements() [2/2]

HIT& Aws::MTurk::Model::HIT::AddQualificationRequirements ( QualificationRequirement &&  value)
inline

Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure.

Definition at line 733 of file HIT.h.

◆ AssignmentDurationInSecondsHasBeenSet()

bool Aws::MTurk::Model::HIT::AssignmentDurationInSecondsHasBeenSet ( ) const
inline

The length of time, in seconds, that a Worker has to complete the HIT after accepting it.

Definition at line 599 of file HIT.h.

◆ AutoApprovalDelayInSecondsHasBeenSet()

bool Aws::MTurk::Model::HIT::AutoApprovalDelayInSecondsHasBeenSet ( ) const
inline

The amount of time, in seconds, after the Worker submits an assignment for the HIT that the results are automatically approved by Amazon Mechanical Turk. This is the amount of time the Requester has to reject an assignment submitted by a Worker before the assignment is auto-approved and the Worker is paid.

Definition at line 539 of file HIT.h.

◆ CreationTimeHasBeenSet()

bool Aws::MTurk::Model::HIT::CreationTimeHasBeenSet ( ) const
inline

The date and time the HIT was created.

Definition at line 219 of file HIT.h.

◆ DescriptionHasBeenSet()

bool Aws::MTurk::Model::HIT::DescriptionHasBeenSet ( ) const
inline

A general description of the HIT.

Definition at line 291 of file HIT.h.

◆ ExpirationHasBeenSet()

bool Aws::MTurk::Model::HIT::ExpirationHasBeenSet ( ) const
inline

The date and time the HIT expires.

Definition at line 566 of file HIT.h.

◆ GetAssignmentDurationInSeconds()

long long Aws::MTurk::Model::HIT::GetAssignmentDurationInSeconds ( ) const
inline

The length of time, in seconds, that a Worker has to complete the HIT after accepting it.

Definition at line 593 of file HIT.h.

◆ GetAutoApprovalDelayInSeconds()

long long Aws::MTurk::Model::HIT::GetAutoApprovalDelayInSeconds ( ) const
inline

The amount of time, in seconds, after the Worker submits an assignment for the HIT that the results are automatically approved by Amazon Mechanical Turk. This is the amount of time the Requester has to reject an assignment submitted by a Worker before the assignment is auto-approved and the Worker is paid.

Definition at line 531 of file HIT.h.

◆ GetCreationTime()

const Aws::Utils::DateTime& Aws::MTurk::Model::HIT::GetCreationTime ( ) const
inline

The date and time the HIT was created.

Definition at line 214 of file HIT.h.

◆ GetDescription()

const Aws::String& Aws::MTurk::Model::HIT::GetDescription ( ) const
inline

A general description of the HIT.

Definition at line 286 of file HIT.h.

◆ GetExpiration()

const Aws::Utils::DateTime& Aws::MTurk::Model::HIT::GetExpiration ( ) const
inline

The date and time the HIT expires.

Definition at line 561 of file HIT.h.

◆ GetHITGroupId()

const Aws::String& Aws::MTurk::Model::HIT::GetHITGroupId ( ) const
inline

The ID of the HIT Group of this HIT.

Definition at line 132 of file HIT.h.

◆ GetHITId()

const Aws::String& Aws::MTurk::Model::HIT::GetHITId ( ) const
inline

A unique identifier for the HIT.

Definition at line 50 of file HIT.h.

◆ GetHITLayoutId()

const Aws::String& Aws::MTurk::Model::HIT::GetHITLayoutId ( ) const
inline

The ID of the HIT Layout of this HIT.

Definition at line 173 of file HIT.h.

◆ GetHITReviewStatus()

const HITReviewStatus& Aws::MTurk::Model::HIT::GetHITReviewStatus ( ) const
inline

Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

Definition at line 740 of file HIT.h.

◆ GetHITStatus()

const HITStatus& Aws::MTurk::Model::HIT::GetHITStatus ( ) const
inline

The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

Definition at line 442 of file HIT.h.

◆ GetHITTypeId()

const Aws::String& Aws::MTurk::Model::HIT::GetHITTypeId ( ) const
inline

The ID of the HIT type of this HIT

Definition at line 91 of file HIT.h.

◆ GetKeywords()

const Aws::String& Aws::MTurk::Model::HIT::GetKeywords ( ) const
inline

One or more words or phrases that describe the HIT, separated by commas. Search terms similar to the keywords of a HIT are more likely to have the HIT in the search results.

Definition at line 386 of file HIT.h.

◆ GetMaxAssignments()

int Aws::MTurk::Model::HIT::GetMaxAssignments ( ) const
inline

The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

Definition at line 479 of file HIT.h.

◆ GetNumberOfAssignmentsAvailable()

int Aws::MTurk::Model::HIT::GetNumberOfAssignmentsAvailable ( ) const
inline

The number of assignments for this HIT that are available for Workers to accept.

Definition at line 806 of file HIT.h.

◆ GetNumberOfAssignmentsCompleted()

int Aws::MTurk::Model::HIT::GetNumberOfAssignmentsCompleted ( ) const
inline

The number of assignments for this HIT that have been approved or rejected.

Definition at line 831 of file HIT.h.

◆ GetNumberOfAssignmentsPending()

int Aws::MTurk::Model::HIT::GetNumberOfAssignmentsPending ( ) const
inline

The number of assignments for this HIT that are being previewed or have been accepted by Workers, but have not yet been submitted, returned, or abandoned.

Definition at line 778 of file HIT.h.

◆ GetQualificationRequirements()

const Aws::Vector<QualificationRequirement>& Aws::MTurk::Model::HIT::GetQualificationRequirements ( ) const
inline

Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure.

Definition at line 670 of file HIT.h.

◆ GetQuestion()

const Aws::String& Aws::MTurk::Model::HIT::GetQuestion ( ) const
inline

The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

Definition at line 329 of file HIT.h.

◆ GetRequesterAnnotation()

const Aws::String& Aws::MTurk::Model::HIT::GetRequesterAnnotation ( ) const
inline

An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

Definition at line 618 of file HIT.h.

◆ GetReward()

const Aws::String& Aws::MTurk::Model::HIT::GetReward ( ) const
inline

Definition at line 501 of file HIT.h.

◆ GetTitle()

const Aws::String& Aws::MTurk::Model::HIT::GetTitle ( ) const
inline

The title of the HIT.

Definition at line 245 of file HIT.h.

◆ HITGroupIdHasBeenSet()

bool Aws::MTurk::Model::HIT::HITGroupIdHasBeenSet ( ) const
inline

The ID of the HIT Group of this HIT.

Definition at line 137 of file HIT.h.

◆ HITIdHasBeenSet()

bool Aws::MTurk::Model::HIT::HITIdHasBeenSet ( ) const
inline

A unique identifier for the HIT.

Definition at line 55 of file HIT.h.

◆ HITLayoutIdHasBeenSet()

bool Aws::MTurk::Model::HIT::HITLayoutIdHasBeenSet ( ) const
inline

The ID of the HIT Layout of this HIT.

Definition at line 178 of file HIT.h.

◆ HITReviewStatusHasBeenSet()

bool Aws::MTurk::Model::HIT::HITReviewStatusHasBeenSet ( ) const
inline

Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

Definition at line 746 of file HIT.h.

◆ HITStatusHasBeenSet()

bool Aws::MTurk::Model::HIT::HITStatusHasBeenSet ( ) const
inline

The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

Definition at line 448 of file HIT.h.

◆ HITTypeIdHasBeenSet()

bool Aws::MTurk::Model::HIT::HITTypeIdHasBeenSet ( ) const
inline

The ID of the HIT type of this HIT

Definition at line 96 of file HIT.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::MTurk::Model::HIT::Jsonize ( ) const

◆ KeywordsHasBeenSet()

bool Aws::MTurk::Model::HIT::KeywordsHasBeenSet ( ) const
inline

One or more words or phrases that describe the HIT, separated by commas. Search terms similar to the keywords of a HIT are more likely to have the HIT in the search results.

Definition at line 393 of file HIT.h.

◆ MaxAssignmentsHasBeenSet()

bool Aws::MTurk::Model::HIT::MaxAssignmentsHasBeenSet ( ) const
inline

The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

Definition at line 485 of file HIT.h.

◆ NumberOfAssignmentsAvailableHasBeenSet()

bool Aws::MTurk::Model::HIT::NumberOfAssignmentsAvailableHasBeenSet ( ) const
inline

The number of assignments for this HIT that are available for Workers to accept.

Definition at line 812 of file HIT.h.

◆ NumberOfAssignmentsCompletedHasBeenSet()

bool Aws::MTurk::Model::HIT::NumberOfAssignmentsCompletedHasBeenSet ( ) const
inline

The number of assignments for this HIT that have been approved or rejected.

Definition at line 837 of file HIT.h.

◆ NumberOfAssignmentsPendingHasBeenSet()

bool Aws::MTurk::Model::HIT::NumberOfAssignmentsPendingHasBeenSet ( ) const
inline

The number of assignments for this HIT that are being previewed or have been accepted by Workers, but have not yet been submitted, returned, or abandoned.

Definition at line 785 of file HIT.h.

◆ operator=()

HIT& Aws::MTurk::Model::HIT::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ QualificationRequirementsHasBeenSet()

bool Aws::MTurk::Model::HIT::QualificationRequirementsHasBeenSet ( ) const
inline

Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure.

Definition at line 679 of file HIT.h.

◆ QuestionHasBeenSet()

bool Aws::MTurk::Model::HIT::QuestionHasBeenSet ( ) const
inline

The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

Definition at line 336 of file HIT.h.

◆ RequesterAnnotationHasBeenSet()

bool Aws::MTurk::Model::HIT::RequesterAnnotationHasBeenSet ( ) const
inline

An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

Definition at line 624 of file HIT.h.

◆ RewardHasBeenSet()

bool Aws::MTurk::Model::HIT::RewardHasBeenSet ( ) const
inline

Definition at line 504 of file HIT.h.

◆ SetAssignmentDurationInSeconds()

void Aws::MTurk::Model::HIT::SetAssignmentDurationInSeconds ( long long  value)
inline

The length of time, in seconds, that a Worker has to complete the HIT after accepting it.

Definition at line 605 of file HIT.h.

◆ SetAutoApprovalDelayInSeconds()

void Aws::MTurk::Model::HIT::SetAutoApprovalDelayInSeconds ( long long  value)
inline

The amount of time, in seconds, after the Worker submits an assignment for the HIT that the results are automatically approved by Amazon Mechanical Turk. This is the amount of time the Requester has to reject an assignment submitted by a Worker before the assignment is auto-approved and the Worker is paid.

Definition at line 547 of file HIT.h.

◆ SetCreationTime() [1/2]

void Aws::MTurk::Model::HIT::SetCreationTime ( Aws::Utils::DateTime &&  value)
inline

The date and time the HIT was created.

Definition at line 229 of file HIT.h.

◆ SetCreationTime() [2/2]

void Aws::MTurk::Model::HIT::SetCreationTime ( const Aws::Utils::DateTime value)
inline

The date and time the HIT was created.

Definition at line 224 of file HIT.h.

◆ SetDescription() [1/3]

void Aws::MTurk::Model::HIT::SetDescription ( Aws::String &&  value)
inline

A general description of the HIT.

Definition at line 301 of file HIT.h.

◆ SetDescription() [2/3]

void Aws::MTurk::Model::HIT::SetDescription ( const Aws::String value)
inline

A general description of the HIT.

Definition at line 296 of file HIT.h.

◆ SetDescription() [3/3]

void Aws::MTurk::Model::HIT::SetDescription ( const char *  value)
inline

A general description of the HIT.

Definition at line 306 of file HIT.h.

◆ SetExpiration() [1/2]

void Aws::MTurk::Model::HIT::SetExpiration ( Aws::Utils::DateTime &&  value)
inline

The date and time the HIT expires.

Definition at line 576 of file HIT.h.

◆ SetExpiration() [2/2]

void Aws::MTurk::Model::HIT::SetExpiration ( const Aws::Utils::DateTime value)
inline

The date and time the HIT expires.

Definition at line 571 of file HIT.h.

◆ SetHITGroupId() [1/3]

void Aws::MTurk::Model::HIT::SetHITGroupId ( Aws::String &&  value)
inline

The ID of the HIT Group of this HIT.

Definition at line 147 of file HIT.h.

◆ SetHITGroupId() [2/3]

void Aws::MTurk::Model::HIT::SetHITGroupId ( const Aws::String value)
inline

The ID of the HIT Group of this HIT.

Definition at line 142 of file HIT.h.

◆ SetHITGroupId() [3/3]

void Aws::MTurk::Model::HIT::SetHITGroupId ( const char *  value)
inline

The ID of the HIT Group of this HIT.

Definition at line 152 of file HIT.h.

◆ SetHITId() [1/3]

void Aws::MTurk::Model::HIT::SetHITId ( Aws::String &&  value)
inline

A unique identifier for the HIT.

Definition at line 65 of file HIT.h.

◆ SetHITId() [2/3]

void Aws::MTurk::Model::HIT::SetHITId ( const Aws::String value)
inline

A unique identifier for the HIT.

Definition at line 60 of file HIT.h.

◆ SetHITId() [3/3]

void Aws::MTurk::Model::HIT::SetHITId ( const char *  value)
inline

A unique identifier for the HIT.

Definition at line 70 of file HIT.h.

◆ SetHITLayoutId() [1/3]

void Aws::MTurk::Model::HIT::SetHITLayoutId ( Aws::String &&  value)
inline

The ID of the HIT Layout of this HIT.

Definition at line 188 of file HIT.h.

◆ SetHITLayoutId() [2/3]

void Aws::MTurk::Model::HIT::SetHITLayoutId ( const Aws::String value)
inline

The ID of the HIT Layout of this HIT.

Definition at line 183 of file HIT.h.

◆ SetHITLayoutId() [3/3]

void Aws::MTurk::Model::HIT::SetHITLayoutId ( const char *  value)
inline

The ID of the HIT Layout of this HIT.

Definition at line 193 of file HIT.h.

◆ SetHITReviewStatus() [1/2]

void Aws::MTurk::Model::HIT::SetHITReviewStatus ( const HITReviewStatus value)
inline

Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

Definition at line 752 of file HIT.h.

◆ SetHITReviewStatus() [2/2]

void Aws::MTurk::Model::HIT::SetHITReviewStatus ( HITReviewStatus &&  value)
inline

Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

Definition at line 758 of file HIT.h.

◆ SetHITStatus() [1/2]

void Aws::MTurk::Model::HIT::SetHITStatus ( const HITStatus value)
inline

The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

Definition at line 454 of file HIT.h.

◆ SetHITStatus() [2/2]

void Aws::MTurk::Model::HIT::SetHITStatus ( HITStatus &&  value)
inline

The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

Definition at line 460 of file HIT.h.

◆ SetHITTypeId() [1/3]

void Aws::MTurk::Model::HIT::SetHITTypeId ( Aws::String &&  value)
inline

The ID of the HIT type of this HIT

Definition at line 106 of file HIT.h.

◆ SetHITTypeId() [2/3]

void Aws::MTurk::Model::HIT::SetHITTypeId ( const Aws::String value)
inline

The ID of the HIT type of this HIT

Definition at line 101 of file HIT.h.

◆ SetHITTypeId() [3/3]

void Aws::MTurk::Model::HIT::SetHITTypeId ( const char *  value)
inline

The ID of the HIT type of this HIT

Definition at line 111 of file HIT.h.

◆ SetKeywords() [1/3]

void Aws::MTurk::Model::HIT::SetKeywords ( Aws::String &&  value)
inline

One or more words or phrases that describe the HIT, separated by commas. Search terms similar to the keywords of a HIT are more likely to have the HIT in the search results.

Definition at line 407 of file HIT.h.

◆ SetKeywords() [2/3]

void Aws::MTurk::Model::HIT::SetKeywords ( const Aws::String value)
inline

One or more words or phrases that describe the HIT, separated by commas. Search terms similar to the keywords of a HIT are more likely to have the HIT in the search results.

Definition at line 400 of file HIT.h.

◆ SetKeywords() [3/3]

void Aws::MTurk::Model::HIT::SetKeywords ( const char *  value)
inline

One or more words or phrases that describe the HIT, separated by commas. Search terms similar to the keywords of a HIT are more likely to have the HIT in the search results.

Definition at line 414 of file HIT.h.

◆ SetMaxAssignments()

void Aws::MTurk::Model::HIT::SetMaxAssignments ( int  value)
inline

The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

Definition at line 491 of file HIT.h.

◆ SetNumberOfAssignmentsAvailable()

void Aws::MTurk::Model::HIT::SetNumberOfAssignmentsAvailable ( int  value)
inline

The number of assignments for this HIT that are available for Workers to accept.

Definition at line 818 of file HIT.h.

◆ SetNumberOfAssignmentsCompleted()

void Aws::MTurk::Model::HIT::SetNumberOfAssignmentsCompleted ( int  value)
inline

The number of assignments for this HIT that have been approved or rejected.

Definition at line 843 of file HIT.h.

◆ SetNumberOfAssignmentsPending()

void Aws::MTurk::Model::HIT::SetNumberOfAssignmentsPending ( int  value)
inline

The number of assignments for this HIT that are being previewed or have been accepted by Workers, but have not yet been submitted, returned, or abandoned.

Definition at line 792 of file HIT.h.

◆ SetQualificationRequirements() [1/2]

void Aws::MTurk::Model::HIT::SetQualificationRequirements ( Aws::Vector< QualificationRequirement > &&  value)
inline

Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure.

Definition at line 697 of file HIT.h.

◆ SetQualificationRequirements() [2/2]

void Aws::MTurk::Model::HIT::SetQualificationRequirements ( const Aws::Vector< QualificationRequirement > &  value)
inline

Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure.

Definition at line 688 of file HIT.h.

◆ SetQuestion() [1/3]

void Aws::MTurk::Model::HIT::SetQuestion ( Aws::String &&  value)
inline

The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

Definition at line 350 of file HIT.h.

◆ SetQuestion() [2/3]

void Aws::MTurk::Model::HIT::SetQuestion ( const Aws::String value)
inline

The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

Definition at line 343 of file HIT.h.

◆ SetQuestion() [3/3]

void Aws::MTurk::Model::HIT::SetQuestion ( const char *  value)
inline

The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

Definition at line 357 of file HIT.h.

◆ SetRequesterAnnotation() [1/3]

void Aws::MTurk::Model::HIT::SetRequesterAnnotation ( Aws::String &&  value)
inline

An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

Definition at line 636 of file HIT.h.

◆ SetRequesterAnnotation() [2/3]

void Aws::MTurk::Model::HIT::SetRequesterAnnotation ( const Aws::String value)
inline

An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

Definition at line 630 of file HIT.h.

◆ SetRequesterAnnotation() [3/3]

void Aws::MTurk::Model::HIT::SetRequesterAnnotation ( const char *  value)
inline

An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

Definition at line 642 of file HIT.h.

◆ SetReward() [1/3]

void Aws::MTurk::Model::HIT::SetReward ( Aws::String &&  value)
inline

Definition at line 510 of file HIT.h.

◆ SetReward() [2/3]

void Aws::MTurk::Model::HIT::SetReward ( const Aws::String value)
inline

Definition at line 507 of file HIT.h.

◆ SetReward() [3/3]

void Aws::MTurk::Model::HIT::SetReward ( const char *  value)
inline

Definition at line 513 of file HIT.h.

◆ SetTitle() [1/3]

void Aws::MTurk::Model::HIT::SetTitle ( Aws::String &&  value)
inline

The title of the HIT.

Definition at line 260 of file HIT.h.

◆ SetTitle() [2/3]

void Aws::MTurk::Model::HIT::SetTitle ( const Aws::String value)
inline

The title of the HIT.

Definition at line 255 of file HIT.h.

◆ SetTitle() [3/3]

void Aws::MTurk::Model::HIT::SetTitle ( const char *  value)
inline

The title of the HIT.

Definition at line 265 of file HIT.h.

◆ TitleHasBeenSet()

bool Aws::MTurk::Model::HIT::TitleHasBeenSet ( ) const
inline

The title of the HIT.

Definition at line 250 of file HIT.h.

◆ WithAssignmentDurationInSeconds()

HIT& Aws::MTurk::Model::HIT::WithAssignmentDurationInSeconds ( long long  value)
inline

The length of time, in seconds, that a Worker has to complete the HIT after accepting it.

Definition at line 611 of file HIT.h.

◆ WithAutoApprovalDelayInSeconds()

HIT& Aws::MTurk::Model::HIT::WithAutoApprovalDelayInSeconds ( long long  value)
inline

The amount of time, in seconds, after the Worker submits an assignment for the HIT that the results are automatically approved by Amazon Mechanical Turk. This is the amount of time the Requester has to reject an assignment submitted by a Worker before the assignment is auto-approved and the Worker is paid.

Definition at line 555 of file HIT.h.

◆ WithCreationTime() [1/2]

HIT& Aws::MTurk::Model::HIT::WithCreationTime ( Aws::Utils::DateTime &&  value)
inline

The date and time the HIT was created.

Definition at line 239 of file HIT.h.

◆ WithCreationTime() [2/2]

HIT& Aws::MTurk::Model::HIT::WithCreationTime ( const Aws::Utils::DateTime value)
inline

The date and time the HIT was created.

Definition at line 234 of file HIT.h.

◆ WithDescription() [1/3]

HIT& Aws::MTurk::Model::HIT::WithDescription ( Aws::String &&  value)
inline

A general description of the HIT.

Definition at line 316 of file HIT.h.

◆ WithDescription() [2/3]

HIT& Aws::MTurk::Model::HIT::WithDescription ( const Aws::String value)
inline

A general description of the HIT.

Definition at line 311 of file HIT.h.

◆ WithDescription() [3/3]

HIT& Aws::MTurk::Model::HIT::WithDescription ( const char *  value)
inline

A general description of the HIT.

Definition at line 321 of file HIT.h.

◆ WithExpiration() [1/2]

HIT& Aws::MTurk::Model::HIT::WithExpiration ( Aws::Utils::DateTime &&  value)
inline

The date and time the HIT expires.

Definition at line 586 of file HIT.h.

◆ WithExpiration() [2/2]

HIT& Aws::MTurk::Model::HIT::WithExpiration ( const Aws::Utils::DateTime value)
inline

The date and time the HIT expires.

Definition at line 581 of file HIT.h.

◆ WithHITGroupId() [1/3]

HIT& Aws::MTurk::Model::HIT::WithHITGroupId ( Aws::String &&  value)
inline

The ID of the HIT Group of this HIT.

Definition at line 162 of file HIT.h.

◆ WithHITGroupId() [2/3]

HIT& Aws::MTurk::Model::HIT::WithHITGroupId ( const Aws::String value)
inline

The ID of the HIT Group of this HIT.

Definition at line 157 of file HIT.h.

◆ WithHITGroupId() [3/3]

HIT& Aws::MTurk::Model::HIT::WithHITGroupId ( const char *  value)
inline

The ID of the HIT Group of this HIT.

Definition at line 167 of file HIT.h.

◆ WithHITId() [1/3]

HIT& Aws::MTurk::Model::HIT::WithHITId ( Aws::String &&  value)
inline

A unique identifier for the HIT.

Definition at line 80 of file HIT.h.

◆ WithHITId() [2/3]

HIT& Aws::MTurk::Model::HIT::WithHITId ( const Aws::String value)
inline

A unique identifier for the HIT.

Definition at line 75 of file HIT.h.

◆ WithHITId() [3/3]

HIT& Aws::MTurk::Model::HIT::WithHITId ( const char *  value)
inline

A unique identifier for the HIT.

Definition at line 85 of file HIT.h.

◆ WithHITLayoutId() [1/3]

HIT& Aws::MTurk::Model::HIT::WithHITLayoutId ( Aws::String &&  value)
inline

The ID of the HIT Layout of this HIT.

Definition at line 203 of file HIT.h.

◆ WithHITLayoutId() [2/3]

HIT& Aws::MTurk::Model::HIT::WithHITLayoutId ( const Aws::String value)
inline

The ID of the HIT Layout of this HIT.

Definition at line 198 of file HIT.h.

◆ WithHITLayoutId() [3/3]

HIT& Aws::MTurk::Model::HIT::WithHITLayoutId ( const char *  value)
inline

The ID of the HIT Layout of this HIT.

Definition at line 208 of file HIT.h.

◆ WithHITReviewStatus() [1/2]

HIT& Aws::MTurk::Model::HIT::WithHITReviewStatus ( const HITReviewStatus value)
inline

Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

Definition at line 764 of file HIT.h.

◆ WithHITReviewStatus() [2/2]

HIT& Aws::MTurk::Model::HIT::WithHITReviewStatus ( HITReviewStatus &&  value)
inline

Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

Definition at line 770 of file HIT.h.

◆ WithHITStatus() [1/2]

HIT& Aws::MTurk::Model::HIT::WithHITStatus ( const HITStatus value)
inline

The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

Definition at line 466 of file HIT.h.

◆ WithHITStatus() [2/2]

HIT& Aws::MTurk::Model::HIT::WithHITStatus ( HITStatus &&  value)
inline

The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

Definition at line 472 of file HIT.h.

◆ WithHITTypeId() [1/3]

HIT& Aws::MTurk::Model::HIT::WithHITTypeId ( Aws::String &&  value)
inline

The ID of the HIT type of this HIT

Definition at line 121 of file HIT.h.

◆ WithHITTypeId() [2/3]

HIT& Aws::MTurk::Model::HIT::WithHITTypeId ( const Aws::String value)
inline

The ID of the HIT type of this HIT

Definition at line 116 of file HIT.h.

◆ WithHITTypeId() [3/3]

HIT& Aws::MTurk::Model::HIT::WithHITTypeId ( const char *  value)
inline

The ID of the HIT type of this HIT

Definition at line 126 of file HIT.h.

◆ WithKeywords() [1/3]

HIT& Aws::MTurk::Model::HIT::WithKeywords ( Aws::String &&  value)
inline

One or more words or phrases that describe the HIT, separated by commas. Search terms similar to the keywords of a HIT are more likely to have the HIT in the search results.

Definition at line 428 of file HIT.h.

◆ WithKeywords() [2/3]

HIT& Aws::MTurk::Model::HIT::WithKeywords ( const Aws::String value)
inline

One or more words or phrases that describe the HIT, separated by commas. Search terms similar to the keywords of a HIT are more likely to have the HIT in the search results.

Definition at line 421 of file HIT.h.

◆ WithKeywords() [3/3]

HIT& Aws::MTurk::Model::HIT::WithKeywords ( const char *  value)
inline

One or more words or phrases that describe the HIT, separated by commas. Search terms similar to the keywords of a HIT are more likely to have the HIT in the search results.

Definition at line 435 of file HIT.h.

◆ WithMaxAssignments()

HIT& Aws::MTurk::Model::HIT::WithMaxAssignments ( int  value)
inline

The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

Definition at line 497 of file HIT.h.

◆ WithNumberOfAssignmentsAvailable()

HIT& Aws::MTurk::Model::HIT::WithNumberOfAssignmentsAvailable ( int  value)
inline

The number of assignments for this HIT that are available for Workers to accept.

Definition at line 824 of file HIT.h.

◆ WithNumberOfAssignmentsCompleted()

HIT& Aws::MTurk::Model::HIT::WithNumberOfAssignmentsCompleted ( int  value)
inline

The number of assignments for this HIT that have been approved or rejected.

Definition at line 849 of file HIT.h.

◆ WithNumberOfAssignmentsPending()

HIT& Aws::MTurk::Model::HIT::WithNumberOfAssignmentsPending ( int  value)
inline

The number of assignments for this HIT that are being previewed or have been accepted by Workers, but have not yet been submitted, returned, or abandoned.

Definition at line 799 of file HIT.h.

◆ WithQualificationRequirements() [1/2]

HIT& Aws::MTurk::Model::HIT::WithQualificationRequirements ( Aws::Vector< QualificationRequirement > &&  value)
inline

Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure.

Definition at line 715 of file HIT.h.

◆ WithQualificationRequirements() [2/2]

HIT& Aws::MTurk::Model::HIT::WithQualificationRequirements ( const Aws::Vector< QualificationRequirement > &  value)
inline

Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure.

Definition at line 706 of file HIT.h.

◆ WithQuestion() [1/3]

HIT& Aws::MTurk::Model::HIT::WithQuestion ( Aws::String &&  value)
inline

The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

Definition at line 371 of file HIT.h.

◆ WithQuestion() [2/3]

HIT& Aws::MTurk::Model::HIT::WithQuestion ( const Aws::String value)
inline

The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

Definition at line 364 of file HIT.h.

◆ WithQuestion() [3/3]

HIT& Aws::MTurk::Model::HIT::WithQuestion ( const char *  value)
inline

The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.

Definition at line 378 of file HIT.h.

◆ WithRequesterAnnotation() [1/3]

HIT& Aws::MTurk::Model::HIT::WithRequesterAnnotation ( Aws::String &&  value)
inline

An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

Definition at line 654 of file HIT.h.

◆ WithRequesterAnnotation() [2/3]

HIT& Aws::MTurk::Model::HIT::WithRequesterAnnotation ( const Aws::String value)
inline

An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

Definition at line 648 of file HIT.h.

◆ WithRequesterAnnotation() [3/3]

HIT& Aws::MTurk::Model::HIT::WithRequesterAnnotation ( const char *  value)
inline

An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.

Definition at line 660 of file HIT.h.

◆ WithReward() [1/3]

HIT& Aws::MTurk::Model::HIT::WithReward ( Aws::String &&  value)
inline

Definition at line 519 of file HIT.h.

◆ WithReward() [2/3]

HIT& Aws::MTurk::Model::HIT::WithReward ( const Aws::String value)
inline

Definition at line 516 of file HIT.h.

◆ WithReward() [3/3]

HIT& Aws::MTurk::Model::HIT::WithReward ( const char *  value)
inline

Definition at line 522 of file HIT.h.

◆ WithTitle() [1/3]

HIT& Aws::MTurk::Model::HIT::WithTitle ( Aws::String &&  value)
inline

The title of the HIT.

Definition at line 275 of file HIT.h.

◆ WithTitle() [2/3]

HIT& Aws::MTurk::Model::HIT::WithTitle ( const Aws::String value)
inline

The title of the HIT.

Definition at line 270 of file HIT.h.

◆ WithTitle() [3/3]

HIT& Aws::MTurk::Model::HIT::WithTitle ( const char *  value)
inline

The title of the HIT.

Definition at line 280 of file HIT.h.


The documentation for this class was generated from the following file: