{-# 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.DocumentMetadataConfiguration
-- 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.DocumentMetadataConfiguration 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.DocumentAttributeValueType
import Amazonka.Kendra.Types.Relevance
import Amazonka.Kendra.Types.Search
import qualified Amazonka.Prelude as Prelude

-- | Specifies the properties, such as relevance tuning and searchability, of
-- an index field.
--
-- /See:/ 'newDocumentMetadataConfiguration' smart constructor.
data DocumentMetadataConfiguration = DocumentMetadataConfiguration'
  { -- | Provides tuning parameters to determine how the field affects the search
    -- results.
    DocumentMetadataConfiguration -> Maybe Relevance
relevance :: Prelude.Maybe Relevance,
    -- | Provides information about how the field is used during a search.
    DocumentMetadataConfiguration -> Maybe Search
search :: Prelude.Maybe Search,
    -- | The name of the index field.
    DocumentMetadataConfiguration -> Text
name :: Prelude.Text,
    -- | The data type of the index field.
    DocumentMetadataConfiguration -> DocumentAttributeValueType
type' :: DocumentAttributeValueType
  }
  deriving (DocumentMetadataConfiguration
-> DocumentMetadataConfiguration -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DocumentMetadataConfiguration
-> DocumentMetadataConfiguration -> Bool
$c/= :: DocumentMetadataConfiguration
-> DocumentMetadataConfiguration -> Bool
== :: DocumentMetadataConfiguration
-> DocumentMetadataConfiguration -> Bool
$c== :: DocumentMetadataConfiguration
-> DocumentMetadataConfiguration -> Bool
Prelude.Eq, ReadPrec [DocumentMetadataConfiguration]
ReadPrec DocumentMetadataConfiguration
Int -> ReadS DocumentMetadataConfiguration
ReadS [DocumentMetadataConfiguration]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DocumentMetadataConfiguration]
$creadListPrec :: ReadPrec [DocumentMetadataConfiguration]
readPrec :: ReadPrec DocumentMetadataConfiguration
$creadPrec :: ReadPrec DocumentMetadataConfiguration
readList :: ReadS [DocumentMetadataConfiguration]
$creadList :: ReadS [DocumentMetadataConfiguration]
readsPrec :: Int -> ReadS DocumentMetadataConfiguration
$creadsPrec :: Int -> ReadS DocumentMetadataConfiguration
Prelude.Read, Int -> DocumentMetadataConfiguration -> ShowS
[DocumentMetadataConfiguration] -> ShowS
DocumentMetadataConfiguration -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DocumentMetadataConfiguration] -> ShowS
$cshowList :: [DocumentMetadataConfiguration] -> ShowS
show :: DocumentMetadataConfiguration -> String
$cshow :: DocumentMetadataConfiguration -> String
showsPrec :: Int -> DocumentMetadataConfiguration -> ShowS
$cshowsPrec :: Int -> DocumentMetadataConfiguration -> ShowS
Prelude.Show, forall x.
Rep DocumentMetadataConfiguration x
-> DocumentMetadataConfiguration
forall x.
DocumentMetadataConfiguration
-> Rep DocumentMetadataConfiguration x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DocumentMetadataConfiguration x
-> DocumentMetadataConfiguration
$cfrom :: forall x.
DocumentMetadataConfiguration
-> Rep DocumentMetadataConfiguration x
Prelude.Generic)

-- |
-- Create a value of 'DocumentMetadataConfiguration' 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:
--
-- 'relevance', 'documentMetadataConfiguration_relevance' - Provides tuning parameters to determine how the field affects the search
-- results.
--
-- 'search', 'documentMetadataConfiguration_search' - Provides information about how the field is used during a search.
--
-- 'name', 'documentMetadataConfiguration_name' - The name of the index field.
--
-- 'type'', 'documentMetadataConfiguration_type' - The data type of the index field.
newDocumentMetadataConfiguration ::
  -- | 'name'
  Prelude.Text ->
  -- | 'type''
  DocumentAttributeValueType ->
  DocumentMetadataConfiguration
