{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.MechanicalTurk.Types.ReviewActionDetail
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.MechanicalTurk.Types.ReviewActionDetail where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.MechanicalTurk.Types.ReviewActionStatus
import qualified Amazonka.Prelude as Prelude

-- | 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:/ 'newReviewActionDetail' smart constructor.
data ReviewActionDetail = ReviewActionDetail'
  { -- | The unique identifier for the action.
    ReviewActionDetail -> Maybe Text
actionId :: Prelude.Maybe Prelude.Text,
    -- | 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.
    ReviewActionDetail -> Maybe Text
actionName :: Prelude.Maybe Prelude.Text,
    -- | The date when the action was completed.
    ReviewActionDetail -> Maybe POSIX
completeTime :: Prelude.Maybe Data.POSIX,
    -- | Present only when the Results have a FAILED Status.
    ReviewActionDetail -> Maybe Text
errorCode :: Prelude.Maybe Prelude.Text,
    -- | A description of the outcome of the review.
    ReviewActionDetail -> Maybe Text
result :: Prelude.Maybe Prelude.Text,
    -- | The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or
    -- CANCELLED.
    ReviewActionDetail -> Maybe ReviewActionStatus
status :: Prelude.Maybe ReviewActionStatus,
    -- | The specific HITId or AssignmentID targeted by the action.
    ReviewActionDetail -> Maybe Text
targetId :: Prelude.Maybe Prelude.Text,
    -- | The type of object in TargetId.
    ReviewActionDetail -> Maybe Text
targetType :: Prelude.Maybe Prelude.Text
  }
  deriving (ReviewActionDetail -> ReviewActionDetail -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ReviewActionDetail -> ReviewActionDetail -> Bool
$c/= :: ReviewActionDetail -> ReviewActionDetail -> Bool
== :: ReviewActionDetail -> ReviewActionDetail -> Bool
$c== :: ReviewActionDetail -> ReviewActionDetail -> Bool
Prelude.Eq, ReadPrec [ReviewActionDetail]
ReadPrec ReviewActionDetail
Int -> ReadS ReviewActionDetail
ReadS [ReviewActionDetail]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ReviewActionDetail]
$creadListPrec :: ReadPrec [ReviewActionDetail]
readPrec :: ReadPrec ReviewActionDetail
$creadPrec :: ReadPrec ReviewActionDetail
readList :: ReadS [ReviewActionDetail]
$creadList :: ReadS [ReviewActionDetail]
readsPrec :: Int -> ReadS ReviewActionDetail
$creadsPrec :: Int -> ReadS ReviewActionDetail
Prelude.Read, Int -> ReviewActionDetail -> ShowS
[ReviewActionDetail] -> ShowS
ReviewActionDetail -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ReviewActionDetail] -> ShowS
$cshowList :: [ReviewActionDetail] -> ShowS
show :: ReviewActionDetail -> String
$cshow :: ReviewActionDetail -> String
showsPrec :: Int -> ReviewActionDetail -> ShowS
$cshowsPrec :: Int -> ReviewActionDetail -> ShowS
Prelude.Show, forall x. Rep ReviewActionDetail x -> ReviewActionDetail
forall x. ReviewActionDetail -> Rep ReviewActionDetail x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ReviewActionDetail x -> ReviewActionDetail
$cfrom :: forall x. ReviewActionDetail -> Rep ReviewActionDetail x
Prelude.Generic)

-- |
-- Create a value of 'ReviewActionDetail' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'actionId', 'reviewActionDetail_actionId' - The unique identifier for the action.
--
-- 'actionName', 'reviewActionDetail_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.
--
-- 'completeTime', 'reviewActionDetail_completeTime' - The date when the action was completed.
--
-- 'errorCode', 'reviewActionDetail_errorCode' - Present only when the Results have a FAILED Status.
--
-- 'result', 'reviewActionDetail_result' - A description of the outcome of the review.
--
-- 'status', 'reviewActionDetail_status' - The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or
-- CANCELLED.
--
-- 'targetId', 'reviewActionDetail_targetId' - The specific HITId or AssignmentID targeted by the action.
--
-- 'targetType', 'reviewActionDetail_targetType' - The type of object in TargetId.
newReviewActionDetail ::
  ReviewActionDetail
newReviewActionDetail :: ReviewActionDetail
newReviewActionDetail =
  ReviewActionDetail'
    { $sel:actionId:ReviewActionDetail' :: Maybe Text
actionId = forall a. Maybe a
Prelude.Nothing,
      $sel:actionName:ReviewActionDetail' :: Maybe Text
actionName = forall a. Maybe a
Prelude.Nothing,
      $sel:completeTime:ReviewActionDetail' :: Maybe POSIX
completeTime = forall a. Maybe a
Prelude.Nothing,
      $sel:errorCode:ReviewActionDetail' :: Maybe Text
errorCode = forall a. Maybe a
Prelude.Nothing,
      $sel:result:ReviewActionDetail' :: Maybe Text
result = forall a. Maybe a
Prelude.Nothing,
      $sel:status:ReviewActionDetail' :: Maybe ReviewActionStatus
status = forall a. Maybe a
Prelude.Nothing,
      $sel:targetId:ReviewActionDetail' :: Maybe Text
targetId = forall a. Maybe a
Prelude.Nothing,
      $sel:targetType:ReviewActionDetail' :: Maybe Text
targetType = forall a. Maybe a
Prelude.Nothing
    }

