Class Assignment
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Assignment.Builder,
Assignment>
The Assignment data structure represents a single assignment of a HIT to a Worker. The assignment tracks the Worker's efforts to complete the HIT, and contains the results for later retrieval.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Instant
The date and time the Worker accepted the assignment.final String
answer()
The Worker's answers submitted for the HIT contained in a QuestionFormAnswers document, if the Worker provides an answer.final Instant
If the Worker has submitted results and the Requester has approved the results, ApprovalTime is the date and time the Requester approved the results.final String
A unique identifier for the assignment.final AssignmentStatus
The status of the assignment.final String
The status of the assignment.final Instant
If results have been submitted, AutoApprovalTime is the date and time the results of the assignment results are considered Approved automatically if they have not already been explicitly approved or rejected by the Requester.static Assignment.Builder
builder()
final Instant
deadline()
The date and time of the deadline for the assignment.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
hitId()
The ID of the HIT.final Instant
If the Worker has submitted results and the Requester has rejected the results, RejectionTime is the date and time the Requester rejected the results.final String
The feedback string included with the call to the ApproveAssignment operation or the RejectAssignment operation, if the Requester approved or rejected the assignment and specified feedback.static Class
<? extends Assignment.Builder> final Instant
If the Worker has submitted results, SubmitTime is the date and time the assignment was submitted.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
workerId()
The ID of the Worker who accepted the HIT.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
assignmentId
A unique identifier for the assignment.
- Returns:
- A unique identifier for the assignment.
-
workerId
The ID of the Worker who accepted the HIT.
- Returns:
- The ID of the Worker who accepted the HIT.
-
hitId
The ID of the HIT.
- Returns:
- The ID of the HIT.
-
assignmentStatus
The status of the assignment.
If the service returns an enum value that is not available in the current SDK version,
assignmentStatus
will returnAssignmentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromassignmentStatusAsString()
.- Returns:
- The status of the assignment.
- See Also:
-
assignmentStatusAsString
The status of the assignment.
If the service returns an enum value that is not available in the current SDK version,
assignmentStatus
will returnAssignmentStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromassignmentStatusAsString()
.- Returns:
- The status of the assignment.
- See Also:
-
autoApprovalTime
If results have been submitted, AutoApprovalTime is the date and time the results of the assignment results are considered Approved automatically if they have not already been explicitly approved or rejected by the Requester. This value is derived from the auto-approval delay specified by the Requester in the HIT. This value is omitted from the assignment if the Worker has not yet submitted results.
- Returns:
- If results have been submitted, AutoApprovalTime is the date and time the results of the assignment results are considered Approved automatically if they have not already been explicitly approved or rejected by the Requester. This value is derived from the auto-approval delay specified by the Requester in the HIT. This value is omitted from the assignment if the Worker has not yet submitted results.
-
acceptTime
The date and time the Worker accepted the assignment.
- Returns:
- The date and time the Worker accepted the assignment.
-
submitTime
If the Worker has submitted results, SubmitTime is the date and time the assignment was submitted. This value is omitted from the assignment if the Worker has not yet submitted results.
- Returns:
- If the Worker has submitted results, SubmitTime is the date and time the assignment was submitted. This value is omitted from the assignment if the Worker has not yet submitted results.
-
approvalTime
If the Worker has submitted results and the Requester has approved the results, ApprovalTime is the date and time the Requester approved the results. This value is omitted from the assignment if the Requester has not yet approved the results.
- Returns:
- If the Worker has submitted results and the Requester has approved the results, ApprovalTime is the date and time the Requester approved the results. This value is omitted from the assignment if the Requester has not yet approved the results.
-
rejectionTime
If the Worker has submitted results and the Requester has rejected the results, RejectionTime is the date and time the Requester rejected the results.
- Returns:
- If the Worker has submitted results and the Requester has rejected the results, RejectionTime is the date and time the Requester rejected the results.
-
deadline
The date and time of the deadline for the assignment. This value is derived from the deadline specification for the HIT and the date and time the Worker accepted the HIT.
- Returns:
- The date and time of the deadline for the assignment. This value is derived from the deadline specification for the HIT and the date and time the Worker accepted the HIT.
-
answer
The Worker's answers submitted for the HIT contained in a QuestionFormAnswers document, if the Worker provides an answer. If the Worker does not provide any answers, Answer may contain a QuestionFormAnswers document, or Answer may be empty.
- Returns:
- The Worker's answers submitted for the HIT contained in a QuestionFormAnswers document, if the Worker provides an answer. If the Worker does not provide any answers, Answer may contain a QuestionFormAnswers document, or Answer may be empty.
-
requesterFeedback
The feedback string included with the call to the ApproveAssignment operation or the RejectAssignment operation, if the Requester approved or rejected the assignment and specified feedback.
- Returns:
- The feedback string included with the call to the ApproveAssignment operation or the RejectAssignment operation, if the Requester approved or rejected the assignment and specified feedback.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Assignment.Builder,
Assignment> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
-
sdkFields
-