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

#include <CreateHITWithHITTypeRequest.h>

+ Inheritance diagram for Aws::MTurk::Model::CreateHITWithHITTypeRequest:

Public Member Functions

 CreateHITWithHITTypeRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetHITTypeId () const
 
bool HITTypeIdHasBeenSet () const
 
void SetHITTypeId (const Aws::String &value)
 
void SetHITTypeId (Aws::String &&value)
 
void SetHITTypeId (const char *value)
 
CreateHITWithHITTypeRequestWithHITTypeId (const Aws::String &value)
 
CreateHITWithHITTypeRequestWithHITTypeId (Aws::String &&value)
 
CreateHITWithHITTypeRequestWithHITTypeId (const char *value)
 
int GetMaxAssignments () const
 
bool MaxAssignmentsHasBeenSet () const
 
void SetMaxAssignments (int value)
 
CreateHITWithHITTypeRequestWithMaxAssignments (int value)
 
long long GetLifetimeInSeconds () const
 
bool LifetimeInSecondsHasBeenSet () const
 
void SetLifetimeInSeconds (long long value)
 
CreateHITWithHITTypeRequestWithLifetimeInSeconds (long long value)
 
const Aws::StringGetQuestion () const
 
bool QuestionHasBeenSet () const
 
void SetQuestion (const Aws::String &value)
 
void SetQuestion (Aws::String &&value)
 
void SetQuestion (const char *value)
 
CreateHITWithHITTypeRequestWithQuestion (const Aws::String &value)
 
CreateHITWithHITTypeRequestWithQuestion (Aws::String &&value)
 
CreateHITWithHITTypeRequestWithQuestion (const char *value)
 
const Aws::StringGetRequesterAnnotation () const
 
bool RequesterAnnotationHasBeenSet () const
 
void SetRequesterAnnotation (const Aws::String &value)
 
void SetRequesterAnnotation (Aws::String &&value)
 
void SetRequesterAnnotation (const char *value)
 
CreateHITWithHITTypeRequestWithRequesterAnnotation (const Aws::String &value)
 
CreateHITWithHITTypeRequestWithRequesterAnnotation (Aws::String &&value)
 
CreateHITWithHITTypeRequestWithRequesterAnnotation (const char *value)
 
const Aws::StringGetUniqueRequestToken () const
 
bool UniqueRequestTokenHasBeenSet () const
 
void SetUniqueRequestToken (const Aws::String &value)
 
void SetUniqueRequestToken (Aws::String &&value)
 
void SetUniqueRequestToken (const char *value)
 
CreateHITWithHITTypeRequestWithUniqueRequestToken (const Aws::String &value)
 
CreateHITWithHITTypeRequestWithUniqueRequestToken (Aws::String &&value)
 
CreateHITWithHITTypeRequestWithUniqueRequestToken (const char *value)
 
const ReviewPolicyGetAssignmentReviewPolicy () const
 
bool AssignmentReviewPolicyHasBeenSet () const
 
void SetAssignmentReviewPolicy (const ReviewPolicy &value)
 
void SetAssignmentReviewPolicy (ReviewPolicy &&value)
 
CreateHITWithHITTypeRequestWithAssignmentReviewPolicy (const ReviewPolicy &value)
 
CreateHITWithHITTypeRequestWithAssignmentReviewPolicy (ReviewPolicy &&value)
 
const ReviewPolicyGetHITReviewPolicy () const
 
bool HITReviewPolicyHasBeenSet () const
 
void SetHITReviewPolicy (const ReviewPolicy &value)
 
void SetHITReviewPolicy (ReviewPolicy &&value)
 
CreateHITWithHITTypeRequestWithHITReviewPolicy (const ReviewPolicy &value)
 
CreateHITWithHITTypeRequestWithHITReviewPolicy (ReviewPolicy &&value)
 
const Aws::StringGetHITLayoutId () const
 
bool HITLayoutIdHasBeenSet () const
 
void SetHITLayoutId (const Aws::String &value)
 
void SetHITLayoutId (Aws::String &&value)
 
void SetHITLayoutId (const char *value)
 
CreateHITWithHITTypeRequestWithHITLayoutId (const Aws::String &value)
 
CreateHITWithHITTypeRequestWithHITLayoutId (Aws::String &&value)
 
CreateHITWithHITTypeRequestWithHITLayoutId (const char *value)
 
const Aws::Vector< HITLayoutParameter > & GetHITLayoutParameters () const
 
bool HITLayoutParametersHasBeenSet () const
 
void SetHITLayoutParameters (const Aws::Vector< HITLayoutParameter > &value)
 
void SetHITLayoutParameters (Aws::Vector< HITLayoutParameter > &&value)
 
CreateHITWithHITTypeRequestWithHITLayoutParameters (const Aws::Vector< HITLayoutParameter > &value)
 
CreateHITWithHITTypeRequestWithHITLayoutParameters (Aws::Vector< HITLayoutParameter > &&value)
 
CreateHITWithHITTypeRequestAddHITLayoutParameters (const HITLayoutParameter &value)
 
CreateHITWithHITTypeRequestAddHITLayoutParameters (HITLayoutParameter &&value)
 
- Public Member Functions inherited from Aws::MTurk::MTurkRequest
virtual ~MTurkRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file CreateHITWithHITTypeRequest.h.

Constructor & Destructor Documentation

◆ CreateHITWithHITTypeRequest()

Aws::MTurk::Model::CreateHITWithHITTypeRequest::CreateHITWithHITTypeRequest ( )

Member Function Documentation

◆ AddHITLayoutParameters() [1/2]

CreateHITWithHITTypeRequest& Aws::MTurk::Model::CreateHITWithHITTypeRequest::AddHITLayoutParameters ( const HITLayoutParameter value)
inline

If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.

Definition at line 614 of file CreateHITWithHITTypeRequest.h.

◆ AddHITLayoutParameters() [2/2]

CreateHITWithHITTypeRequest& Aws::MTurk::Model::CreateHITWithHITTypeRequest::AddHITLayoutParameters ( HITLayoutParameter &&  value)
inline

If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.

Definition at line 621 of file CreateHITWithHITTypeRequest.h.

◆ AssignmentReviewPolicyHasBeenSet()

bool Aws::MTurk::Model::CreateHITWithHITTypeRequest::AssignmentReviewPolicyHasBeenSet ( ) const
inline

The Assignment-level Review Policy applies to the assignments under the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

Definition at line 434 of file CreateHITWithHITTypeRequest.h.

◆ GetAssignmentReviewPolicy()

const ReviewPolicy& Aws::MTurk::Model::CreateHITWithHITTypeRequest::GetAssignmentReviewPolicy ( ) const
inline

The Assignment-level Review Policy applies to the assignments under the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

Definition at line 427 of file CreateHITWithHITTypeRequest.h.

◆ GetHITLayoutId()

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

The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters.

Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.

Definition at line 508 of file CreateHITWithHITTypeRequest.h.

◆ GetHITLayoutParameters()

const Aws::Vector<HITLayoutParameter>& Aws::MTurk::Model::CreateHITWithHITTypeRequest::GetHITLayoutParameters ( ) const
inline

If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.

Definition at line 572 of file CreateHITWithHITTypeRequest.h.

◆ GetHITReviewPolicy()

const ReviewPolicy& Aws::MTurk::Model::CreateHITWithHITTypeRequest::GetHITReviewPolicy ( ) const
inline

The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

Definition at line 469 of file CreateHITWithHITTypeRequest.h.

◆ GetHITTypeId()

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

The HIT type ID you want to create this HIT with.

Definition at line 43 of file CreateHITWithHITTypeRequest.h.

◆ GetLifetimeInSeconds()

long long Aws::MTurk::Model::CreateHITWithHITTypeRequest::GetLifetimeInSeconds ( ) const
inline

An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT have been accepted.

Definition at line 112 of file CreateHITWithHITTypeRequest.h.

◆ GetMaxAssignments()

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

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

Definition at line 85 of file CreateHITWithHITTypeRequest.h.

◆ GetQuestion()

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

The data the person completing the HIT uses to produce the results.

Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace.

Either a Question parameter or a HITLayoutId parameter must be provided.

Definition at line 146 of file CreateHITWithHITTypeRequest.h.

◆ GetRequesterAnnotation()

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

An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT.

The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester.

The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped.

Definition at line 222 of file CreateHITWithHITTypeRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::MTurk::Model::CreateHITWithHITTypeRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::MTurk::MTurkRequest.

◆ GetServiceRequestName()

virtual const char* Aws::MTurk::Model::CreateHITWithHITTypeRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file CreateHITWithHITTypeRequest.h.

◆ GetUniqueRequestToken()

const Aws::String& Aws::MTurk::Model::CreateHITWithHITTypeRequest::GetUniqueRequestToken ( ) const
inline

A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId.

Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs.

Definition at line 321 of file CreateHITWithHITTypeRequest.h.

◆ HITLayoutIdHasBeenSet()

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

The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters.

Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.

Definition at line 516 of file CreateHITWithHITTypeRequest.h.

◆ HITLayoutParametersHasBeenSet()

bool Aws::MTurk::Model::CreateHITWithHITTypeRequest::HITLayoutParametersHasBeenSet ( ) const
inline

If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.

Definition at line 579 of file CreateHITWithHITTypeRequest.h.

◆ HITReviewPolicyHasBeenSet()

bool Aws::MTurk::Model::CreateHITWithHITTypeRequest::HITReviewPolicyHasBeenSet ( ) const
inline

The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

Definition at line 475 of file CreateHITWithHITTypeRequest.h.

◆ HITTypeIdHasBeenSet()

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

The HIT type ID you want to create this HIT with.

Definition at line 48 of file CreateHITWithHITTypeRequest.h.

◆ LifetimeInSecondsHasBeenSet()

bool Aws::MTurk::Model::CreateHITWithHITTypeRequest::LifetimeInSecondsHasBeenSet ( ) const
inline

An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT have been accepted.

Definition at line 120 of file CreateHITWithHITTypeRequest.h.

◆ MaxAssignmentsHasBeenSet()

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

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

Definition at line 91 of file CreateHITWithHITTypeRequest.h.

◆ QuestionHasBeenSet()

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

The data the person completing the HIT uses to produce the results.

Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace.

Either a Question parameter or a HITLayoutId parameter must be provided.

Definition at line 155 of file CreateHITWithHITTypeRequest.h.

◆ RequesterAnnotationHasBeenSet()

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

An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT.

The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester.

The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped.

Definition at line 234 of file CreateHITWithHITTypeRequest.h.

◆ SerializePayload()

Aws::String Aws::MTurk::Model::CreateHITWithHITTypeRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAssignmentReviewPolicy() [1/2]

void Aws::MTurk::Model::CreateHITWithHITTypeRequest::SetAssignmentReviewPolicy ( const ReviewPolicy value)
inline

The Assignment-level Review Policy applies to the assignments under the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

Definition at line 441 of file CreateHITWithHITTypeRequest.h.

◆ SetAssignmentReviewPolicy() [2/2]

void Aws::MTurk::Model::CreateHITWithHITTypeRequest::SetAssignmentReviewPolicy ( ReviewPolicy &&  value)
inline

The Assignment-level Review Policy applies to the assignments under the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

Definition at line 448 of file CreateHITWithHITTypeRequest.h.

◆ SetHITLayoutId() [1/3]

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

The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters.

Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.

Definition at line 532 of file CreateHITWithHITTypeRequest.h.

◆ SetHITLayoutId() [2/3]

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

The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters.

Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.

Definition at line 524 of file CreateHITWithHITTypeRequest.h.

◆ SetHITLayoutId() [3/3]

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

The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters.

Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.

Definition at line 540 of file CreateHITWithHITTypeRequest.h.

◆ SetHITLayoutParameters() [1/2]

void Aws::MTurk::Model::CreateHITWithHITTypeRequest::SetHITLayoutParameters ( Aws::Vector< HITLayoutParameter > &&  value)
inline

If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.

Definition at line 593 of file CreateHITWithHITTypeRequest.h.

◆ SetHITLayoutParameters() [2/2]

void Aws::MTurk::Model::CreateHITWithHITTypeRequest::SetHITLayoutParameters ( const Aws::Vector< HITLayoutParameter > &  value)
inline

If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.

Definition at line 586 of file CreateHITWithHITTypeRequest.h.

◆ SetHITReviewPolicy() [1/2]

void Aws::MTurk::Model::CreateHITWithHITTypeRequest::SetHITReviewPolicy ( const ReviewPolicy value)
inline

The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

Definition at line 481 of file CreateHITWithHITTypeRequest.h.

◆ SetHITReviewPolicy() [2/2]

void Aws::MTurk::Model::CreateHITWithHITTypeRequest::SetHITReviewPolicy ( ReviewPolicy &&  value)
inline

The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

Definition at line 487 of file CreateHITWithHITTypeRequest.h.

◆ SetHITTypeId() [1/3]

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

The HIT type ID you want to create this HIT with.

Definition at line 58 of file CreateHITWithHITTypeRequest.h.

