{-# 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.Kendra.Types.Status
-- 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.Kendra.Types.Status where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Kendra.Types.DocumentStatus
import qualified Amazonka.Prelude as Prelude

-- | Provides information about the status of documents submitted for
-- indexing.
--
-- /See:/ 'newStatus' smart constructor.
data Status = Status'
  { -- | The identifier of the document.
    Status -> Maybe Text
documentId :: Prelude.Maybe Prelude.Text,
    -- | The current status of a document.
    --
    -- If the document was submitted for deletion, the status is @NOT_FOUND@
    -- after the document is deleted.
    Status -> Maybe DocumentStatus
documentStatus :: Prelude.Maybe DocumentStatus,
    -- | Indicates the source of the error.
    Status -> Maybe Text
failureCode :: Prelude.Maybe Prelude.Text,
    -- | Provides detailed information about why the document couldn\'t be
    -- indexed. Use this information to correct the error before you resubmit
    -- the document for indexing.
    Status -> Maybe Text
failureReason :: Prelude.Maybe Prelude.Text
  }
  deriving (Status -> Status -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Status -> Status -> Bool
$c/= :: Status -> Status -> Bool
== :: Status -> Status -> Bool
$c== :: Status -> Status -> Bool
Prelude.Eq, ReadPrec [Status]
ReadPrec Status
Int -> ReadS Status
ReadS [Status]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Status]
$creadListPrec :: ReadPrec [Status]
readPrec :: ReadPrec Status
$creadPrec :: ReadPrec Status
readList :: ReadS [Status]
$creadList :: ReadS [Status]
readsPrec :: Int -> ReadS Status
$creadsPrec :: Int -> ReadS Status
Prelude.Read, Int -> Status -> ShowS
[Status] -> ShowS
Status -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Status] -> ShowS
$cshowList :: [Status] -> ShowS
show :: Status -> String
$cshow :: Status -> String
showsPrec :: Int -> Status -> ShowS
$cshowsPrec :: Int -> Status -> ShowS
Prelude.Show, forall x. Rep Status x -> Status
forall x. Status -> Rep Status x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Status x -> Status
$cfrom :: forall x. Status -> Rep Status x
Prelude.Generic)

-- |
-- Create a value of 'Status' 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:
--
-- 'documentId', 'status_documentId' - The identifier of the document.
--
-- 'documentStatus', 'status_documentStatus' - The current status of a document.
--
-- If the document was submitted for deletion, the status is @NOT_FOUND@
-- after the document is deleted.
--
-- 'failureCode', 'status_failureCode' - Indicates the source of the error.
--
-- 'failureReason', 'status_failureReason' - Provides detailed information about why the document couldn\'t be
-- indexed. Use this information to correct the error before you resubmit
-- the document for indexing.
newStatus ::
  Status
newStatus :: Status
newStatus =
  Status'
    { $sel:documentId:Status' :: Maybe Text
documentId = forall a. Maybe a
Prelude.Nothing,
      $sel:documentStatus:Status' :: Maybe DocumentStatus
documentStatus = forall a. Maybe a
Prelude.Nothing,
      $sel:failureCode:Status' :: Maybe Text
failureCode = forall a. Maybe a
Prelude.Nothing,
      $sel:failureReason:Status' :: Maybe Text
failureReason = forall a. Maybe a
Prelude.Nothing
    }

-- | The identifier of the document.
status_documentId :: Lens.Lens' Status (Prelude.Maybe Prelude.Text)
status_documentId :: Lens' Status (Maybe Text)
status_documentId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Status' {Maybe Text
documentId :: Maybe Text
$sel:documentId:Status' :: Status -> Maybe Text
documentId} -> Maybe Text
documentId) (\s :: Status
s@Status' {} Maybe Text
a -> Status
s {$sel:documentId:Status' :: Maybe Text
documentId = Maybe Text
a} :: Status)

-- | The current status of a document.
--
-- If the document was submitted for deletion, the status is @NOT_FOUND@
-- after the document is deleted.
status_documentStatus :: Lens.Lens' Status (Prelude.Maybe DocumentStatus)
status_documentStatus :: Lens' Status (Maybe DocumentStatus)
status_documentStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Status' {Maybe DocumentStatus
documentStatus :: Maybe DocumentStatus
$sel:documentStatus:Status' :: Status -> Maybe DocumentStatus
documentStatus} -> Maybe DocumentStatus
documentStatus) (\s :: Status
s@Status' {} Maybe DocumentStatus
a -> Status
s {$sel:documentStatus:Status' :: Maybe DocumentStatus
documentStatus = Maybe DocumentStatus
a} :: Status)

-- | Indicates the source of the error.
status_failureCode :: Lens.Lens' Status (Prelude.Maybe Prelude.Text)
status_failureCode :: Lens' Status (Maybe Text)
status_failureCode = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Status' {Maybe Text
failureCode :: Maybe Text
$sel:failureCode:Status' :: Status -> Maybe Text
failureCode} -> Maybe Text
failureCode) (\s :: Status
s@Status' {} Maybe Text
a -> Status
s {$sel:failureCode:Status' :: Maybe Text
failureCode = Maybe Text
a} :: Status)

-- | Provides detailed information about why the document couldn\'t be
-- indexed. Use this information to correct the error before you resubmit
-- the document for indexing.
status_failureReason :: Lens.Lens' Status (Prelude.Maybe Prelude.Text)
status_failureReason :: Lens' Status (Maybe Text)
status_failureReason = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Status' {Maybe Text
failureReason :: Maybe Text
$sel:failureReason:Status' :: Status -> Maybe Text
failureReason} -> Maybe Text
failureReason) (\s :: Status
s@Status' {} Maybe Text
a -> Status
s {$sel:failureReason:Status' :: Maybe Text
failureReason = Maybe Text
a} :: Status)

instance Data.FromJSON Status where
  parseJSON :: Value -> Parser Status
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"Status"
      ( \Object
x ->
          Maybe Text
-> Maybe DocumentStatus -> Maybe Text -> Maybe Text -> Status
Status'
            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
"DocumentId")
            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
"DocumentStatus")
            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
"FailureCode")
            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
"FailureReason")
      )

instance Prelude.Hashable Status where
  hashWithSalt :: Int -> Status -> Int
hashWithSalt Int
_salt Status' {Maybe Text
Maybe DocumentStatus
failureReason :: Maybe Text
failureCode :: Maybe Text
documentStatus :: Maybe DocumentStatus
documentId :: Maybe Text
$sel:failureReason:Status' :: Status -> Maybe Text
$sel:failureCode:Status' :: Status -> Maybe Text
$sel:documentStatus:Status' :: Status -> Maybe DocumentStatus
$sel:documentId:Status' :: Status -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
documentId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe DocumentStatus
documentStatus
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
failureCode
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
failureReason

instance Prelude.NFData Status where
  rnf :: Status -> ()
rnf Status' {Maybe Text
Maybe DocumentStatus
failureReason :: Maybe Text
failureCode :: Maybe Text
documentStatus :: Maybe DocumentStatus
documentId :: Maybe Text
$sel:failureReason:Status' :: Status -> Maybe Text
$sel:failureCode:Status' :: Status -> Maybe Text
$sel:documentStatus:Status' :: Status -> Maybe DocumentStatus
$sel:documentId:Status' :: Status -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
documentId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe DocumentStatus
documentStatus
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
failureCode
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
failureReason