software.amazon.awssdk.services.mturk.model

Class CreateHitRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.mturk.model.MTurkRequest

software.amazon.awssdk.services.mturk.model.CreateHitRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateHitRequest.Builder,CreateHitRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateHitRequest
extends MTurkRequest
implements ToCopyableBuilder<CreateHitRequest.Builder,CreateHitRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateHitRequest.Builder

Method Summary

Modifier and Type	Method and Description
Long	assignmentDurationInSeconds() The amount of time, in seconds, that a Worker has to complete the HIT after accepting it.
ReviewPolicy	assignmentReviewPolicy() The Assignment-level Review Policy applies to the assignments under the HIT.
Long	autoApprovalDelayInSeconds() The number of seconds after an assignment for the HIT has been submitted, after which the assignment is considered Approved automatically unless the Requester explicitly rejects it.
static CreateHitRequest.Builder	builder()
String	description() A general description of the HIT.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
boolean	hasHitLayoutParameters() Returns true if the HITLayoutParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasQualificationRequirements() Returns true if the QualificationRequirements property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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	keywords() One or more words or phrases that describe the HIT, separated by commas.
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.
List<QualificationRequirement>	qualificationRequirements() Conditions that a Worker's Qualifications must meet in order to accept the HIT.
String	question() The data the person completing the HIT uses to produce the results.
String	requesterAnnotation() An arbitrary data field.
String	reward() The amount of money the Requester will pay a Worker for successfully completing the HIT.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateHitRequest.Builder>	serializableBuilderClass()
String	title() The title of the HIT.
CreateHitRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
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.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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.

autoApprovalDelayInSeconds

public Long autoApprovalDelayInSeconds()

The number of seconds after an assignment for the HIT has been submitted, after which the assignment is considered Approved automatically unless the Requester explicitly rejects it.

Returns:

The number of seconds after an assignment for the HIT has been submitted, after which the assignment is considered Approved automatically unless the Requester explicitly rejects it.

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.

assignmentDurationInSeconds

public Long assignmentDurationInSeconds()

The amount of time, in seconds, that a Worker has to complete the HIT after accepting it. If a Worker does not complete the assignment within the specified duration, the assignment is considered abandoned. If the HIT is still active (that is, its lifetime has not elapsed), the assignment becomes available for other users to find and accept.

Returns:

The amount of time, in seconds, that a Worker has to complete the HIT after accepting it. If a Worker does not complete the assignment within the specified duration, the assignment is considered abandoned. If the HIT is still active (that is, its lifetime has not elapsed), the assignment becomes available for other users to find and accept.

reward

public String reward()

The amount of money the Requester will pay a Worker for successfully completing the HIT.

Returns:

The amount of money the Requester will pay a Worker for successfully completing the HIT.

title

public String title()

The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned.

Returns:

The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned.

keywords

public String keywords()

One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs.

Returns:

One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs.

description

public String description()

A general description of the HIT. A description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it.

Returns:

A general description of the HIT. A description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it.

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.

hasQualificationRequirements

public boolean hasQualificationRequirements()

Returns true if the QualificationRequirements property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

qualificationRequirements

public List<QualificationRequirement> qualificationRequirements()

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasQualificationRequirements() to see if a value was sent in this field.

Returns:

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.

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.

hasHitLayoutParameters

public boolean hasHitLayoutParameters()

Returns true if the HITLayoutParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasHitLayoutParameters() to see if a value was sent in this field.

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 CreateHitRequest.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<CreateHitRequest.Builder,CreateHitRequest>

Specified by:

toBuilder in class MTurkRequest

Returns:

a builder for type T

builder

public static CreateHitRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.