{-# 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.ConfluencePageToIndexFieldMapping
-- 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.ConfluencePageToIndexFieldMapping 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.ConfluencePageFieldName
import qualified Amazonka.Prelude as Prelude

-- | >Maps attributes or field names of Confluence pages to Amazon Kendra
-- index field names. To create custom fields, use the @UpdateIndex@ API
-- before you map to Confluence fields. For more information, see
-- <https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html Mapping data source fields>.
-- The Confluence data source field names must exist in your Confluence
-- custom metadata.
--
-- /See:/ 'newConfluencePageToIndexFieldMapping' smart constructor.
data ConfluencePageToIndexFieldMapping = ConfluencePageToIndexFieldMapping'
  { -- | The name of the field in the data source.
    ConfluencePageToIndexFieldMapping -> Maybe ConfluencePageFieldName
dataSourceFieldName :: Prelude.Maybe ConfluencePageFieldName,
    -- | The format for date fields in the data source. If the field specified in
    -- @DataSourceFieldName@ is a date field you must specify the date format.
    -- If the field is not a date field, an exception is thrown.
    ConfluencePageToIndexFieldMapping -> Maybe Text
dateFieldFormat :: Prelude.Maybe Prelude.Text,
    -- | The name of the index field to map to the Confluence data source field.
    -- The index field type must match the Confluence field type.
    ConfluencePageToIndexFieldMapping -> Maybe Text
indexFieldName :: Prelude.Maybe Prelude.Text
  }
  deriving (ConfluencePageToIndexFieldMapping
-> ConfluencePageToIndexFieldMapping -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ConfluencePageToIndexFieldMapping
-> ConfluencePageToIndexFieldMapping -> Bool
$c/= :: ConfluencePageToIndexFieldMapping
-> ConfluencePageToIndexFieldMapping -> Bool
== :: ConfluencePageToIndexFieldMapping
-> ConfluencePageToIndexFieldMapping -> Bool
$c== :: ConfluencePageToIndexFieldMapping
-> ConfluencePageToIndexFieldMapping -> Bool
Prelude.Eq, ReadPrec [ConfluencePageToIndexFieldMapping]
ReadPrec ConfluencePageToIndexFieldMapping
Int -> ReadS ConfluencePageToIndexFieldMapping
ReadS [ConfluencePageToIndexFieldMapping]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ConfluencePageToIndexFieldMapping]
$creadListPrec :: ReadPrec [ConfluencePageToIndexFieldMapping]
readPrec :: ReadPrec ConfluencePageToIndexFieldMapping
$creadPrec :: ReadPrec ConfluencePageToIndexFieldMapping
readList :: ReadS [ConfluencePageToIndexFieldMapping]
$creadList :: ReadS [ConfluencePageToIndexFieldMapping]
readsPrec :: Int -> ReadS ConfluencePageToIndexFieldMapping
$creadsPrec :: Int -> ReadS ConfluencePageToIndexFieldMapping
Prelude.Read, Int -> ConfluencePageToIndexFieldMapping -> ShowS
[ConfluencePageToIndexFieldMapping] -> ShowS
ConfluencePageToIndexFieldMapping -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ConfluencePageToIndexFieldMapping] -> ShowS
$cshowList :: [ConfluencePageToIndexFieldMapping] -> ShowS
show :: ConfluencePageToIndexFieldMapping -> String
$cshow :: ConfluencePageToIndexFieldMapping -> String
showsPrec :: Int -> ConfluencePageToIndexFieldMapping -> ShowS
$cshowsPrec :: Int -> ConfluencePageToIndexFieldMapping -> ShowS
Prelude.Show, forall x.
Rep ConfluencePageToIndexFieldMapping x
-> ConfluencePageToIndexFieldMapping
forall x.
ConfluencePageToIndexFieldMapping
-> Rep ConfluencePageToIndexFieldMapping x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ConfluencePageToIndexFieldMapping x
-> ConfluencePageToIndexFieldMapping
$cfrom :: forall x.
ConfluencePageToIndexFieldMapping
-> Rep ConfluencePageToIndexFieldMapping x
Prelude.Generic)

