com.amazonaws.services.mturk.model

Class CreateHITWithHITTypeRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.mturk.model.CreateHITWithHITTypeRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateHITWithHITTypeRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateHITWithHITTypeRequest()

Method Summary

Modifier and Type	Method and Description
CreateHITWithHITTypeRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
ReviewPolicy	getAssignmentReviewPolicy() The Assignment-level Review Policy applies to the assignments under the HIT.
String	getHITLayoutId() 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.
List<HITLayoutParameter>	getHITLayoutParameters() If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure.
ReviewPolicy	getHITReviewPolicy() The HIT-level Review Policy applies to the HIT.
String	getHITTypeId() The HIT type ID you want to create this HIT with.
Long	getLifetimeInSeconds() An amount of time, in seconds, after which the HIT is no longer available for users to accept.
Integer	getMaxAssignments() The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
String	getQuestion() The data the person completing the HIT uses to produce the results.
String	getRequesterAnnotation() An arbitrary data field.
String	getUniqueRequestToken() A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs.
int	hashCode()
void	setAssignmentReviewPolicy(ReviewPolicy assignmentReviewPolicy) The Assignment-level Review Policy applies to the assignments under the HIT.
void	setHITLayoutId(String hITLayoutId) 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.
void	setHITLayoutParameters(Collection<HITLayoutParameter> hITLayoutParameters) If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure.
void	setHITReviewPolicy(ReviewPolicy hITReviewPolicy) The HIT-level Review Policy applies to the HIT.
void	setHITTypeId(String hITTypeId) The HIT type ID you want to create this HIT with.
void	setLifetimeInSeconds(Long lifetimeInSeconds) An amount of time, in seconds, after which the HIT is no longer available for users to accept.
void	setMaxAssignments(Integer maxAssignments) The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
void	setQuestion(String question) The data the person completing the HIT uses to produce the results.
void	setRequesterAnnotation(String requesterAnnotation) An arbitrary data field.
void	setUniqueRequestToken(String uniqueRequestToken) A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CreateHITWithHITTypeRequest	withAssignmentReviewPolicy(ReviewPolicy assignmentReviewPolicy) The Assignment-level Review Policy applies to the assignments under the HIT.
CreateHITWithHITTypeRequest	withHITLayoutId(String hITLayoutId) 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.
CreateHITWithHITTypeRequest	withHITLayoutParameters(Collection<HITLayoutParameter> hITLayoutParameters) If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure.
CreateHITWithHITTypeRequest	withHITLayoutParameters(HITLayoutParameter... hITLayoutParameters) If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure.
CreateHITWithHITTypeRequest	withHITReviewPolicy(ReviewPolicy hITReviewPolicy) The HIT-level Review Policy applies to the HIT.
CreateHITWithHITTypeRequest	withHITTypeId(String hITTypeId) The HIT type ID you want to create this HIT with.
CreateHITWithHITTypeRequest	withLifetimeInSeconds(Long lifetimeInSeconds) An amount of time, in seconds, after which the HIT is no longer available for users to accept.
CreateHITWithHITTypeRequest	withMaxAssignments(Integer maxAssignments) The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
CreateHITWithHITTypeRequest	withQuestion(String question) The data the person completing the HIT uses to produce the results.
CreateHITWithHITTypeRequest	withRequesterAnnotation(String requesterAnnotation) An arbitrary data field.
CreateHITWithHITTypeRequest	withUniqueRequestToken(String uniqueRequestToken) A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateHITWithHITTypeRequest

public CreateHITWithHITTypeRequest()

Method Detail

setHITTypeId

public void setHITTypeId(String hITTypeId)

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

Parameters:

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

getHITTypeId

public String getHITTypeId()

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

Returns:

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

withHITTypeId

public CreateHITWithHITTypeRequest withHITTypeId(String hITTypeId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxAssignments

public void setMaxAssignments(Integer maxAssignments)

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

Parameters:

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

getMaxAssignments

public Integer getMaxAssignments()

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

Returns:

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

withMaxAssignments

public CreateHITWithHITTypeRequest withMaxAssignments(Integer maxAssignments)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setLifetimeInSeconds

public void setLifetimeInSeconds(Long lifetimeInSeconds)

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.

Parameters:

lifetimeInSeconds - 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.

getLifetimeInSeconds

public Long getLifetimeInSeconds()

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.

Returns:

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.

withLifetimeInSeconds

public CreateHITWithHITTypeRequest withLifetimeInSeconds(Long lifetimeInSeconds)

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.

Parameters:

lifetimeInSeconds - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setQuestion

public void setQuestion(String question)

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.

Parameters:

question - 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.

getQuestion

public String getQuestion()

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.

Returns:

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.

withQuestion

public CreateHITWithHITTypeRequest withQuestion(String question)

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.

Parameters:

question - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRequesterAnnotation

public void setRequesterAnnotation(String requesterAnnotation)

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.

Parameters:

requesterAnnotation - 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.

getRequesterAnnotation

public String getRequesterAnnotation()

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.

Returns:

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.

withRequesterAnnotation

public CreateHITWithHITTypeRequest withRequesterAnnotation(String requesterAnnotation)

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.

Parameters:

requesterAnnotation - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setUniqueRequestToken

public void setUniqueRequestToken(String uniqueRequestToken)

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.

Parameters:

uniqueRequestToken - 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.

getUniqueRequestToken

public String getUniqueRequestToken()

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.

Returns:

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.

withUniqueRequestToken

public CreateHITWithHITTypeRequest withUniqueRequestToken(String uniqueRequestToken)

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.

Parameters:

uniqueRequestToken - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAssignmentReviewPolicy

public void setAssignmentReviewPolicy(ReviewPolicy assignmentReviewPolicy)

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.

Parameters:

assignmentReviewPolicy - 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.

getAssignmentReviewPolicy

public ReviewPolicy getAssignmentReviewPolicy()

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.

Returns:

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.

withAssignmentReviewPolicy

public CreateHITWithHITTypeRequest withAssignmentReviewPolicy(ReviewPolicy assignmentReviewPolicy)

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.

Parameters:

assignmentReviewPolicy - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setHITReviewPolicy

public void setHITReviewPolicy(ReviewPolicy hITReviewPolicy)

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

Parameters:

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

getHITReviewPolicy

public ReviewPolicy getHITReviewPolicy()

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

Returns:

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

withHITReviewPolicy

public CreateHITWithHITTypeRequest withHITReviewPolicy(ReviewPolicy hITReviewPolicy)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setHITLayoutId

public void setHITLayoutId(String hITLayoutId)

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.

Parameters:

hITLayoutId - 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.

getHITLayoutId

public String getHITLayoutId()

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.

Returns:

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.

withHITLayoutId

public CreateHITWithHITTypeRequest withHITLayoutId(String hITLayoutId)

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.

Parameters:

hITLayoutId - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getHITLayoutParameters

public List<HITLayoutParameter> getHITLayoutParameters()

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

Returns:

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

setHITLayoutParameters

public void setHITLayoutParameters(Collection<HITLayoutParameter> hITLayoutParameters)

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

Parameters:

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

withHITLayoutParameters

public CreateHITWithHITTypeRequest withHITLayoutParameters(HITLayoutParameter... hITLayoutParameters)

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

NOTE: This method appends the values to the existing list (if any). Use setHITLayoutParameters(java.util.Collection) or withHITLayoutParameters(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withHITLayoutParameters

public CreateHITWithHITTypeRequest withHITLayoutParameters(Collection<HITLayoutParameter> hITLayoutParameters)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateHITWithHITTypeRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()