{-# 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.InlineCustomDocumentEnrichmentConfiguration
-- 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.InlineCustomDocumentEnrichmentConfiguration 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.DocumentAttributeCondition
import Amazonka.Kendra.Types.DocumentAttributeTarget
import qualified Amazonka.Prelude as Prelude

-- | Provides the configuration information for applying basic logic to alter
-- document metadata and content when ingesting documents into Amazon
-- Kendra. To apply advanced logic, to go beyond what you can do with basic
-- logic, see
-- <https://docs.aws.amazon.com/kendra/latest/dg/API_HookConfiguration.html HookConfiguration>.
--
-- For more information, see
-- <https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html Customizing document metadata during the ingestion process>.
--
-- /See:/ 'newInlineCustomDocumentEnrichmentConfiguration' smart constructor.
data InlineCustomDocumentEnrichmentConfiguration = InlineCustomDocumentEnrichmentConfiguration'
  { -- | Configuration of the condition used for the target document attribute or
    -- metadata field when ingesting documents into Amazon Kendra.
    InlineCustomDocumentEnrichmentConfiguration
-> Maybe DocumentAttributeCondition
condition :: Prelude.Maybe DocumentAttributeCondition,
    -- | @TRUE@ to delete content if the condition used for the target attribute
    -- is met.
    InlineCustomDocumentEnrichmentConfiguration -> Maybe Bool
documentContentDeletion :: Prelude.Maybe Prelude.Bool,
    -- | Configuration of the target document attribute or metadata field when
    -- ingesting documents into Amazon Kendra. You can also include a value.
    InlineCustomDocumentEnrichmentConfiguration
-> Maybe DocumentAttributeTarget
target :: Prelude.Maybe DocumentAttributeTarget
  }
  deriving (InlineCustomDocumentEnrichmentConfiguration
-> InlineCustomDocumentEnrichmentConfiguration -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: InlineCustomDocumentEnrichmentConfiguration
-> InlineCustomDocumentEnrichmentConfiguration -> Bool
$c/= :: InlineCustomDocumentEnrichmentConfiguration
-> InlineCustomDocumentEnrichmentConfiguration -> Bool
== :: InlineCustomDocumentEnrichmentConfiguration
-> InlineCustomDocumentEnrichmentConfiguration -> Bool
$c== :: InlineCustomDocumentEnrichmentConfiguration
-> InlineCustomDocumentEnrichmentConfiguration -> Bool
Prelude.Eq, ReadPrec [InlineCustomDocumentEnrichmentConfiguration]
ReadPrec InlineCustomDocumentEnrichmentConfiguration
Int -> ReadS InlineCustomDocumentEnrichmentConfiguration
ReadS [InlineCustomDocumentEnrichmentConfiguration]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [InlineCustomDocumentEnrichmentConfiguration]
$creadListPrec :: ReadPrec [InlineCustomDocumentEnrichmentConfiguration]
readPrec :: ReadPrec InlineCustomDocumentEnrichmentConfiguration
$creadPrec :: ReadPrec InlineCustomDocumentEnrichmentConfiguration
readList :: ReadS [InlineCustomDocumentEnrichmentConfiguration]
$creadList :: ReadS [InlineCustomDocumentEnrichmentConfiguration]
readsPrec :: Int -> ReadS InlineCustomDocumentEnrichmentConfiguration
$creadsPrec :: Int -> ReadS InlineCustomDocumentEnrichmentConfiguration
Prelude.Read, Int -> InlineCustomDocumentEnrichmentConfiguration -> ShowS
[InlineCustomDocumentEnrichmentConfiguration] -> ShowS
InlineCustomDocumentEnrichmentConfiguration -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [InlineCustomDocumentEnrichmentConfiguration] -> ShowS
$cshowList :: [InlineCustomDocumentEnrichmentConfiguration] -> ShowS
show :: InlineCustomDocumentEnrichmentConfiguration -> String
$cshow :: InlineCustomDocumentEnrichmentConfiguration -> String
showsPrec :: Int -> InlineCustomDocumentEnrichmentConfiguration -> ShowS
$cshowsPrec :: Int -> InlineCustomDocumentEnrichmentConfiguration -> ShowS
Prelude.Show, forall x.
Rep InlineCustomDocumentEnrichmentConfiguration x
-> InlineCustomDocumentEnrichmentConfiguration
forall x.
InlineCustomDocumentEnrichmentConfiguration
-> Rep InlineCustomDocumentEnrichmentConfiguration x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep InlineCustomDocumentEnrichmentConfiguration x
-> InlineCustomDocumentEnrichmentConfiguration
$cfrom :: forall x.
InlineCustomDocumentEnrichmentConfiguration
-> Rep InlineCustomDocumentEnrichmentConfiguration x
Prelude.Generic)

-- |
-- Create a value of 'InlineCustomDocumentEnrichmentConfiguration' 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:
--
-- 'condition', 'inlineCustomDocumentEnrichmentConfiguration_condition' - Configuration of the condition used for the target document attribute or
-- metadata field when ingesting documents into Amazon Kendra.
--
-- 'documentContentDeletion', 'inlineCustomDocumentEnrichmentConfiguration_documentContentDeletion' - @TRUE@ to delete content if the condition used for the target attribute
-- is met.
--
-- 'target', 'inlineCustomDocumentEnrichmentConfiguration_target' - Configuration of the target document attribute or metadata field when
-- ingesting documents into Amazon Kendra. You can also include a value.
newInlineCustomDocumentEnrichmentConfiguration ::
  InlineCustomDocumentEnrichmentConfiguration
newInlineCustomDocumentEnrichmentConfiguration :: InlineCustomDocumentEnrichmentConfiguration
newInlineCustomDocumentEnrichmentConfiguration =
  InlineCustomDocumentEnrichmentConfiguration'
    { $sel:condition:InlineCustomDocumentEnrichmentConfiguration' :: Maybe DocumentAttributeCondition
condition =
        forall a. Maybe a
Prelude.Nothing,
      $sel:documentContentDeletion:InlineCustomDocumentEnrichmentConfiguration' :: Maybe Bool
documentContentDeletion =
        forall a. Maybe a
Prelude.Nothing,
      $sel:target:InlineCustomDocumentEnrichmentConfiguration' :: Maybe DocumentAttributeTarget
target = forall a. Maybe a
Prelude.Nothing
    }

-- | Configuration of the condition used for the target document attribute or
-- metadata field when ingesting documents into Amazon Kendra.
inlineCustomDocumentEnrichmentConfiguration_condition :: Lens.Lens' InlineCustomDocumentEnrichmentConfiguration (Prelude.Maybe DocumentAttributeCondition)
inlineCustomDocumentEnrichmentConfiguration_condition :: Lens'
  InlineCustomDocumentEnrichmentConfiguration
  (Maybe DocumentAttributeCondition)
inlineCustomDocumentEnrichmentConfiguration_condition = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InlineCustomDocumentEnrichmentConfiguration' {Maybe DocumentAttributeCondition
condition :: Maybe DocumentAttributeCondition
$sel:condition:InlineCustomDocumentEnrichmentConfiguration' :: InlineCustomDocumentEnrichmentConfiguration
-> Maybe DocumentAttributeCondition
condition} -> Maybe DocumentAttributeCondition
condition) (\s :: InlineCustomDocumentEnrichmentConfiguration
s@InlineCustomDocumentEnrichmentConfiguration' {} Maybe DocumentAttributeCondition
a -> InlineCustomDocumentEnrichmentConfiguration
s {$sel:condition:InlineCustomDocumentEnrichmentConfiguration' :: Maybe DocumentAttributeCondition
condition = Maybe DocumentAttributeCondition
a} :: InlineCustomDocumentEnrichmentConfiguration)

