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

Interface CreateHitWithHitTypeRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateHitWithHitTypeRequest.Builder,CreateHitWithHitTypeRequest>, MTurkRequest.Builder, SdkBuilder<CreateHitWithHitTypeRequest.Builder,CreateHitWithHitTypeRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateHitWithHitTypeRequest
public static interface CreateHitWithHitTypeRequest.Builder extends MTurkRequest.Builder, SdkPojo, CopyableBuilder<CreateHitWithHitTypeRequest.Builder,CreateHitWithHitTypeRequest>

  • Method Details

    • hitTypeId

      CreateHitWithHitTypeRequest.Builder hitTypeId(String hitTypeId)

      The HIT type ID you want to create this HIT with.

      Parameters:
      hitTypeId - The HIT type ID you want to create this HIT with.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxAssignments

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

    • lifetimeInSeconds

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

    • question

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

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

    • uniqueRequestToken

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

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

    • assignmentReviewPolicy

      default CreateHitWithHitTypeRequest.Builder assignmentReviewPolicy(Consumer<ReviewPolicy.Builder> 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.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to assignmentReviewPolicy(ReviewPolicy).

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

    • hitReviewPolicy

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

    • hitReviewPolicy

      default CreateHitWithHitTypeRequest.Builder hitReviewPolicy(Consumer<ReviewPolicy.Builder> hitReviewPolicy)

      The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to hitReviewPolicy(ReviewPolicy).

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

    • hitLayoutId

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

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

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

      CreateHitWithHitTypeRequest.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<HITLayoutParameter>).

      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:

    • overrideConfiguration

      CreateHitWithHitTypeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateHitWithHitTypeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.