newDocumentMetadataConfiguration :: Text -> DocumentAttributeValueType -> DocumentMetadataConfiguration
newDocumentMetadataConfiguration Text
pName_ DocumentAttributeValueType
pType_ =
  DocumentMetadataConfiguration'
    { $sel:relevance:DocumentMetadataConfiguration' :: Maybe Relevance
relevance =
        forall a. Maybe a
Prelude.Nothing,
      $sel:search:DocumentMetadataConfiguration' :: Maybe Search
search = forall a. Maybe a
Prelude.Nothing,
      $sel:name:DocumentMetadataConfiguration' :: Text
name = Text
pName_,
      $sel:type':DocumentMetadataConfiguration' :: DocumentAttributeValueType
type' = DocumentAttributeValueType
pType_
    }

-- | Provides tuning parameters to determine how the field affects the search
-- results.
documentMetadataConfiguration_relevance :: Lens.Lens' DocumentMetadataConfiguration (Prelude.Maybe Relevance)
documentMetadataConfiguration_relevance :: Lens' DocumentMetadataConfiguration (Maybe Relevance)
documentMetadataConfiguration_relevance = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentMetadataConfiguration' {Maybe Relevance
relevance :: Maybe Relevance
$sel:relevance:DocumentMetadataConfiguration' :: DocumentMetadataConfiguration -> Maybe Relevance
relevance} -> Maybe Relevance
relevance) (\s :: DocumentMetadataConfiguration
s@DocumentMetadataConfiguration' {} Maybe Relevance
a -> DocumentMetadataConfiguration
s {$sel:relevance:DocumentMetadataConfiguration' :: Maybe Relevance
relevance = Maybe Relevance
a} :: DocumentMetadataConfiguration)

-- | Provides information about how the field is used during a search.
documentMetadataConfiguration_search :: Lens.Lens' DocumentMetadataConfiguration (Prelude.Maybe Search)
documentMetadataConfiguration_search :: Lens' DocumentMetadataConfiguration (Maybe Search)
documentMetadataConfiguration_search = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentMetadataConfiguration' {Maybe Search
search :: Maybe Search
$sel:search:DocumentMetadataConfiguration' :: DocumentMetadataConfiguration -> Maybe Search
search} -> Maybe Search
search) (\s :: DocumentMetadataConfiguration
s@DocumentMetadataConfiguration' {} Maybe Search
a -> DocumentMetadataConfiguration
s {$sel:search:DocumentMetadataConfiguration' :: Maybe Search
search = Maybe Search
a} :: DocumentMetadataConfiguration)

-- | The name of the index field.
documentMetadataConfiguration_name :: Lens.Lens' DocumentMetadataConfiguration Prelude.Text
documentMetadataConfiguration_name :: Lens' DocumentMetadataConfiguration Text
documentMetadataConfiguration_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentMetadataConfiguration' {Text
name :: Text
$sel:name:DocumentMetadataConfiguration' :: DocumentMetadataConfiguration -> Text
name} -> Text
name) (\s :: DocumentMetadataConfiguration
s@DocumentMetadataConfiguration' {} Text
a -> DocumentMetadataConfiguration
s {$sel:name:DocumentMetadataConfiguration' :: Text
name = Text
a} :: DocumentMetadataConfiguration)

-- | The data type of the index field.
documentMetadataConfiguration_type :: Lens.Lens' DocumentMetadataConfiguration DocumentAttributeValueType
documentMetadataConfiguration_type :: Lens' DocumentMetadataConfiguration DocumentAttributeValueType
documentMetadataConfiguration_type = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentMetadataConfiguration' {DocumentAttributeValueType
type' :: DocumentAttributeValueType
$sel:type':DocumentMetadataConfiguration' :: DocumentMetadataConfiguration -> DocumentAttributeValueType
type'} -> DocumentAttributeValueType
type') (\s :: DocumentMetadataConfiguration
s@DocumentMetadataConfiguration' {} DocumentAttributeValueType
a -> DocumentMetadataConfiguration
s {$sel:type':DocumentMetadataConfiguration' :: DocumentAttributeValueType
type' = DocumentAttributeValueType
a} :: DocumentMetadataConfiguration)

