@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class HIT extends Object implements Serializable, Cloneable, StructuredPojo
The HIT data structure represents a single HIT, including all the information necessary for a Worker to accept and complete the HIT.
Constructor and Description |
---|
HIT() |
Modifier and Type | Method and Description |
---|---|
HIT |
clone() |
boolean |
equals(Object obj) |
Long |
getAssignmentDurationInSeconds()
The length of time, in seconds, that a Worker has to complete the HIT after accepting it.
|
Long |
getAutoApprovalDelayInSeconds()
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.
|
Date |
getCreationTime()
The date and time the HIT was created.
|
String |
getDescription()
A general description of the HIT.
|
Date |
getExpiration()
The date and time the HIT expires.
|
String |
getHITGroupId()
The ID of the HIT Group of this HIT.
|
String |
getHITId()
A unique identifier for the HIT.
|
String |
getHITLayoutId()
The ID of the HIT Layout of this HIT.
|
String |
getHITReviewStatus()
Indicates the review status of the HIT.
|
String |
getHITStatus()
The status of the HIT and its assignments.
|
String |
getHITTypeId()
The ID of the HIT type of this HIT
|
String |
getKeywords()
One or more words or phrases that describe the HIT, separated by commas.
|
Integer |
getMaxAssignments()
The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
|
Integer |
getNumberOfAssignmentsAvailable()
The number of assignments for this HIT that are available for Workers to accept.
|
Integer |
getNumberOfAssignmentsCompleted()
The number of assignments for this HIT that have been approved or rejected.
|
Integer |
getNumberOfAssignmentsPending()
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> |
getQualificationRequirements()
Conditions that a Worker's Qualifications must meet in order to accept the HIT.
|
String |
getQuestion()
The data the Worker completing the HIT uses produce the results.
|
String |
getRequesterAnnotation()
An arbitrary data field the Requester who created the HIT can use.
|
String |
getReward() |
String |
getTitle()
The title of the HIT.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAssignmentDurationInSeconds(Long assignmentDurationInSeconds)
The length of time, in seconds, that a Worker has to complete the HIT after accepting it.
|
void |
setAutoApprovalDelayInSeconds(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.
|
void |
setCreationTime(Date creationTime)
The date and time the HIT was created.
|
void |
setDescription(String description)
A general description of the HIT.
|
void |
setExpiration(Date expiration)
The date and time the HIT expires.
|
void |
setHITGroupId(String hITGroupId)
The ID of the HIT Group of this HIT.
|
void |
setHITId(String hITId)
A unique identifier for the HIT.
|
void |
setHITLayoutId(String hITLayoutId)
The ID of the HIT Layout of this HIT.
|
void |
setHITReviewStatus(HITReviewStatus hITReviewStatus)
Indicates the review status of the HIT.
|
void |
setHITReviewStatus(String hITReviewStatus)
Indicates the review status of the HIT.
|
void |
setHITStatus(HITStatus hITStatus)
The status of the HIT and its assignments.
|
void |
setHITStatus(String hITStatus)
The status of the HIT and its assignments.
|
void |
setHITTypeId(String hITTypeId)
The ID of the HIT type of this HIT
|
void |
setKeywords(String keywords)
One or more words or phrases that describe the HIT, separated by commas.
|
void |
setMaxAssignments(Integer maxAssignments)
The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
|
void |
setNumberOfAssignmentsAvailable(Integer numberOfAssignmentsAvailable)
The number of assignments for this HIT that are available for Workers to accept.
|
void |
setNumberOfAssignmentsCompleted(Integer numberOfAssignmentsCompleted)
The number of assignments for this HIT that have been approved or rejected.
|
void |
setNumberOfAssignmentsPending(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.
|
void |
setQualificationRequirements(Collection<QualificationRequirement> qualificationRequirements)
Conditions that a Worker's Qualifications must meet in order to accept the HIT.
|
void |
setQuestion(String question)
The data the Worker completing the HIT uses produce the results.
|
void |
setRequesterAnnotation(String requesterAnnotation)
An arbitrary data field the Requester who created the HIT can use.
|
void |
setReward(String reward) |
void |
setTitle(String title)
The title of the HIT.
|
String |
toString()
Returns a string representation of this object.
|
HIT |
withAssignmentDurationInSeconds(Long assignmentDurationInSeconds)
The length of time, in seconds, that a Worker has to complete the HIT after accepting it.
|
HIT |
withAutoApprovalDelayInSeconds(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.
|
HIT |
withCreationTime(Date creationTime)
The date and time the HIT was created.
|
HIT |
withDescription(String description)
A general description of the HIT.
|
HIT |
withExpiration(Date expiration)
The date and time the HIT expires.
|
HIT |
withHITGroupId(String hITGroupId)
The ID of the HIT Group of this HIT.
|
HIT |
withHITId(String hITId)
A unique identifier for the HIT.
|
HIT |
withHITLayoutId(String hITLayoutId)
The ID of the HIT Layout of this HIT.
|
HIT |
withHITReviewStatus(HITReviewStatus hITReviewStatus)
Indicates the review status of the HIT.
|
HIT |
withHITReviewStatus(String hITReviewStatus)
Indicates the review status of the HIT.
|
HIT |
withHITStatus(HITStatus hITStatus)
The status of the HIT and its assignments.
|
HIT |
withHITStatus(String hITStatus)
The status of the HIT and its assignments.
|
HIT |
withHITTypeId(String hITTypeId)
The ID of the HIT type of this HIT
|
HIT |
withKeywords(String keywords)
One or more words or phrases that describe the HIT, separated by commas.
|
HIT |
withMaxAssignments(Integer maxAssignments)
The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
|
HIT |
withNumberOfAssignmentsAvailable(Integer numberOfAssignmentsAvailable)
The number of assignments for this HIT that are available for Workers to accept.
|
HIT |
withNumberOfAssignmentsCompleted(Integer numberOfAssignmentsCompleted)
The number of assignments for this HIT that have been approved or rejected.
|
HIT |
withNumberOfAssignmentsPending(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.
|
HIT |
withQualificationRequirements(Collection<QualificationRequirement> qualificationRequirements)
Conditions that a Worker's Qualifications must meet in order to accept the HIT.
|
HIT |
withQualificationRequirements(QualificationRequirement... qualificationRequirements)
Conditions that a Worker's Qualifications must meet in order to accept the HIT.
|
HIT |
withQuestion(String question)
The data the Worker completing the HIT uses produce the results.
|
HIT |
withRequesterAnnotation(String requesterAnnotation)
An arbitrary data field the Requester who created the HIT can use.
|
HIT |
withReward(String reward) |
HIT |
withTitle(String title)
The title of the HIT.
|
public void setHITId(String hITId)
A unique identifier for the HIT.
hITId
- A unique identifier for the HIT.public String getHITId()
A unique identifier for the HIT.
public HIT withHITId(String hITId)
A unique identifier for the HIT.
hITId
- A unique identifier for the HIT.public void setHITTypeId(String hITTypeId)
The ID of the HIT type of this HIT
hITTypeId
- The ID of the HIT type of this HITpublic String getHITTypeId()
The ID of the HIT type of this HIT
public HIT withHITTypeId(String hITTypeId)
The ID of the HIT type of this HIT
hITTypeId
- The ID of the HIT type of this HITpublic void setHITGroupId(String hITGroupId)
The ID of the HIT Group of this HIT.
hITGroupId
- The ID of the HIT Group of this HIT.public String getHITGroupId()
The ID of the HIT Group of this HIT.
public HIT withHITGroupId(String hITGroupId)
The ID of the HIT Group of this HIT.
hITGroupId
- The ID of the HIT Group of this HIT.public void setHITLayoutId(String hITLayoutId)
The ID of the HIT Layout of this HIT.
hITLayoutId
- The ID of the HIT Layout of this HIT.public String getHITLayoutId()
The ID of the HIT Layout of this HIT.
public HIT withHITLayoutId(String hITLayoutId)
The ID of the HIT Layout of this HIT.
hITLayoutId
- The ID of the HIT Layout of this HIT.public void setCreationTime(Date creationTime)
The date and time the HIT was created.
creationTime
- The date and time the HIT was created.public Date getCreationTime()
The date and time the HIT was created.
public HIT withCreationTime(Date creationTime)
The date and time the HIT was created.
creationTime
- The date and time the HIT was created.public void setTitle(String title)
The title of the HIT.
title
- The title of the HIT.public String getTitle()
The title of the HIT.
public HIT withTitle(String title)
The title of the HIT.
title
- The title of the HIT.public void setDescription(String description)
A general description of the HIT.
description
- A general description of the HIT.public String getDescription()
A general description of the HIT.
public HIT withDescription(String description)
A general description of the HIT.
description
- A general description of the HIT.public void setQuestion(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.
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 getQuestion()
The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.
public HIT withQuestion(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.
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 void setKeywords(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.
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 String getKeywords()
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 HIT withKeywords(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.
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 void setHITStatus(String hITStatus)
The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.
hITStatus
- The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable |
Reviewing | Disposed.HITStatus
public String getHITStatus()
The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.
HITStatus
public HIT withHITStatus(String hITStatus)
The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.
hITStatus
- The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable |
Reviewing | Disposed.HITStatus
public void setHITStatus(HITStatus hITStatus)
The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.
hITStatus
- The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable |
Reviewing | Disposed.HITStatus
public HIT withHITStatus(HITStatus hITStatus)
The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.
hITStatus
- The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable |
Reviewing | Disposed.HITStatus
public void setMaxAssignments(Integer maxAssignments)
The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
maxAssignments
- The number of times the HIT can be accepted and completed before the HIT becomes unavailable.public Integer getMaxAssignments()
The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
public HIT withMaxAssignments(Integer maxAssignments)
The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
maxAssignments
- The number of times the HIT can be accepted and completed before the HIT becomes unavailable.public void setReward(String reward)
reward
- public String getReward()
public HIT withReward(String reward)
reward
- public void setAutoApprovalDelayInSeconds(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.
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 Long getAutoApprovalDelayInSeconds()
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 HIT withAutoApprovalDelayInSeconds(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.
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 void setExpiration(Date expiration)
The date and time the HIT expires.
expiration
- The date and time the HIT expires.public Date getExpiration()
The date and time the HIT expires.
public HIT withExpiration(Date expiration)
The date and time the HIT expires.
expiration
- The date and time the HIT expires.public void setAssignmentDurationInSeconds(Long assignmentDurationInSeconds)
The length of time, in seconds, that a Worker has to complete the HIT after accepting it.
assignmentDurationInSeconds
- The length of time, in seconds, that a Worker has to complete the HIT after accepting it.public Long getAssignmentDurationInSeconds()
The length of time, in seconds, that a Worker has to complete the HIT after accepting it.
public HIT withAssignmentDurationInSeconds(Long assignmentDurationInSeconds)
The length of time, in seconds, that a Worker has to complete the HIT after accepting it.
assignmentDurationInSeconds
- The length of time, in seconds, that a Worker has to complete the HIT after accepting it.public void setRequesterAnnotation(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.
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 String getRequesterAnnotation()
An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.
public HIT withRequesterAnnotation(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.
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> getQualificationRequirements()
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.
ActionsGuarded
field on each
QualificationRequirement
structure.public void setQualificationRequirements(Collection<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.
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.public HIT withQualificationRequirements(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.
NOTE: This method appends the values to the existing list (if any). Use
setQualificationRequirements(java.util.Collection)
or
withQualificationRequirements(java.util.Collection)
if you want to override the existing values.
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.public HIT withQualificationRequirements(Collection<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.
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.public void setHITReviewStatus(String hITReviewStatus)
Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.
hITReviewStatus
- Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview |
ReviewedAppropriate | ReviewedInappropriate.HITReviewStatus
public String getHITReviewStatus()
Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.
HITReviewStatus
public HIT withHITReviewStatus(String hITReviewStatus)
Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.
hITReviewStatus
- Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview |
ReviewedAppropriate | ReviewedInappropriate.HITReviewStatus
public void setHITReviewStatus(HITReviewStatus hITReviewStatus)
Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.
hITReviewStatus
- Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview |
ReviewedAppropriate | ReviewedInappropriate.HITReviewStatus
public HIT withHITReviewStatus(HITReviewStatus hITReviewStatus)
Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.
hITReviewStatus
- Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview |
ReviewedAppropriate | ReviewedInappropriate.HITReviewStatus
public void setNumberOfAssignmentsPending(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.
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 getNumberOfAssignmentsPending()
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 HIT withNumberOfAssignmentsPending(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.
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 void setNumberOfAssignmentsAvailable(Integer numberOfAssignmentsAvailable)
The number of assignments for this HIT that are available for Workers to accept.
numberOfAssignmentsAvailable
- The number of assignments for this HIT that are available for Workers to accept.public Integer getNumberOfAssignmentsAvailable()
The number of assignments for this HIT that are available for Workers to accept.
public HIT withNumberOfAssignmentsAvailable(Integer numberOfAssignmentsAvailable)
The number of assignments for this HIT that are available for Workers to accept.
numberOfAssignmentsAvailable
- The number of assignments for this HIT that are available for Workers to accept.public void setNumberOfAssignmentsCompleted(Integer numberOfAssignmentsCompleted)
The number of assignments for this HIT that have been approved or rejected.
numberOfAssignmentsCompleted
- The number of assignments for this HIT that have been approved or rejected.public Integer getNumberOfAssignmentsCompleted()
The number of assignments for this HIT that have been approved or rejected.
public HIT withNumberOfAssignmentsCompleted(Integer numberOfAssignmentsCompleted)
The number of assignments for this HIT that have been approved or rejected.
numberOfAssignmentsCompleted
- The number of assignments for this HIT that have been approved or rejected.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.