-- |
-- Create a value of 'ConfluencePageToIndexFieldMapping' 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:
--
-- 'dataSourceFieldName', 'confluencePageToIndexFieldMapping_dataSourceFieldName' - The name of the field in the data source.
--
-- 'dateFieldFormat', 'confluencePageToIndexFieldMapping_dateFieldFormat' - The format for date fields in the data source. If the field specified in
-- @DataSourceFieldName@ is a date field you must specify the date format.
-- If the field is not a date field, an exception is thrown.
--
-- 'indexFieldName', 'confluencePageToIndexFieldMapping_indexFieldName' - The name of the index field to map to the Confluence data source field.
-- The index field type must match the Confluence field type.
newConfluencePageToIndexFieldMapping ::
  ConfluencePageToIndexFieldMapping
newConfluencePageToIndexFieldMapping :: ConfluencePageToIndexFieldMapping
newConfluencePageToIndexFieldMapping =
  ConfluencePageToIndexFieldMapping'
    { $sel:dataSourceFieldName:ConfluencePageToIndexFieldMapping' :: Maybe ConfluencePageFieldName
dataSourceFieldName =
        forall a. Maybe a
Prelude.Nothing,
      $sel:dateFieldFormat:ConfluencePageToIndexFieldMapping' :: Maybe Text
dateFieldFormat = forall a. Maybe a
Prelude.Nothing,
      $sel:indexFieldName:ConfluencePageToIndexFieldMapping' :: Maybe Text
indexFieldName = forall a. Maybe a
Prelude.Nothing
    }

-- | The name of the field in the data source.
confluencePageToIndexFieldMapping_dataSourceFieldName :: Lens.Lens' ConfluencePageToIndexFieldMapping (Prelude.Maybe ConfluencePageFieldName)
confluencePageToIndexFieldMapping_dataSourceFieldName :: Lens'
  ConfluencePageToIndexFieldMapping (Maybe ConfluencePageFieldName)
confluencePageToIndexFieldMapping_dataSourceFieldName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ConfluencePageToIndexFieldMapping' {Maybe ConfluencePageFieldName
dataSourceFieldName :: Maybe ConfluencePageFieldName
$sel:dataSourceFieldName:ConfluencePageToIndexFieldMapping' :: ConfluencePageToIndexFieldMapping -> Maybe ConfluencePageFieldName
dataSourceFieldName} -> Maybe ConfluencePageFieldName
dataSourceFieldName) (\s :: ConfluencePageToIndexFieldMapping
s@ConfluencePageToIndexFieldMapping' {} Maybe ConfluencePageFieldName
a -> ConfluencePageToIndexFieldMapping
s {$sel:dataSourceFieldName:ConfluencePageToIndexFieldMapping' :: Maybe ConfluencePageFieldName
dataSourceFieldName = Maybe ConfluencePageFieldName
a} :: ConfluencePageToIndexFieldMapping)

-- | The format for date fields in the data source. If the field specified in
-- @DataSourceFieldName@ is a date field you must specify the date format.
-- If the field is not a date field, an exception is thrown.
confluencePageToIndexFieldMapping_dateFieldFormat :: Lens.Lens' ConfluencePageToIndexFieldMapping (Prelude.Maybe Prelude.Text)
confluencePageToIndexFieldMapping_dateFieldFormat :: Lens' ConfluencePageToIndexFieldMapping (Maybe Text)
confluencePageToIndexFieldMapping_dateFieldFormat = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ConfluencePageToIndexFieldMapping' {Maybe Text
dateFieldFormat :: Maybe Text
$sel:dateFieldFormat:ConfluencePageToIndexFieldMapping' :: ConfluencePageToIndexFieldMapping -> Maybe Text
dateFieldFormat} -> Maybe Text
dateFieldFormat) (\s :: ConfluencePageToIndexFieldMapping
s@ConfluencePageToIndexFieldMapping' {} Maybe Text
a -> ConfluencePageToIndexFieldMapping
s {$sel:dateFieldFormat:ConfluencePageToIndexFieldMapping' :: Maybe Text
dateFieldFormat = Maybe Text
a} :: ConfluencePageToIndexFieldMapping)

