Package 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("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:

  • Method Details

    • 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:

    • 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:

    • 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()
      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 interface ToCopyableBuilder<ReviewActionDetail.Builder,ReviewActionDetail>
      Returns:
      a builder for type T

    • 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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.