◆ SetHITTypeId() [2/3]

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

The HIT type ID you want to create this HIT with.

Definition at line 53 of file CreateHITWithHITTypeRequest.h.

◆ SetHITTypeId() [3/3]

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

The HIT type ID you want to create this HIT with.

Definition at line 63 of file CreateHITWithHITTypeRequest.h.

◆ SetLifetimeInSeconds()

void Aws::MTurk::Model::CreateHITWithHITTypeRequest::SetLifetimeInSeconds ( long long  value)
inline

An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT have been accepted.

Definition at line 128 of file CreateHITWithHITTypeRequest.h.

◆ SetMaxAssignments()

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

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

Definition at line 97 of file CreateHITWithHITTypeRequest.h.

◆ SetQuestion() [1/3]

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

The data the person completing the HIT uses to produce the results.

Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace.

Either a Question parameter or a HITLayoutId parameter must be provided.

Definition at line 173 of file CreateHITWithHITTypeRequest.h.

◆ SetQuestion() [2/3]

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

The data the person completing the HIT uses to produce the results.

Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace.

Either a Question parameter or a HITLayoutId parameter must be provided.

Definition at line 164 of file CreateHITWithHITTypeRequest.h.

◆ SetQuestion() [3/3]

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

The data the person completing the HIT uses to produce the results.

Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace.

Either a Question parameter or a HITLayoutId parameter must be provided.

Definition at line 182 of file CreateHITWithHITTypeRequest.h.

◆ SetRequesterAnnotation() [1/3]

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

An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT.

The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester.

The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped.

Definition at line 258 of file CreateHITWithHITTypeRequest.h.

◆ SetRequesterAnnotation() [2/3]

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

An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT.

The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester.

The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped.

Definition at line 246 of file CreateHITWithHITTypeRequest.h.

◆ SetRequesterAnnotation() [3/3]

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

An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT.

The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester.

The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped.

Definition at line 270 of file CreateHITWithHITTypeRequest.h.

◆ SetUniqueRequestToken() [1/3]

void Aws::MTurk::Model::CreateHITWithHITTypeRequest::SetUniqueRequestToken ( Aws::String &&  value)
inline

A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId.

Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs.

Definition at line 363 of file CreateHITWithHITTypeRequest.h.

◆ SetUniqueRequestToken() [2/3]

void Aws::MTurk::Model::CreateHITWithHITTypeRequest::SetUniqueRequestToken ( const Aws::String value)
inline

A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId.

Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs.

Definition at line 349 of file CreateHITWithHITTypeRequest.h.

◆ SetUniqueRequestToken() [3/3]

void Aws::MTurk::Model::CreateHITWithHITTypeRequest::SetUniqueRequestToken ( const char *  value)
inline

A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId.

Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs.

Definition at line 377 of file CreateHITWithHITTypeRequest.h.

◆ UniqueRequestTokenHasBeenSet()

bool Aws::MTurk::Model::CreateHITWithHITTypeRequest::UniqueRequestTokenHasBeenSet ( ) const
inline

A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId.

Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs.

Definition at line 335 of file CreateHITWithHITTypeRequest.h.

◆ WithAssignmentReviewPolicy() [1/2]

CreateHITWithHITTypeRequest& Aws::MTurk::Model::CreateHITWithHITTypeRequest::WithAssignmentReviewPolicy ( const ReviewPolicy value)
inline

The Assignment-level Review Policy applies to the assignments under the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

Definition at line 455 of file CreateHITWithHITTypeRequest.h.

◆ WithAssignmentReviewPolicy() [2/2]

CreateHITWithHITTypeRequest& Aws::MTurk::Model::CreateHITWithHITTypeRequest::WithAssignmentReviewPolicy ( ReviewPolicy &&  value)
inline

The Assignment-level Review Policy applies to the assignments under the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

Definition at line 462 of file CreateHITWithHITTypeRequest.h.

◆ WithHITLayoutId() [1/3]

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

The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters.

Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.

Definition at line 556 of file CreateHITWithHITTypeRequest.h.

◆ WithHITLayoutId() [2/3]

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

The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters.

Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.

Definition at line 548 of file CreateHITWithHITTypeRequest.h.

◆ WithHITLayoutId() [3/3]

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

The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters.

Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.

Definition at line 564 of file CreateHITWithHITTypeRequest.h.

◆ WithHITLayoutParameters() [1/2]

