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

-- | Configuration of blog settings for the Confluence data source. Blogs are
-- always indexed unless filtered from the index by the @ExclusionPatterns@
-- or @InclusionPatterns@ fields in the @ConfluenceConfiguration@ object.
--
-- /See:/ 'newConfluenceBlogConfiguration' smart constructor.
data ConfluenceBlogConfiguration = ConfluenceBlogConfiguration'
  { -- | Maps attributes or field names of Confluence blogs 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.
    --
    -- If you specify the @BlogFieldMappings@ parameter, you must specify at
    -- least one field mapping.
    ConfluenceBlogConfiguration
-> Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
blogFieldMappings :: Prelude.Maybe (Prelude.NonEmpty ConfluenceBlogToIndexFieldMapping)
  }
  deriving (ConfluenceBlogConfiguration -> ConfluenceBlogConfiguration -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ConfluenceBlogConfiguration -> ConfluenceBlogConfiguration -> Bool
$c/= :: ConfluenceBlogConfiguration -> ConfluenceBlogConfiguration -> Bool
== :: ConfluenceBlogConfiguration -> ConfluenceBlogConfiguration -> Bool
$c== :: ConfluenceBlogConfiguration -> ConfluenceBlogConfiguration -> Bool
Prelude.Eq, ReadPrec [ConfluenceBlogConfiguration]
ReadPrec ConfluenceBlogConfiguration
Int -> ReadS ConfluenceBlogConfiguration
ReadS [ConfluenceBlogConfiguration]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ConfluenceBlogConfiguration]
$creadListPrec :: ReadPrec [ConfluenceBlogConfiguration]
readPrec :: ReadPrec ConfluenceBlogConfiguration
$creadPrec :: ReadPrec ConfluenceBlogConfiguration
readList :: ReadS [ConfluenceBlogConfiguration]
$creadList :: ReadS [ConfluenceBlogConfiguration]
readsPrec :: Int -> ReadS ConfluenceBlogConfiguration
$creadsPrec :: Int -> ReadS ConfluenceBlogConfiguration
Prelude.Read, Int -> ConfluenceBlogConfiguration -> ShowS
[ConfluenceBlogConfiguration] -> ShowS
ConfluenceBlogConfiguration -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ConfluenceBlogConfiguration] -> ShowS
$cshowList :: [ConfluenceBlogConfiguration] -> ShowS
show :: ConfluenceBlogConfiguration -> String
$cshow :: ConfluenceBlogConfiguration -> String
showsPrec :: Int -> ConfluenceBlogConfiguration -> ShowS
$cshowsPrec :: Int -> ConfluenceBlogConfiguration -> ShowS
Prelude.Show, forall x.
Rep ConfluenceBlogConfiguration x -> ConfluenceBlogConfiguration
forall x.
ConfluenceBlogConfiguration -> Rep ConfluenceBlogConfiguration x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ConfluenceBlogConfiguration x -> ConfluenceBlogConfiguration
$cfrom :: forall x.
ConfluenceBlogConfiguration -> Rep ConfluenceBlogConfiguration x
Prelude.Generic)

-- |
-- Create a value of 'ConfluenceBlogConfiguration' 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:
--
-- 'blogFieldMappings', 'confluenceBlogConfiguration_blogFieldMappings' - Maps attributes or field names of Confluence blogs 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.
--
-- If you specify the @BlogFieldMappings@ parameter, you must specify at
-- least one field mapping.
newConfluenceBlogConfiguration ::
  ConfluenceBlogConfiguration
newConfluenceBlogConfiguration :: ConfluenceBlogConfiguration
newConfluenceBlogConfiguration =
  ConfluenceBlogConfiguration'
    { $sel:blogFieldMappings:ConfluenceBlogConfiguration' :: Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
blogFieldMappings =
        forall a. Maybe a
Prelude.Nothing
    }

-- | Maps attributes or field names of Confluence blogs 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.
--
-- If you specify the @BlogFieldMappings@ parameter, you must specify at
-- least one field mapping.
confluenceBlogConfiguration_blogFieldMappings :: Lens.Lens' ConfluenceBlogConfiguration (Prelude.Maybe (Prelude.NonEmpty ConfluenceBlogToIndexFieldMapping))
confluenceBlogConfiguration_blogFieldMappings :: Lens'
  ConfluenceBlogConfiguration
  (Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping))
confluenceBlogConfiguration_blogFieldMappings = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ConfluenceBlogConfiguration' {Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
blogFieldMappings :: Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
$sel:blogFieldMappings:ConfluenceBlogConfiguration' :: ConfluenceBlogConfiguration
-> Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
blogFieldMappings} -> Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
blogFieldMappings) (\s :: ConfluenceBlogConfiguration
s@ConfluenceBlogConfiguration' {} Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
a -> ConfluenceBlogConfiguration
s {$sel:blogFieldMappings:ConfluenceBlogConfiguration' :: Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
blogFieldMappings = Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
a} :: ConfluenceBlogConfiguration) 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 s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Data.FromJSON ConfluenceBlogConfiguration where
  parseJSON :: Value -> Parser ConfluenceBlogConfiguration
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ConfluenceBlogConfiguration"
      ( \Object
x ->
          Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
-> ConfluenceBlogConfiguration
ConfluenceBlogConfiguration'
            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
"BlogFieldMappings")
      )

instance Prelude.Hashable ConfluenceBlogConfiguration where
  hashWithSalt :: Int -> ConfluenceBlogConfiguration -> Int
hashWithSalt Int
_salt ConfluenceBlogConfiguration' {Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
blogFieldMappings :: Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
$sel:blogFieldMappings:ConfluenceBlogConfiguration' :: ConfluenceBlogConfiguration
-> Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
..} =
    Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
blogFieldMappings

instance Prelude.NFData ConfluenceBlogConfiguration where
  rnf :: ConfluenceBlogConfiguration -> ()
rnf ConfluenceBlogConfiguration' {Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
blogFieldMappings :: Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
$sel:blogFieldMappings:ConfluenceBlogConfiguration' :: ConfluenceBlogConfiguration
-> Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
blogFieldMappings

instance Data.ToJSON ConfluenceBlogConfiguration where
  toJSON :: ConfluenceBlogConfiguration -> Value
toJSON ConfluenceBlogConfiguration' {Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
blogFieldMappings :: Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
$sel:blogFieldMappings:ConfluenceBlogConfiguration' :: ConfluenceBlogConfiguration
-> Maybe (NonEmpty ConfluenceBlogToIndexFieldMapping)
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"BlogFieldMappings" 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 (NonEmpty ConfluenceBlogToIndexFieldMapping)
blogFieldMappings
          ]
      )