-- | @TRUE@ to delete content if the condition used for the target attribute
-- is met.
inlineCustomDocumentEnrichmentConfiguration_documentContentDeletion :: Lens.Lens' InlineCustomDocumentEnrichmentConfiguration (Prelude.Maybe Prelude.Bool)
inlineCustomDocumentEnrichmentConfiguration_documentContentDeletion :: Lens' InlineCustomDocumentEnrichmentConfiguration (Maybe Bool)
inlineCustomDocumentEnrichmentConfiguration_documentContentDeletion = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InlineCustomDocumentEnrichmentConfiguration' {Maybe Bool
documentContentDeletion :: Maybe Bool
$sel:documentContentDeletion:InlineCustomDocumentEnrichmentConfiguration' :: InlineCustomDocumentEnrichmentConfiguration -> Maybe Bool
documentContentDeletion} -> Maybe Bool
documentContentDeletion) (\s :: InlineCustomDocumentEnrichmentConfiguration
s@InlineCustomDocumentEnrichmentConfiguration' {} Maybe Bool
a -> InlineCustomDocumentEnrichmentConfiguration
s {$sel:documentContentDeletion:InlineCustomDocumentEnrichmentConfiguration' :: Maybe Bool
documentContentDeletion = Maybe Bool
a} :: InlineCustomDocumentEnrichmentConfiguration)

-- | Configuration of the target document attribute or metadata field when
-- ingesting documents into Amazon Kendra. You can also include a value.
inlineCustomDocumentEnrichmentConfiguration_target :: Lens.Lens' InlineCustomDocumentEnrichmentConfiguration (Prelude.Maybe DocumentAttributeTarget)
inlineCustomDocumentEnrichmentConfiguration_target :: Lens'
  InlineCustomDocumentEnrichmentConfiguration
  (Maybe DocumentAttributeTarget)
inlineCustomDocumentEnrichmentConfiguration_target = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\InlineCustomDocumentEnrichmentConfiguration' {Maybe DocumentAttributeTarget
target :: Maybe DocumentAttributeTarget
$sel:target:InlineCustomDocumentEnrichmentConfiguration' :: InlineCustomDocumentEnrichmentConfiguration
-> Maybe DocumentAttributeTarget
target} -> Maybe DocumentAttributeTarget
target) (\s :: InlineCustomDocumentEnrichmentConfiguration
s@InlineCustomDocumentEnrichmentConfiguration' {} Maybe DocumentAttributeTarget
a -> InlineCustomDocumentEnrichmentConfiguration
s {$sel:target:InlineCustomDocumentEnrichmentConfiguration' :: Maybe DocumentAttributeTarget
target = Maybe DocumentAttributeTarget
a} :: InlineCustomDocumentEnrichmentConfiguration)

instance
  Data.FromJSON
    InlineCustomDocumentEnrichmentConfiguration
  where
  parseJSON :: Value -> Parser InlineCustomDocumentEnrichmentConfiguration
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"InlineCustomDocumentEnrichmentConfiguration"
      ( \Object
x ->
          Maybe DocumentAttributeCondition
-> Maybe Bool
-> Maybe DocumentAttributeTarget
-> InlineCustomDocumentEnrichmentConfiguration
InlineCustomDocumentEnrichmentConfiguration'
            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
"Condition")
            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
"DocumentContentDeletion")
            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
"Target")
      )

instance
  Prelude.Hashable
    InlineCustomDocumentEnrichmentConfiguration
  where
  hashWithSalt :: Int -> InlineCustomDocumentEnrichmentConfiguration -> Int
hashWithSalt
    Int
_salt
    InlineCustomDocumentEnrichmentConfiguration' {Maybe Bool
Maybe DocumentAttributeTarget
Maybe DocumentAttributeCondition
target :: Maybe DocumentAttributeTarget
documentContentDeletion :: Maybe Bool
condition :: Maybe DocumentAttributeCondition
$sel:target:InlineCustomDocumentEnrichmentConfiguration' :: InlineCustomDocumentEnrichmentConfiguration
-> Maybe DocumentAttributeTarget
$sel:documentContentDeletion:InlineCustomDocumentEnrichmentConfiguration' :: InlineCustomDocumentEnrichmentConfiguration -> Maybe Bool
$sel:condition:InlineCustomDocumentEnrichmentConfiguration' :: InlineCustomDocumentEnrichmentConfiguration
-> Maybe DocumentAttributeCondition
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe DocumentAttributeCondition
condition
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
documentContentDeletion
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe DocumentAttributeTarget
target

instance
  Prelude.NFData
    InlineCustomDocumentEnrichmentConfiguration
  where
  rnf :: InlineCustomDocumentEnrichmentConfiguration -> ()
rnf InlineCustomDocumentEnrichmentConfiguration' {Maybe Bool
Maybe DocumentAttributeTarget
Maybe DocumentAttributeCondition
target :: Maybe DocumentAttributeTarget
documentContentDeletion :: Maybe Bool
condition :: Maybe DocumentAttributeCondition
$sel:target:InlineCustomDocumentEnrichmentConfiguration' :: InlineCustomDocumentEnrichmentConfiguration
-> Maybe DocumentAttributeTarget
$sel:documentContentDeletion:InlineCustomDocumentEnrichmentConfiguration' :: InlineCustomDocumentEnrichmentConfiguration -> Maybe Bool
$sel:condition:InlineCustomDocumentEnrichmentConfiguration' :: InlineCustomDocumentEnrichmentConfiguration
-> Maybe DocumentAttributeCondition
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe DocumentAttributeCondition
condition
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
documentContentDeletion
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe DocumentAttributeTarget
target

instance
  Data.ToJSON
    InlineCustomDocumentEnrichmentConfiguration
  where
  toJSON :: InlineCustomDocumentEnrichmentConfiguration -> Value
toJSON
    InlineCustomDocumentEnrichmentConfiguration' {Maybe Bool
Maybe DocumentAttributeTarget
Maybe DocumentAttributeCondition
target :: Maybe DocumentAttributeTarget
documentContentDeletion :: Maybe Bool
condition :: Maybe DocumentAttributeCondition
$sel:target:InlineCustomDocumentEnrichmentConfiguration' :: InlineCustomDocumentEnrichmentConfiguration
-> Maybe DocumentAttributeTarget
$sel:documentContentDeletion:InlineCustomDocumentEnrichmentConfiguration' :: InlineCustomDocumentEnrichmentConfiguration -> Maybe Bool
$sel:condition:InlineCustomDocumentEnrichmentConfiguration' :: InlineCustomDocumentEnrichmentConfiguration
-> Maybe DocumentAttributeCondition
..} =
      [Pair] -> Value
Data.object
        ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
            [ (Key
"Condition" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe DocumentAttributeCondition
condition,
              (Key
"DocumentContentDeletion" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
                forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
documentContentDeletion,
              (Key
"Target" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe DocumentAttributeTarget
target
            ]
        )