public static interface CreateHITWithHITTypeRequest.Builder extends MTurkRequest.Builder, CopyableBuilder<CreateHITWithHITTypeRequest.Builder,CreateHITWithHITTypeRequest>
Modifier and Type | Method and Description |
---|---|
default CreateHITWithHITTypeRequest.Builder |
assignmentReviewPolicy(Consumer<ReviewPolicy.Builder> assignmentReviewPolicy)
The Assignment-level Review Policy applies to the assignments under the HIT.
|
CreateHITWithHITTypeRequest.Builder |
assignmentReviewPolicy(ReviewPolicy assignmentReviewPolicy)
The Assignment-level Review Policy applies to the assignments under the HIT.
|
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.
|
CreateHITWithHITTypeRequest.Builder |
hitLayoutParameters(Collection<HITLayoutParameter> hitLayoutParameters)
If the HITLayoutId is provided, any placeholder values must be filled in with values using the
HITLayoutParameter structure.
|
CreateHITWithHITTypeRequest.Builder |
hitLayoutParameters(HITLayoutParameter... hitLayoutParameters)
If the HITLayoutId is provided, any placeholder values must be filled in with values using the
HITLayoutParameter structure.
|
default CreateHITWithHITTypeRequest.Builder |
hitReviewPolicy(Consumer<ReviewPolicy.Builder> hitReviewPolicy)
The HIT-level Review Policy applies to the HIT.
|
CreateHITWithHITTypeRequest.Builder |
hitReviewPolicy(ReviewPolicy hitReviewPolicy)
The HIT-level Review Policy applies to the HIT.
|
CreateHITWithHITTypeRequest.Builder |
hitTypeId(String hitTypeId)
The HIT type ID you want to create this HIT with.
|
CreateHITWithHITTypeRequest.Builder |
lifetimeInSeconds(Long lifetimeInSeconds)
An amount of time, in seconds, after which the HIT is no longer available for users to accept.
|
CreateHITWithHITTypeRequest.Builder |
maxAssignments(Integer maxAssignments)
The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
|
CreateHITWithHITTypeRequest.Builder |
question(String question)
The data the person completing the HIT uses to produce the results.
|
CreateHITWithHITTypeRequest.Builder |
requesterAnnotation(String requesterAnnotation)
An arbitrary data field.
|
CreateHITWithHITTypeRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
CreateHITWithHITTypeRequest.Builder |
uniqueRequestToken(String uniqueRequestToken)
A unique identifier for this request which allows you to retry the call on error without creating duplicate
HITs.
|
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
CreateHITWithHITTypeRequest.Builder hitTypeId(String hitTypeId)
The HIT type ID you want to create this HIT with.
hitTypeId
- The HIT type ID you want to create this HIT with.CreateHITWithHITTypeRequest.Builder maxAssignments(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.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.
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.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.
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.
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.
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.
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.
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.
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.
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.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 that creates an instance of theReviewPolicy.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)
.assignmentReviewPolicy
- a consumer that will call methods on ReviewPolicy.Builder
assignmentReviewPolicy(ReviewPolicy)
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.
hitReviewPolicy
- The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various
actions based on the policy.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 that creates an instance of theReviewPolicy.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)
.hitReviewPolicy
- a consumer that will call methods on ReviewPolicy.Builder
hitReviewPolicy(ReviewPolicy)
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.
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.
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.
hitLayoutParameters
- If the HITLayoutId is provided, any placeholder values must be filled in with values using the
HITLayoutParameter structure. For more information, see HITLayout.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.
hitLayoutParameters
- If the HITLayoutId is provided, any placeholder values must be filled in with values using the
HITLayoutParameter structure. For more information, see HITLayout.CreateHITWithHITTypeRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.