software.amazon.awssdk.services.mturk.model

Class ReviewActionDetail

java.lang.Object

software.amazon.awssdk.services.mturk.model.ReviewActionDetail

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ReviewActionDetail.Builder,ReviewActionDetail>

@Generated(value="software.amazon.awssdk:codegen")
public final class ReviewActionDetail
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ReviewActionDetail.Builder,ReviewActionDetail>

Both the AssignmentReviewReport and the HITReviewReport elements contains the ReviewActionDetail data structure. This structure is returned multiple times for each action specified in the Review Policy.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ReviewActionDetail.Builder

Method Summary

Modifier and Type	Method and Description
String	actionId() The unique identifier for the action.
String	actionName() The nature of the action itself.
static ReviewActionDetail.Builder	builder()
Instant	completeTime() The date when the action was completed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	errorCode() Present only when the Results have a FAILED Status.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	result() A description of the outcome of the review.
List<SdkField<?>>	sdkFields()
static Class<? extends ReviewActionDetail.Builder>	serializableBuilderClass()
ReviewActionStatus	status() The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or CANCELLED.
String	statusAsString() The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or CANCELLED.
String	targetId() The specific HITId or AssignmentID targeted by the action.
String	targetType() The type of object in TargetId.
ReviewActionDetail.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

actionId

public final String actionId()

The unique identifier for the action.

Returns:

The unique identifier for the action.

actionName

public final String actionName()

The nature of the action itself. The Review Policy is responsible for examining the HIT and Assignments, emitting results, and deciding which other actions will be necessary.

Returns:

The nature of the action itself. The Review Policy is responsible for examining the HIT and Assignments, emitting results, and deciding which other actions will be necessary.

targetId

public final String targetId()

The specific HITId or AssignmentID targeted by the action.

Returns:

The specific HITId or AssignmentID targeted by the action.

targetType

public final String targetType()

The type of object in TargetId.

Returns:

The type of object in TargetId.

status

public final ReviewActionStatus status()

The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or CANCELLED.

If the service returns an enum value that is not available in the current SDK version, status will return ReviewActionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or CANCELLED.

See Also:

ReviewActionStatus

statusAsString

public final String statusAsString()

The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or CANCELLED.

If the service returns an enum value that is not available in the current SDK version, status will return ReviewActionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or CANCELLED.

See Also:

ReviewActionStatus

completeTime

public final Instant completeTime()

The date when the action was completed.

Returns:

The date when the action was completed.

result

public final String result()

A description of the outcome of the review.

Returns:

A description of the outcome of the review.

errorCode

public final String errorCode()

Present only when the Results have a FAILED Status.

Returns:

Present only when the Results have a FAILED Status.

toBuilder

public ReviewActionDetail.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ReviewActionDetail.Builder,ReviewActionDetail>

builder

public static ReviewActionDetail.Builder builder()

serializableBuilderClass

public static Class<? extends ReviewActionDetail.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String 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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo