{-# 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.SalesforceKnowledgeArticleConfiguration
-- 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.SalesforceKnowledgeArticleConfiguration 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.SalesforceCustomKnowledgeArticleTypeConfiguration
import Amazonka.Kendra.Types.SalesforceKnowledgeArticleState
import Amazonka.Kendra.Types.SalesforceStandardKnowledgeArticleTypeConfiguration
import qualified Amazonka.Prelude as Prelude

-- | Provides the configuration information for the knowledge article types
-- that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
-- articles and the standard fields of knowledge articles, or the custom
-- fields of custom knowledge articles, but not both
--
-- /See:/ 'newSalesforceKnowledgeArticleConfiguration' smart constructor.
data SalesforceKnowledgeArticleConfiguration = SalesforceKnowledgeArticleConfiguration'
  { -- | Configuration information for custom Salesforce knowledge articles.
    SalesforceKnowledgeArticleConfiguration
-> Maybe
     (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
customKnowledgeArticleTypeConfigurations :: Prelude.Maybe (Prelude.NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration),
    -- | Configuration information for standard Salesforce knowledge articles.
    SalesforceKnowledgeArticleConfiguration
-> Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
standardKnowledgeArticleTypeConfiguration :: Prelude.Maybe SalesforceStandardKnowledgeArticleTypeConfiguration,
    -- | Specifies the document states that should be included when Amazon Kendra
    -- indexes knowledge articles. You must specify at least one state.
    SalesforceKnowledgeArticleConfiguration
-> NonEmpty SalesforceKnowledgeArticleState
includedStates :: Prelude.NonEmpty SalesforceKnowledgeArticleState
  }
  deriving (SalesforceKnowledgeArticleConfiguration
-> SalesforceKnowledgeArticleConfiguration -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: SalesforceKnowledgeArticleConfiguration
-> SalesforceKnowledgeArticleConfiguration -> Bool
$c/= :: SalesforceKnowledgeArticleConfiguration
-> SalesforceKnowledgeArticleConfiguration -> Bool
== :: SalesforceKnowledgeArticleConfiguration
-> SalesforceKnowledgeArticleConfiguration -> Bool
$c== :: SalesforceKnowledgeArticleConfiguration
-> SalesforceKnowledgeArticleConfiguration -> Bool
Prelude.Eq, ReadPrec [SalesforceKnowledgeArticleConfiguration]
ReadPrec SalesforceKnowledgeArticleConfiguration
Int -> ReadS SalesforceKnowledgeArticleConfiguration
ReadS [SalesforceKnowledgeArticleConfiguration]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [SalesforceKnowledgeArticleConfiguration]
$creadListPrec :: ReadPrec [SalesforceKnowledgeArticleConfiguration]
readPrec :: ReadPrec SalesforceKnowledgeArticleConfiguration
$creadPrec :: ReadPrec SalesforceKnowledgeArticleConfiguration
readList :: ReadS [SalesforceKnowledgeArticleConfiguration]
$creadList :: ReadS [SalesforceKnowledgeArticleConfiguration]
readsPrec :: Int -> ReadS SalesforceKnowledgeArticleConfiguration
$creadsPrec :: Int -> ReadS SalesforceKnowledgeArticleConfiguration
Prelude.Read, Int -> SalesforceKnowledgeArticleConfiguration -> ShowS
[SalesforceKnowledgeArticleConfiguration] -> ShowS
SalesforceKnowledgeArticleConfiguration -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [SalesforceKnowledgeArticleConfiguration] -> ShowS
$cshowList :: [SalesforceKnowledgeArticleConfiguration] -> ShowS
show :: SalesforceKnowledgeArticleConfiguration -> String
$cshow :: SalesforceKnowledgeArticleConfiguration -> String
showsPrec :: Int -> SalesforceKnowledgeArticleConfiguration -> ShowS
$cshowsPrec :: Int -> SalesforceKnowledgeArticleConfiguration -> ShowS
Prelude.Show, forall x.
Rep SalesforceKnowledgeArticleConfiguration x
-> SalesforceKnowledgeArticleConfiguration
forall x.
SalesforceKnowledgeArticleConfiguration
-> Rep SalesforceKnowledgeArticleConfiguration x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep SalesforceKnowledgeArticleConfiguration x
-> SalesforceKnowledgeArticleConfiguration
$cfrom :: forall x.
SalesforceKnowledgeArticleConfiguration
-> Rep SalesforceKnowledgeArticleConfiguration x
Prelude.Generic)

-- |
-- Create a value of 'SalesforceKnowledgeArticleConfiguration' 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:
--
-- 'customKnowledgeArticleTypeConfigurations', 'salesforceKnowledgeArticleConfiguration_customKnowledgeArticleTypeConfigurations' - Configuration information for custom Salesforce knowledge articles.
--
-- 'standardKnowledgeArticleTypeConfiguration', 'salesforceKnowledgeArticleConfiguration_standardKnowledgeArticleTypeConfiguration' - Configuration information for standard Salesforce knowledge articles.
--
-- 'includedStates', 'salesforceKnowledgeArticleConfiguration_includedStates' - Specifies the document states that should be included when Amazon Kendra
-- indexes knowledge articles. You must specify at least one state.
newSalesforceKnowledgeArticleConfiguration ::
  -- | 'includedStates'
  Prelude.NonEmpty SalesforceKnowledgeArticleState ->
  SalesforceKnowledgeArticleConfiguration
newSalesforceKnowledgeArticleConfiguration :: NonEmpty SalesforceKnowledgeArticleState
-> SalesforceKnowledgeArticleConfiguration
newSalesforceKnowledgeArticleConfiguration
  NonEmpty SalesforceKnowledgeArticleState
pIncludedStates_ =
    SalesforceKnowledgeArticleConfiguration'
      { $sel:customKnowledgeArticleTypeConfigurations:SalesforceKnowledgeArticleConfiguration' :: Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
customKnowledgeArticleTypeConfigurations =
          forall a. Maybe a
Prelude.Nothing,
        $sel:standardKnowledgeArticleTypeConfiguration:SalesforceKnowledgeArticleConfiguration' :: Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
standardKnowledgeArticleTypeConfiguration =
          forall a. Maybe a
Prelude.Nothing,
        $sel:includedStates:SalesforceKnowledgeArticleConfiguration' :: NonEmpty SalesforceKnowledgeArticleState
includedStates =
          forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced
            forall t b. AReview t b -> b -> t
Lens.# NonEmpty SalesforceKnowledgeArticleState
pIncludedStates_
      }

-- | Configuration information for custom Salesforce knowledge articles.
salesforceKnowledgeArticleConfiguration_customKnowledgeArticleTypeConfigurations :: Lens.Lens' SalesforceKnowledgeArticleConfiguration (Prelude.Maybe (Prelude.NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration))
salesforceKnowledgeArticleConfiguration_customKnowledgeArticleTypeConfigurations :: Lens'
  SalesforceKnowledgeArticleConfiguration
  (Maybe
     (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration))
salesforceKnowledgeArticleConfiguration_customKnowledgeArticleTypeConfigurations = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SalesforceKnowledgeArticleConfiguration' {Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
customKnowledgeArticleTypeConfigurations :: Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
$sel:customKnowledgeArticleTypeConfigurations:SalesforceKnowledgeArticleConfiguration' :: SalesforceKnowledgeArticleConfiguration
-> Maybe
     (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
customKnowledgeArticleTypeConfigurations} -> Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
customKnowledgeArticleTypeConfigurations) (\s :: SalesforceKnowledgeArticleConfiguration
s@SalesforceKnowledgeArticleConfiguration' {} Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
a -> SalesforceKnowledgeArticleConfiguration
s {$sel:customKnowledgeArticleTypeConfigurations:SalesforceKnowledgeArticleConfiguration' :: Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
customKnowledgeArticleTypeConfigurations = Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
a} :: SalesforceKnowledgeArticleConfiguration) 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

-- | Configuration information for standard Salesforce knowledge articles.
salesforceKnowledgeArticleConfiguration_standardKnowledgeArticleTypeConfiguration :: Lens.Lens' SalesforceKnowledgeArticleConfiguration (Prelude.Maybe SalesforceStandardKnowledgeArticleTypeConfiguration)
salesforceKnowledgeArticleConfiguration_standardKnowledgeArticleTypeConfiguration :: Lens'
  SalesforceKnowledgeArticleConfiguration
  (Maybe SalesforceStandardKnowledgeArticleTypeConfiguration)
salesforceKnowledgeArticleConfiguration_standardKnowledgeArticleTypeConfiguration = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SalesforceKnowledgeArticleConfiguration' {Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
standardKnowledgeArticleTypeConfiguration :: Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
$sel:standardKnowledgeArticleTypeConfiguration:SalesforceKnowledgeArticleConfiguration' :: SalesforceKnowledgeArticleConfiguration
-> Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
standardKnowledgeArticleTypeConfiguration} -> Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
standardKnowledgeArticleTypeConfiguration) (\s :: SalesforceKnowledgeArticleConfiguration
s@SalesforceKnowledgeArticleConfiguration' {} Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
a -> SalesforceKnowledgeArticleConfiguration
s {$sel:standardKnowledgeArticleTypeConfiguration:SalesforceKnowledgeArticleConfiguration' :: Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
standardKnowledgeArticleTypeConfiguration = Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
a} :: SalesforceKnowledgeArticleConfiguration)

-- | Specifies the document states that should be included when Amazon Kendra
-- indexes knowledge articles. You must specify at least one state.
salesforceKnowledgeArticleConfiguration_includedStates :: Lens.Lens' SalesforceKnowledgeArticleConfiguration (Prelude.NonEmpty SalesforceKnowledgeArticleState)
salesforceKnowledgeArticleConfiguration_includedStates :: Lens'
  SalesforceKnowledgeArticleConfiguration
  (NonEmpty SalesforceKnowledgeArticleState)
salesforceKnowledgeArticleConfiguration_includedStates = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SalesforceKnowledgeArticleConfiguration' {NonEmpty SalesforceKnowledgeArticleState
includedStates :: NonEmpty SalesforceKnowledgeArticleState
$sel:includedStates:SalesforceKnowledgeArticleConfiguration' :: SalesforceKnowledgeArticleConfiguration
-> NonEmpty SalesforceKnowledgeArticleState
includedStates} -> NonEmpty SalesforceKnowledgeArticleState
includedStates) (\s :: SalesforceKnowledgeArticleConfiguration
s@SalesforceKnowledgeArticleConfiguration' {} NonEmpty SalesforceKnowledgeArticleState
a -> SalesforceKnowledgeArticleConfiguration
s {$sel:includedStates:SalesforceKnowledgeArticleConfiguration' :: NonEmpty SalesforceKnowledgeArticleState
includedStates = NonEmpty SalesforceKnowledgeArticleState
a} :: SalesforceKnowledgeArticleConfiguration) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance
  Data.FromJSON
    SalesforceKnowledgeArticleConfiguration
  where
  parseJSON :: Value -> Parser SalesforceKnowledgeArticleConfiguration
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"SalesforceKnowledgeArticleConfiguration"
      ( \Object
x ->
          Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
-> Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
-> NonEmpty SalesforceKnowledgeArticleState
-> SalesforceKnowledgeArticleConfiguration
SalesforceKnowledgeArticleConfiguration'
            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
"CustomKnowledgeArticleTypeConfigurations"
                        )
            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
"StandardKnowledgeArticleTypeConfiguration"
                        )
            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
"IncludedStates")
      )

instance
  Prelude.Hashable
    SalesforceKnowledgeArticleConfiguration
  where
  hashWithSalt :: Int -> SalesforceKnowledgeArticleConfiguration -> Int
hashWithSalt
    Int
_salt
    SalesforceKnowledgeArticleConfiguration' {Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
NonEmpty SalesforceKnowledgeArticleState
includedStates :: NonEmpty SalesforceKnowledgeArticleState
standardKnowledgeArticleTypeConfiguration :: Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
customKnowledgeArticleTypeConfigurations :: Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
$sel:includedStates:SalesforceKnowledgeArticleConfiguration' :: SalesforceKnowledgeArticleConfiguration
-> NonEmpty SalesforceKnowledgeArticleState
$sel:standardKnowledgeArticleTypeConfiguration:SalesforceKnowledgeArticleConfiguration' :: SalesforceKnowledgeArticleConfiguration
-> Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
$sel:customKnowledgeArticleTypeConfigurations:SalesforceKnowledgeArticleConfiguration' :: SalesforceKnowledgeArticleConfiguration
-> Maybe
     (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
customKnowledgeArticleTypeConfigurations
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
standardKnowledgeArticleTypeConfiguration
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` NonEmpty SalesforceKnowledgeArticleState
includedStates

instance
  Prelude.NFData
    SalesforceKnowledgeArticleConfiguration
  where
  rnf :: SalesforceKnowledgeArticleConfiguration -> ()
rnf SalesforceKnowledgeArticleConfiguration' {Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
NonEmpty SalesforceKnowledgeArticleState
includedStates :: NonEmpty SalesforceKnowledgeArticleState
standardKnowledgeArticleTypeConfiguration :: Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
customKnowledgeArticleTypeConfigurations :: Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
$sel:includedStates:SalesforceKnowledgeArticleConfiguration' :: SalesforceKnowledgeArticleConfiguration
-> NonEmpty SalesforceKnowledgeArticleState
$sel:standardKnowledgeArticleTypeConfiguration:SalesforceKnowledgeArticleConfiguration' :: SalesforceKnowledgeArticleConfiguration
-> Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
$sel:customKnowledgeArticleTypeConfigurations:SalesforceKnowledgeArticleConfiguration' :: SalesforceKnowledgeArticleConfiguration
-> Maybe
     (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
..} =
    forall a. NFData a => a -> ()
Prelude.rnf
      Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
customKnowledgeArticleTypeConfigurations
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
standardKnowledgeArticleTypeConfiguration
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf NonEmpty SalesforceKnowledgeArticleState
includedStates

instance
  Data.ToJSON
    SalesforceKnowledgeArticleConfiguration
  where
  toJSON :: SalesforceKnowledgeArticleConfiguration -> Value
toJSON SalesforceKnowledgeArticleConfiguration' {Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
NonEmpty SalesforceKnowledgeArticleState
includedStates :: NonEmpty SalesforceKnowledgeArticleState
standardKnowledgeArticleTypeConfiguration :: Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
customKnowledgeArticleTypeConfigurations :: Maybe (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
$sel:includedStates:SalesforceKnowledgeArticleConfiguration' :: SalesforceKnowledgeArticleConfiguration
-> NonEmpty SalesforceKnowledgeArticleState
$sel:standardKnowledgeArticleTypeConfiguration:SalesforceKnowledgeArticleConfiguration' :: SalesforceKnowledgeArticleConfiguration
-> Maybe SalesforceStandardKnowledgeArticleTypeConfiguration
$sel:customKnowledgeArticleTypeConfigurations:SalesforceKnowledgeArticleConfiguration' :: SalesforceKnowledgeArticleConfiguration
-> Maybe
     (NonEmpty SalesforceCustomKnowledgeArticleTypeConfiguration)
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"CustomKnowledgeArticleTypeConfigurations" 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 SalesforceCustomKnowledgeArticleTypeConfiguration)
customKnowledgeArticleTypeConfigurations,
            (Key
"StandardKnowledgeArticleTypeConfiguration" 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 SalesforceStandardKnowledgeArticleTypeConfiguration
standardKnowledgeArticleTypeConfiguration,
            forall a. a -> Maybe a
Prelude.Just
              (Key
"IncludedStates" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= NonEmpty SalesforceKnowledgeArticleState
includedStates)
          ]
      )