-- | The unique identifier for the action.
reviewActionDetail_actionId :: Lens.Lens' ReviewActionDetail (Prelude.Maybe Prelude.Text)
reviewActionDetail_actionId :: Lens' ReviewActionDetail (Maybe Text)
reviewActionDetail_actionId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ReviewActionDetail' {Maybe Text
actionId :: Maybe Text
$sel:actionId:ReviewActionDetail' :: ReviewActionDetail -> Maybe Text
actionId} -> Maybe Text
actionId) (\s :: ReviewActionDetail
s@ReviewActionDetail' {} Maybe Text
a -> ReviewActionDetail
s {$sel:actionId:ReviewActionDetail' :: Maybe Text
actionId = Maybe Text
a} :: ReviewActionDetail)

-- | 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.
reviewActionDetail_actionName :: Lens.Lens' ReviewActionDetail (Prelude.Maybe Prelude.Text)
reviewActionDetail_actionName :: Lens' ReviewActionDetail (Maybe Text)
reviewActionDetail_actionName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ReviewActionDetail' {Maybe Text
actionName :: Maybe Text
$sel:actionName:ReviewActionDetail' :: ReviewActionDetail -> Maybe Text
actionName} -> Maybe Text
actionName) (\s :: ReviewActionDetail
s@ReviewActionDetail' {} Maybe Text
a -> ReviewActionDetail
s {$sel:actionName:ReviewActionDetail' :: Maybe Text
actionName = Maybe Text
a} :: ReviewActionDetail)

-- | The date when the action was completed.
reviewActionDetail_completeTime :: Lens.Lens' ReviewActionDetail (Prelude.Maybe Prelude.UTCTime)
reviewActionDetail_completeTime :: Lens' ReviewActionDetail (Maybe UTCTime)
reviewActionDetail_completeTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ReviewActionDetail' {Maybe POSIX
completeTime :: Maybe POSIX
$sel:completeTime:ReviewActionDetail' :: ReviewActionDetail -> Maybe POSIX
completeTime} -> Maybe POSIX
completeTime) (\s :: ReviewActionDetail
s@ReviewActionDetail' {} Maybe POSIX
a -> ReviewActionDetail
s {$sel:completeTime:ReviewActionDetail' :: Maybe POSIX
completeTime = Maybe POSIX
a} :: ReviewActionDetail) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall (a :: Format). Iso' (Time a) UTCTime
Data._Time

-- | Present only when the Results have a FAILED Status.
reviewActionDetail_errorCode :: Lens.Lens' ReviewActionDetail (Prelude.Maybe Prelude.Text)
reviewActionDetail_errorCode :: Lens' ReviewActionDetail (Maybe Text)
reviewActionDetail_errorCode = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ReviewActionDetail' {Maybe Text
errorCode :: Maybe Text
$sel:errorCode:ReviewActionDetail' :: ReviewActionDetail -> Maybe Text
errorCode} -> Maybe Text
errorCode) (\s :: ReviewActionDetail
s@ReviewActionDetail' {} Maybe Text
a -> ReviewActionDetail
s {$sel:errorCode:ReviewActionDetail' :: Maybe Text
errorCode = Maybe Text
a} :: ReviewActionDetail)

-- | A description of the outcome of the review.
reviewActionDetail_result :: Lens.Lens' ReviewActionDetail (Prelude.Maybe Prelude.Text)
reviewActionDetail_result :: Lens' ReviewActionDetail (Maybe Text)
reviewActionDetail_result = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ReviewActionDetail' {Maybe Text
result :: Maybe Text
$sel:result:ReviewActionDetail' :: ReviewActionDetail -> Maybe Text
result} -> Maybe Text
result) (\s :: ReviewActionDetail
s@ReviewActionDetail' {} Maybe Text
a -> ReviewActionDetail
s {$sel:result:ReviewActionDetail' :: Maybe Text
result = Maybe Text
a} :: ReviewActionDetail)

-- | The current disposition of the action: INTENDED, SUCCEEDED, FAILED, or
-- CANCELLED.
reviewActionDetail_status :: Lens.Lens' ReviewActionDetail (Prelude.Maybe ReviewActionStatus)
reviewActionDetail_status :: Lens' ReviewActionDetail (Maybe ReviewActionStatus)
reviewActionDetail_status = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ReviewActionDetail' {Maybe ReviewActionStatus
status :: Maybe ReviewActionStatus
$sel:status:ReviewActionDetail' :: ReviewActionDetail -> Maybe ReviewActionStatus
status} -> Maybe ReviewActionStatus
status) (\s :: ReviewActionDetail
s@ReviewActionDetail' {} Maybe ReviewActionStatus
a -> ReviewActionDetail
s {$sel:status:ReviewActionDetail' :: Maybe ReviewActionStatus
status = Maybe ReviewActionStatus
a} :: ReviewActionDetail)