-- | The name of the index field to map to the Confluence data source field.
-- The index field type must match the Confluence field type.
confluencePageToIndexFieldMapping_indexFieldName :: Lens.Lens' ConfluencePageToIndexFieldMapping (Prelude.Maybe Prelude.Text)
confluencePageToIndexFieldMapping_indexFieldName :: Lens' ConfluencePageToIndexFieldMapping (Maybe Text)
confluencePageToIndexFieldMapping_indexFieldName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ConfluencePageToIndexFieldMapping' {Maybe Text
indexFieldName :: Maybe Text
$sel:indexFieldName:ConfluencePageToIndexFieldMapping' :: ConfluencePageToIndexFieldMapping -> Maybe Text
indexFieldName} -> Maybe Text
indexFieldName) (\s :: ConfluencePageToIndexFieldMapping
s@ConfluencePageToIndexFieldMapping' {} Maybe Text
a -> ConfluencePageToIndexFieldMapping
s {$sel:indexFieldName:ConfluencePageToIndexFieldMapping' :: Maybe Text
indexFieldName = Maybe Text
a} :: ConfluencePageToIndexFieldMapping)

instance
  Data.FromJSON
    ConfluencePageToIndexFieldMapping
  where
  parseJSON :: Value -> Parser ConfluencePageToIndexFieldMapping
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ConfluencePageToIndexFieldMapping"
      ( \Object
x ->
          Maybe ConfluencePageFieldName
-> Maybe Text -> Maybe Text -> ConfluencePageToIndexFieldMapping
ConfluencePageToIndexFieldMapping'
            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
"DataSourceFieldName")
            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
"DateFieldFormat")
            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
"IndexFieldName")
      )

instance
  Prelude.Hashable
    ConfluencePageToIndexFieldMapping
  where
  hashWithSalt :: Int -> ConfluencePageToIndexFieldMapping -> Int
hashWithSalt
    Int
_salt
    ConfluencePageToIndexFieldMapping' {Maybe Text
Maybe ConfluencePageFieldName
indexFieldName :: Maybe Text
dateFieldFormat :: Maybe Text
dataSourceFieldName :: Maybe ConfluencePageFieldName
$sel:indexFieldName:ConfluencePageToIndexFieldMapping' :: ConfluencePageToIndexFieldMapping -> Maybe Text
$sel:dateFieldFormat:ConfluencePageToIndexFieldMapping' :: ConfluencePageToIndexFieldMapping -> Maybe Text
$sel:dataSourceFieldName:ConfluencePageToIndexFieldMapping' :: ConfluencePageToIndexFieldMapping -> Maybe ConfluencePageFieldName
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ConfluencePageFieldName
dataSourceFieldName
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
dateFieldFormat
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
indexFieldName

instance
  Prelude.NFData
    ConfluencePageToIndexFieldMapping
  where
  rnf :: ConfluencePageToIndexFieldMapping -> ()
rnf ConfluencePageToIndexFieldMapping' {Maybe Text
Maybe ConfluencePageFieldName
indexFieldName :: Maybe Text
dateFieldFormat :: Maybe Text
dataSourceFieldName :: Maybe ConfluencePageFieldName
$sel:indexFieldName:ConfluencePageToIndexFieldMapping' :: ConfluencePageToIndexFieldMapping -> Maybe Text
$sel:dateFieldFormat:ConfluencePageToIndexFieldMapping' :: ConfluencePageToIndexFieldMapping -> Maybe Text
$sel:dataSourceFieldName:ConfluencePageToIndexFieldMapping' :: ConfluencePageToIndexFieldMapping -> Maybe ConfluencePageFieldName
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe ConfluencePageFieldName
dataSourceFieldName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
dateFieldFormat
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
indexFieldName

instance
  Data.ToJSON
    ConfluencePageToIndexFieldMapping
  where
  toJSON :: ConfluencePageToIndexFieldMapping -> Value
toJSON ConfluencePageToIndexFieldMapping' {Maybe Text
Maybe ConfluencePageFieldName
indexFieldName :: Maybe Text
dateFieldFormat :: Maybe Text
dataSourceFieldName :: Maybe ConfluencePageFieldName
$sel:indexFieldName:ConfluencePageToIndexFieldMapping' :: ConfluencePageToIndexFieldMapping -> Maybe Text
$sel:dateFieldFormat:ConfluencePageToIndexFieldMapping' :: ConfluencePageToIndexFieldMapping -> Maybe Text
$sel:dataSourceFieldName:ConfluencePageToIndexFieldMapping' :: ConfluencePageToIndexFieldMapping -> Maybe ConfluencePageFieldName
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"DataSourceFieldName" 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 ConfluencePageFieldName
dataSourceFieldName,
            (Key
"DateFieldFormat" 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 Text
dateFieldFormat,
            (Key
"IndexFieldName" 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 Text
indexFieldName
          ]
      )