instance Data.FromJSON DocumentMetadataConfiguration where
  parseJSON :: Value -> Parser DocumentMetadataConfiguration
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"DocumentMetadataConfiguration"
      ( \Object
x ->
          Maybe Relevance
-> Maybe Search
-> Text
-> DocumentAttributeValueType
-> DocumentMetadataConfiguration
DocumentMetadataConfiguration'
            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
"Relevance")
            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
"Search")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"Name")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"Type")
      )

instance
  Prelude.Hashable
    DocumentMetadataConfiguration
  where
  hashWithSalt :: Int -> DocumentMetadataConfiguration -> Int
hashWithSalt Int
_salt DocumentMetadataConfiguration' {Maybe Relevance
Maybe Search
Text
DocumentAttributeValueType
type' :: DocumentAttributeValueType
name :: Text
search :: Maybe Search
relevance :: Maybe Relevance
$sel:type':DocumentMetadataConfiguration' :: DocumentMetadataConfiguration -> DocumentAttributeValueType
$sel:name:DocumentMetadataConfiguration' :: DocumentMetadataConfiguration -> Text
$sel:search:DocumentMetadataConfiguration' :: DocumentMetadataConfiguration -> Maybe Search
$sel:relevance:DocumentMetadataConfiguration' :: DocumentMetadataConfiguration -> Maybe Relevance
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Relevance
relevance
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Search
search
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` DocumentAttributeValueType
type'

instance Prelude.NFData DocumentMetadataConfiguration where
  rnf :: DocumentMetadataConfiguration -> ()
rnf DocumentMetadataConfiguration' {Maybe Relevance
Maybe Search
Text
DocumentAttributeValueType
type' :: DocumentAttributeValueType
name :: Text
search :: Maybe Search
relevance :: Maybe Relevance
$sel:type':DocumentMetadataConfiguration' :: DocumentMetadataConfiguration -> DocumentAttributeValueType
$sel:name:DocumentMetadataConfiguration' :: DocumentMetadataConfiguration -> Text
$sel:search:DocumentMetadataConfiguration' :: DocumentMetadataConfiguration -> Maybe Search
$sel:relevance:DocumentMetadataConfiguration' :: DocumentMetadataConfiguration -> Maybe Relevance
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Relevance
relevance
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Search
search
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
name
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf DocumentAttributeValueType
type'

instance Data.ToJSON DocumentMetadataConfiguration where
  toJSON :: DocumentMetadataConfiguration -> Value
toJSON DocumentMetadataConfiguration' {Maybe Relevance
Maybe Search
Text
DocumentAttributeValueType
type' :: DocumentAttributeValueType
name :: Text
search :: Maybe Search
relevance :: Maybe Relevance
$sel:type':DocumentMetadataConfiguration' :: DocumentMetadataConfiguration -> DocumentAttributeValueType
$sel:name:DocumentMetadataConfiguration' :: DocumentMetadataConfiguration -> Text
$sel:search:DocumentMetadataConfiguration' :: DocumentMetadataConfiguration -> Maybe Search
$sel:relevance:DocumentMetadataConfiguration' :: DocumentMetadataConfiguration -> Maybe Relevance
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"Relevance" 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 Relevance
relevance,
            (Key
"Search" 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 Search
search,
            forall a. a -> Maybe a
Prelude.Just (Key
"Name" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
name),
            forall a. a -> Maybe a
Prelude.Just (Key
"Type" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= DocumentAttributeValueType
type')
          ]
      )