Interface HIT.Builder

All Superinterfaces:
Buildable, CopyableBuilder<HIT.Builder,HIT>, SdkBuilder<HIT.Builder,HIT>, SdkPojo
Enclosing class:
HIT
@Mutable @NotThreadSafe public static interface HIT.Builder extends SdkPojo, CopyableBuilder<HIT.Builder,HIT>

  • Method Details

    • hitId

      HIT.Builder hitId(String hitId)

      A unique identifier for the HIT.

      Parameters:
      hitId - A unique identifier for the HIT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hitTypeId

      HIT.Builder hitTypeId(String hitTypeId)

      The ID of the HIT type of this HIT

      Parameters:
      hitTypeId - The ID of the HIT type of this HIT
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hitGroupId

      HIT.Builder hitGroupId(String hitGroupId)

      The ID of the HIT Group of this HIT.

      Parameters:
      hitGroupId - The ID of the HIT Group of this HIT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hitLayoutId

      HIT.Builder hitLayoutId(String hitLayoutId)

      The ID of the HIT Layout of this HIT.

      Parameters:
      hitLayoutId - The ID of the HIT Layout of this HIT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationTime

      HIT.Builder creationTime(Instant creationTime)

      The date and time the HIT was created.

      Parameters:
      creationTime - The date and time the HIT was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • title

      HIT.Builder title(String title)

      The title of the HIT.

      Parameters:
      title - The title of the HIT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      HIT.Builder description(String description)

      A general description of the HIT.

      Parameters:
      description - A general description of the HIT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • question

      HIT.Builder question(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.

      Parameters:
      question - The data the Worker completing the HIT uses produce the results. This is either either a QuestionForm, HTMLQuestion or an ExternalQuestion data structure.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • keywords

      HIT.Builder keywords(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • hitStatus

      HIT.Builder hitStatus(String hitStatus)

      The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

      Parameters:
      hitStatus - The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • hitStatus

      HIT.Builder hitStatus(HITStatus hitStatus)

      The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.

      Parameters:
      hitStatus - The status of the HIT and its assignments. Valid Values are Assignable | Unassignable | Reviewable | Reviewing | Disposed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxAssignments

      HIT.Builder maxAssignments(Integer maxAssignments)

      The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

      Parameters:
      maxAssignments - The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • reward

      HIT.Builder reward(String reward)
      Sets the value of the Reward property for this object.
      Parameters:
      reward - The new value for the Reward property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • autoApprovalDelayInSeconds

      HIT.Builder autoApprovalDelayInSeconds(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • expiration

      HIT.Builder expiration(Instant expiration)

      The date and time the HIT expires.

      Parameters:
      expiration - The date and time the HIT expires.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • assignmentDurationInSeconds

      HIT.Builder assignmentDurationInSeconds(Long assignmentDurationInSeconds)

      The length of time, in seconds, that a Worker has to complete the HIT after accepting it.

      Parameters:
      assignmentDurationInSeconds - The length of time, in seconds, that a Worker has to complete the HIT after accepting it.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requesterAnnotation

      HIT.Builder requesterAnnotation(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.

      Parameters:
      requesterAnnotation - An arbitrary data field the Requester who created the HIT can use. This field is visible only to the creator of the HIT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • qualificationRequirements

      HIT.Builder qualificationRequirements(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • qualificationRequirements

      HIT.Builder qualificationRequirements(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • qualificationRequirements

      HIT.Builder qualificationRequirements(Consumer<QualificationRequirement.Builder>... 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.

      This is a convenience method that creates an instance of the QualificationRequirement.Builder avoiding the need to create one manually via QualificationRequirement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to qualificationRequirements(List<QualificationRequirement>).

      Parameters:
      qualificationRequirements - a consumer that will call methods on QualificationRequirement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • hitReviewStatus

      HIT.Builder hitReviewStatus(String hitReviewStatus)

      Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

      Parameters:
      hitReviewStatus - Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • hitReviewStatus

      HIT.Builder hitReviewStatus(HITReviewStatus hitReviewStatus)

      Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.

      Parameters:
      hitReviewStatus - Indicates the review status of the HIT. Valid Values are NotReviewed | MarkedForReview | ReviewedAppropriate | ReviewedInappropriate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • numberOfAssignmentsPending

      HIT.Builder numberOfAssignmentsPending(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • numberOfAssignmentsAvailable

      HIT.Builder numberOfAssignmentsAvailable(Integer numberOfAssignmentsAvailable)

      The number of assignments for this HIT that are available for Workers to accept.

      Parameters:
      numberOfAssignmentsAvailable - The number of assignments for this HIT that are available for Workers to accept.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • numberOfAssignmentsCompleted

      HIT.Builder numberOfAssignmentsCompleted(Integer numberOfAssignmentsCompleted)

      The number of assignments for this HIT that have been approved or rejected.

      Parameters:
      numberOfAssignmentsCompleted - The number of assignments for this HIT that have been approved or rejected.
      Returns:
      Returns a reference to this object so that method calls can be chained together.