Package software.amazon.awssdk.services.mturk.model

Interface CreateHitRequest.Builder

    • Method Detail

      • maxAssignments

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

      • autoApprovalDelayInSeconds

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

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

      • lifetimeInSeconds

        CreateHitRequest.Builder lifetimeInSeconds​(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.

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

      • assignmentDurationInSeconds

        CreateHitRequest.Builder assignmentDurationInSeconds​(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.

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

      • reward

        CreateHitRequest.Builder reward​(String reward)

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

        Parameters:
        reward - The amount of money the Requester will pay a Worker for successfully completing the HIT.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • title

        CreateHitRequest.Builder title​(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.

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

      • keywords

        CreateHitRequest.Builder keywords​(String keywords)

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

        Parameters:
        keywords - One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        CreateHitRequest.Builder description​(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.

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

      • question

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

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

      • requesterAnnotation

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

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

      • qualificationRequirements

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

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

        CreateHitRequest.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).

        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:
        #qualificationRequirements(java.util.Collection)

      • uniqueRequestToken

        CreateHitRequest.Builder uniqueRequestToken​(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.

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

      • assignmentReviewPolicy

        CreateHitRequest.Builder assignmentReviewPolicy​(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.

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

      • hitReviewPolicy

        CreateHitRequest.Builder hitReviewPolicy​(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.

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

      • hitLayoutId

        CreateHitRequest.Builder hitLayoutId​(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.

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

      • hitLayoutParameters

        CreateHitRequest.Builder hitLayoutParameters​(Collection<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.

        Parameters:
        hitLayoutParameters - If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • hitLayoutParameters

        CreateHitRequest.Builder hitLayoutParameters​(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.

        Parameters:
        hitLayoutParameters - If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • hitLayoutParameters

        CreateHitRequest.Builder hitLayoutParameters​(Consumer<HITLayoutParameter.Builder>... hitLayoutParameters)

        If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.

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

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #hitLayoutParameters(List).

        Parameters:
        hitLayoutParameters - a consumer that will call methods on HITLayoutParameter.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #hitLayoutParameters(java.util.Collection)