public static interface CreateHitRequest.Builder extends MTurkRequest.Builder, CopyableBuilder<CreateHitRequest.Builder,CreateHitRequest>
Modifier and Type | Method and Description |
---|---|
CreateHitRequest.Builder |
assignmentDurationInSeconds(Long assignmentDurationInSeconds)
The amount of time, in seconds, that a Worker has to complete the HIT after accepting it.
|
default CreateHitRequest.Builder |
assignmentReviewPolicy(Consumer<ReviewPolicy.Builder> assignmentReviewPolicy)
The Assignment-level Review Policy applies to the assignments under the HIT.
|
CreateHitRequest.Builder |
assignmentReviewPolicy(ReviewPolicy assignmentReviewPolicy)
The Assignment-level Review Policy applies to the assignments under the HIT.
|
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.
|
CreateHitRequest.Builder |
description(String description)
A general description of the HIT.
|
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.
|
CreateHitRequest.Builder |
hitLayoutParameters(Collection<HITLayoutParameter> hitLayoutParameters)
If the HITLayoutId is provided, any placeholder values must be filled in with values using the
HITLayoutParameter structure.
|
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.
|
CreateHitRequest.Builder |
hitLayoutParameters(HITLayoutParameter... hitLayoutParameters)
If the HITLayoutId is provided, any placeholder values must be filled in with values using the
HITLayoutParameter structure.
|
default CreateHitRequest.Builder |
hitReviewPolicy(Consumer<ReviewPolicy.Builder> hitReviewPolicy)
The HIT-level Review Policy applies to the HIT.
|
CreateHitRequest.Builder |
hitReviewPolicy(ReviewPolicy hitReviewPolicy)
The HIT-level Review Policy applies to the HIT.
|
CreateHitRequest.Builder |
keywords(String keywords)
One or more words or phrases that describe the HIT, separated by commas.
|
CreateHitRequest.Builder |
lifetimeInSeconds(Long lifetimeInSeconds)
An amount of time, in seconds, after which the HIT is no longer available for users to accept.
|
CreateHitRequest.Builder |
maxAssignments(Integer maxAssignments)
The number of times the HIT can be accepted and completed before the HIT becomes unavailable.
|
CreateHitRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
CreateHitRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
CreateHitRequest.Builder |
qualificationRequirements(Collection<QualificationRequirement> qualificationRequirements)
A condition that a Worker's Qualifications must meet before the Worker is allowed to accept and complete the
HIT.
|
CreateHitRequest.Builder |
qualificationRequirements(Consumer<QualificationRequirement.Builder>... qualificationRequirements)
A condition that a Worker's Qualifications must meet before the Worker is allowed to accept and complete the
HIT.
|
CreateHitRequest.Builder |
qualificationRequirements(QualificationRequirement... qualificationRequirements)
A condition that a Worker's Qualifications must meet before the Worker is allowed to accept and complete the
HIT.
|
CreateHitRequest.Builder |
question(String question)
The data the person completing the HIT uses to produce the results.
|
CreateHitRequest.Builder |
requesterAnnotation(String requesterAnnotation)
An arbitrary data field.
|
CreateHitRequest.Builder |
reward(String reward)
The amount of money the Requester will pay a Worker for successfully completing the HIT.
|
CreateHitRequest.Builder |
title(String title)
The title of the HIT.
|
CreateHitRequest.Builder |
uniqueRequestToken(String uniqueRequestToken)
A unique identifier for this request which allows you to retry the call on error without creating duplicate
HITs.
|
build
overrideConfiguration
copy
applyMutation, build
CreateHitRequest.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.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.
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.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.
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.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.
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.CreateHitRequest.Builder reward(String reward)
The amount of money the Requester will pay a Worker for successfully completing the HIT.
reward
- The amount of money the Requester will pay a Worker for successfully completing the HIT.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.
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.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.
keywords
- One or more words or phrases that describe the HIT, separated by commas. These words are used in
searches to find HITs.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.
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.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.
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.
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.
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.
CreateHitRequest.Builder qualificationRequirements(Collection<QualificationRequirement> qualificationRequirements)
A condition that a Worker's Qualifications must meet before the Worker is allowed to accept and complete the HIT.
qualificationRequirements
- A condition that a Worker's Qualifications must meet before the Worker is allowed to accept and
complete the HIT.CreateHitRequest.Builder qualificationRequirements(QualificationRequirement... qualificationRequirements)
A condition that a Worker's Qualifications must meet before the Worker is allowed to accept and complete the HIT.
qualificationRequirements
- A condition that a Worker's Qualifications must meet before the Worker is allowed to accept and
complete the HIT.CreateHitRequest.Builder qualificationRequirements(Consumer<QualificationRequirement.Builder>... qualificationRequirements)
A condition that a Worker's Qualifications must meet before the Worker is allowed to accept and complete the HIT.
This is a convenience that creates an instance of theList.Builder
avoiding
the need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called
immediately and its result is passed to #qualificationRequirements(List)
.qualificationRequirements
- a consumer that will call methods on List.Builder
#qualificationRequirements(List)
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.
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.
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.
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 CreateHitRequest.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)
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.
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 CreateHitRequest.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)
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.
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.
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.
hitLayoutParameters
- If the HITLayoutId is provided, any placeholder values must be filled in with values using the
HITLayoutParameter structure. For more information, see HITLayout.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.
hitLayoutParameters
- If the HITLayoutId is provided, any placeholder values must be filled in with values using the
HITLayoutParameter structure. For more information, see HITLayout.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 that creates an instance of theList.Builder
avoiding the
need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately
and its result is passed to #hitLayoutParameters(List)
.hitLayoutParameters
- a consumer that will call methods on List.Builder
#hitLayoutParameters(List)
CreateHitRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.CreateHitRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.