CreateHITWithHITTypeRequest& Aws::MTurk::Model::CreateHITWithHITTypeRequest::WithHITLayoutParameters ( Aws::Vector< HITLayoutParameter > &&  value)
inline

If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.

Definition at line 607 of file CreateHITWithHITTypeRequest.h.

◆ WithHITLayoutParameters() [2/2]

CreateHITWithHITTypeRequest& Aws::MTurk::Model::CreateHITWithHITTypeRequest::WithHITLayoutParameters ( const Aws::Vector< HITLayoutParameter > &  value)
inline

If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.

Definition at line 600 of file CreateHITWithHITTypeRequest.h.

◆ WithHITReviewPolicy() [1/2]

CreateHITWithHITTypeRequest& Aws::MTurk::Model::CreateHITWithHITTypeRequest::WithHITReviewPolicy ( const ReviewPolicy value)
inline

The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

Definition at line 493 of file CreateHITWithHITTypeRequest.h.

◆ WithHITReviewPolicy() [2/2]

CreateHITWithHITTypeRequest& Aws::MTurk::Model::CreateHITWithHITTypeRequest::WithHITReviewPolicy ( ReviewPolicy &&  value)
inline

The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

Definition at line 499 of file CreateHITWithHITTypeRequest.h.

◆ WithHITTypeId() [1/3]

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

The HIT type ID you want to create this HIT with.

Definition at line 73 of file CreateHITWithHITTypeRequest.h.

◆ WithHITTypeId() [2/3]

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

The HIT type ID you want to create this HIT with.

Definition at line 68 of file CreateHITWithHITTypeRequest.h.

◆ WithHITTypeId() [3/3]

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

The HIT type ID you want to create this HIT with.

Definition at line 78 of file CreateHITWithHITTypeRequest.h.

◆ WithLifetimeInSeconds()

CreateHITWithHITTypeRequest& Aws::MTurk::Model::CreateHITWithHITTypeRequest::WithLifetimeInSeconds ( long long  value)
inline

An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT have been accepted.

Definition at line 136 of file CreateHITWithHITTypeRequest.h.

◆ WithMaxAssignments()

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

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

Definition at line 103 of file CreateHITWithHITTypeRequest.h.

◆ WithQuestion() [1/3]

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

The data the person completing the HIT uses to produce the results.

Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace.

Either a Question parameter or a HITLayoutId parameter must be provided.

Definition at line 200 of file CreateHITWithHITTypeRequest.h.

◆ WithQuestion() [2/3]

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

The data the person completing the HIT uses to produce the results.

Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace.

Either a Question parameter or a HITLayoutId parameter must be provided.

Definition at line 191 of file CreateHITWithHITTypeRequest.h.

◆ WithQuestion() [3/3]

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

The data the person completing the HIT uses to produce the results.

Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace.

Either a Question parameter or a HITLayoutId parameter must be provided.

Definition at line 209 of file CreateHITWithHITTypeRequest.h.

◆ WithRequesterAnnotation() [1/3]

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

An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT.

The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester.

The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped.

Definition at line 294 of file CreateHITWithHITTypeRequest.h.

◆ WithRequesterAnnotation() [2/3]

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

An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT.

The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester.

The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped.

Definition at line 282 of file CreateHITWithHITTypeRequest.h.

◆ WithRequesterAnnotation() [3/3]

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

An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT.

The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester.

The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped.

Definition at line 306 of file CreateHITWithHITTypeRequest.h.

◆ WithUniqueRequestToken() [1/3]

CreateHITWithHITTypeRequest& Aws::MTurk::Model::CreateHITWithHITTypeRequest::WithUniqueRequestToken ( Aws::String &&  value)
inline

A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId.

Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs.

Definition at line 405 of file CreateHITWithHITTypeRequest.h.

◆ WithUniqueRequestToken() [2/3]

CreateHITWithHITTypeRequest& Aws::MTurk::Model::CreateHITWithHITTypeRequest::WithUniqueRequestToken ( const Aws::String value)
inline

A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId.

Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs.

Definition at line 391 of file CreateHITWithHITTypeRequest.h.

◆ WithUniqueRequestToken() [3/3]

CreateHITWithHITTypeRequest& Aws::MTurk::Model::CreateHITWithHITTypeRequest::WithUniqueRequestToken ( const char *  value)
inline

A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId.

Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs.

Definition at line 419 of file CreateHITWithHITTypeRequest.h.


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