Package software.amazon.awssdk.services.mturk.model

Class CreateHITWithHITTypeRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.mturk.model.CreateHITWithHITTypeRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateHITWithHITTypeRequest.Builder,CreateHITWithHITTypeRequest>

@Generated("software.amazon.awssdk:codegen")
public class CreateHITWithHITTypeRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<CreateHITWithHITTypeRequest.Builder,CreateHITWithHITTypeRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateHITWithHITTypeRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
ReviewPolicy	assignmentReviewPolicy()	The Assignment-level Review Policy applies to the assignments under the HIT.
static CreateHITWithHITTypeRequest.Builder	builder()
boolean	equals(Object obj)
int	hashCode()
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.
List<HITLayoutParameter>	hitLayoutParameters()	If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure.
ReviewPolicy	hitReviewPolicy()	The HIT-level Review Policy applies to the HIT.
String	hitTypeId()	The HIT type ID you want to create this HIT with.
Long	lifetimeInSeconds()	An amount of time, in seconds, after which the HIT is no longer available for users to accept.
Integer	maxAssignments()	The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
String	question()	The data the person completing the HIT uses to produce the results.
String	requesterAnnotation()	An arbitrary data field.
static Class<? extends CreateHITWithHITTypeRequest.Builder>	serializableBuilderClass()
CreateHITWithHITTypeRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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 software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

hitTypeId

public String hitTypeId()

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

Returns:

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

maxAssignments

public Integer maxAssignments()

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.

lifetimeInSeconds

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

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.

question

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

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.

requesterAnnotation

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

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.

uniqueRequestToken

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

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.

assignmentReviewPolicy

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

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.

hitReviewPolicy

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

Returns:

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

hitLayoutId

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

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.

hitLayoutParameters

public List<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.

Returns:

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

toBuilder

public CreateHITWithHITTypeRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateHITWithHITTypeRequest.Builder,CreateHITWithHITTypeRequest>

Returns:

a builder for type T

builder

public static CreateHITWithHITTypeRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateHITWithHITTypeRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object