@Generated(value="software.amazon.awssdk:codegen") public final class HIT extends Object implements StructuredPojo, ToCopyableBuilder<HIT.Builder,HIT>
The HIT data structure represents a single HIT, including all the information necessary for a Worker to accept and complete the HIT.
Modifier and Type | Class and Description |
---|---|
static interface |
HIT.Builder |
Modifier and Type | Method and Description |
---|---|
Long |
assignmentDurationInSeconds()
The length of time, in seconds, that a Worker has to complete the HIT after accepting it.
|
Long |
autoApprovalDelayInSeconds()
The amount of time, in seconds, after the Worker submits an assignment for the HIT that the results are
automatically approved by Amazon Mechanical Turk.
|
static HIT.Builder |
builder() |
Instant |
creationTime()
The date and time the HIT was created.
|
String |
description()
A general description of the HIT.
|
boolean |
equals(Object obj) |
Instant |
expiration()
The date and time the HIT expires.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
hitGroupId()
The ID of the HIT Group of this HIT.
|
String |
hitId()
A unique identifier for the HIT.
|
String |
hitLayoutId()
The ID of the HIT Layout of this HIT.
|
HITReviewStatus |
hitReviewStatus()
Indicates the review status of the HIT.
|
String |
hitReviewStatusAsString()
Indicates the review status of the HIT.
|
HITStatus |
hitStatus()
The status of the HIT and its assignments.
|
String |
hitStatusAsString()
The status of the HIT and its assignments.
|
String |
hitTypeId()
The ID of the HIT type of this HIT
|
String |
keywords()
One or more words or phrases that describe the HIT, separated by commas.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
Integer |
maxAssignments()
The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
|
Integer |
numberOfAssignmentsAvailable()
The number of assignments for this HIT that are available for Workers to accept.
|
Integer |
numberOfAssignmentsCompleted()
The number of assignments for this HIT that have been approved or rejected.
|
Integer |
numberOfAssignmentsPending()
The number of assignments for this HIT that are being previewed or have been accepted by Workers, but have not
yet been submitted, returned, or abandoned.
|
List<QualificationRequirement> |
qualificationRequirements()
A condition that a Worker's Qualifications must meet in order to accept the HIT.
|
String |
question()
The data the Worker completing the HIT uses produce the results.
|
String |
requesterAnnotation()
An arbitrary data field the Requester who created the HIT can use.
|
String |
reward()
Returns the value of the Reward property for this object.
|
static Class<? extends HIT.Builder> |
serializableBuilderClass() |
String |
title()
The title of the HIT.
|
HIT.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copy
public String hitId()
A unique identifier for the HIT.
public String hitTypeId()
The ID of the HIT type of this HIT
public String hitGroupId()
The ID of the HIT Group of this HIT.
public String hitLayoutId()
The ID of the HIT Layout of this HIT.
public Instant creationTime()
The date and time the HIT was created.
public String title()
The title of the HIT.
public String description()
A general description of the HIT.
public String question()
The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.
public String keywords()
One or more words or phrases that describe the HIT, separated by commas. Search terms similar to the keywords of a HIT are more likely to have the HIT in the search results.
public HITStatus hitStatus()
The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.
If the service returns an enum value that is not available in the current SDK version, hitStatus
will
return HITStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
hitStatusAsString()
.
HITStatus
public String hitStatusAsString()
The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.
If the service returns an enum value that is not available in the current SDK version, hitStatus
will
return HITStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
hitStatusAsString()
.
HITStatus
public Integer maxAssignments()
The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
public String reward()
public Long autoApprovalDelayInSeconds()
The amount of time, in seconds, after the Worker submits an assignment for the HIT that the results are automatically approved by Amazon Mechanical Turk. This is the amount of time the Requester has to reject an assignment submitted by a Worker before the assignment is auto-approved and the Worker is paid.
public Instant expiration()
The date and time the HIT expires.
public Long assignmentDurationInSeconds()
The length of time, in seconds, that a Worker has to complete the HIT after accepting it.
public String requesterAnnotation()
An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.
public List<QualificationRequirement> qualificationRequirements()
A condition 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 by a Worker's Qualifications for the Worker to accept the HIT.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public HITReviewStatus hitReviewStatus()
Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.
If the service returns an enum value that is not available in the current SDK version, hitReviewStatus
will return HITReviewStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from hitReviewStatusAsString()
.
HITReviewStatus
public String hitReviewStatusAsString()
Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.
If the service returns an enum value that is not available in the current SDK version, hitReviewStatus
will return HITReviewStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from hitReviewStatusAsString()
.
HITReviewStatus
public Integer numberOfAssignmentsPending()
The number of assignments for this HIT that are being previewed or have been accepted by Workers, but have not yet been submitted, returned, or abandoned.
public Integer numberOfAssignmentsAvailable()
The number of assignments for this HIT that are available for Workers to accept.
public Integer numberOfAssignmentsCompleted()
The number of assignments for this HIT that have been approved or rejected.
public HIT.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<HIT.Builder,HIT>
public static HIT.Builder builder()
public static Class<? extends HIT.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.