-- | The specific HITId or AssignmentID targeted by the action.
reviewActionDetail_targetId :: Lens.Lens' ReviewActionDetail (Prelude.Maybe Prelude.Text)
reviewActionDetail_targetId :: Lens' ReviewActionDetail (Maybe Text)
reviewActionDetail_targetId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ReviewActionDetail' {Maybe Text
targetId :: Maybe Text
$sel:targetId:ReviewActionDetail' :: ReviewActionDetail -> Maybe Text
targetId} -> Maybe Text
targetId) (\s :: ReviewActionDetail
s@ReviewActionDetail' {} Maybe Text
a -> ReviewActionDetail
s {$sel:targetId:ReviewActionDetail' :: Maybe Text
targetId = Maybe Text
a} :: ReviewActionDetail)

-- | The type of object in TargetId.
reviewActionDetail_targetType :: Lens.Lens' ReviewActionDetail (Prelude.Maybe Prelude.Text)
reviewActionDetail_targetType :: Lens' ReviewActionDetail (Maybe Text)
reviewActionDetail_targetType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ReviewActionDetail' {Maybe Text
targetType :: Maybe Text
$sel:targetType:ReviewActionDetail' :: ReviewActionDetail -> Maybe Text
targetType} -> Maybe Text
targetType) (\s :: ReviewActionDetail
s@ReviewActionDetail' {} Maybe Text
a -> ReviewActionDetail
s {$sel:targetType:ReviewActionDetail' :: Maybe Text
targetType = Maybe Text
a} :: ReviewActionDetail)

instance Data.FromJSON ReviewActionDetail where
  parseJSON :: Value -> Parser ReviewActionDetail
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ReviewActionDetail"
      ( \Object
x ->
          Maybe Text
-> Maybe Text
-> Maybe POSIX
-> Maybe Text
-> Maybe Text
-> Maybe ReviewActionStatus
-> Maybe Text
-> Maybe Text
-> ReviewActionDetail
ReviewActionDetail'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"ActionId")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"ActionName")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"CompleteTime")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"ErrorCode")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Result")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Status")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"TargetId")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"TargetType")
      )

instance Prelude.Hashable ReviewActionDetail where
  hashWithSalt :: Int -> ReviewActionDetail -> Int
hashWithSalt Int
_salt ReviewActionDetail' {Maybe Text
Maybe POSIX
Maybe ReviewActionStatus
targetType :: Maybe Text
targetId :: Maybe Text
status :: Maybe ReviewActionStatus
result :: Maybe Text
errorCode :: Maybe Text
completeTime :: Maybe POSIX
actionName :: Maybe Text
actionId :: Maybe Text
$sel:targetType:ReviewActionDetail' :: ReviewActionDetail -> Maybe Text
$sel:targetId:ReviewActionDetail' :: ReviewActionDetail -> Maybe Text
$sel:status:ReviewActionDetail' :: ReviewActionDetail -> Maybe ReviewActionStatus
$sel:result:ReviewActionDetail' :: ReviewActionDetail -> Maybe Text
$sel:errorCode:ReviewActionDetail' :: ReviewActionDetail -> Maybe Text
$sel:completeTime:ReviewActionDetail' :: ReviewActionDetail -> Maybe POSIX
$sel:actionName:ReviewActionDetail' :: ReviewActionDetail -> Maybe Text
$sel:actionId:ReviewActionDetail' :: ReviewActionDetail -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
actionId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
actionName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
completeTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
errorCode
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
result
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ReviewActionStatus
status
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
targetId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
targetType

instance Prelude.NFData ReviewActionDetail where
  rnf :: ReviewActionDetail -> ()
rnf ReviewActionDetail' {Maybe Text
Maybe POSIX
Maybe ReviewActionStatus
targetType :: Maybe Text
targetId :: Maybe Text
status :: Maybe ReviewActionStatus
result :: Maybe Text
errorCode :: Maybe Text
completeTime :: Maybe POSIX
actionName :: Maybe Text
actionId :: Maybe Text
$sel:targetType:ReviewActionDetail' :: ReviewActionDetail -> Maybe Text
$sel:targetId:ReviewActionDetail' :: ReviewActionDetail -> Maybe Text
$sel:status:ReviewActionDetail' :: ReviewActionDetail -> Maybe ReviewActionStatus
$sel:result:ReviewActionDetail' :: ReviewActionDetail -> Maybe Text
$sel:errorCode:ReviewActionDetail' :: ReviewActionDetail -> Maybe Text
$sel:completeTime:ReviewActionDetail' :: ReviewActionDetail -> Maybe POSIX
$sel:actionName:ReviewActionDetail' :: ReviewActionDetail -> Maybe Text
$sel:actionId:ReviewActionDetail' :: ReviewActionDetail -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
actionId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
actionName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
completeTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
errorCode
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
result
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ReviewActionStatus
status
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
targetId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
targetType