@Generated(value="software.amazon.awssdk:codegen") public final class CreateHitRequest extends MTurkRequest implements ToCopyableBuilder<CreateHitRequest.Builder,CreateHitRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateHitRequest.Builder |
| 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()
For responses, this returns true if the service returned a value for the HITLayoutParameters property.
|
boolean |
hasQualificationRequirements()
For responses, this returns true if the service returned a value for the QualificationRequirements property.
|
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.
|
overrideConfigurationcopypublic final Integer maxAssignments()
The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
public final 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.
public final 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.
public final 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.
public final String reward()
The amount of money the Requester will pay a Worker for successfully completing the HIT.
public final 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.
public final String keywords()
One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs.
public final 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.
public final 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.
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.
public final 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.
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.
public final boolean hasQualificationRequirements()
isEmpty() method on the
property). This is useful because the SDK will never return a null collection or map, but you may need to
differentiate between the service returning nothing (or null) and the service returning an empty collection or
map. For requests, this returns true if a value for the property was specified in the request builder, and false
if a value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasQualificationRequirements() method.
ActionsGuarded field on each
QualificationRequirement structure.public final 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.
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.
public final 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.
public final 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.
public final 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.
Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.
public final boolean hasHitLayoutParameters()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasHitLayoutParameters() method.
public CreateHitRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<CreateHitRequest.Builder,CreateHitRequest>toBuilder in class MTurkRequestpublic static CreateHitRequest.Builder builder()
public static Class<? extends CreateHitRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. 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.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.