{-# 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.AdditionalResultAttribute
-- 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.AdditionalResultAttribute 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.AdditionalResultAttributeValue
import Amazonka.Kendra.Types.AdditionalResultAttributeValueType
import qualified Amazonka.Prelude as Prelude

-- | An attribute returned from an index query.
--
-- /See:/ 'newAdditionalResultAttribute' smart constructor.
data AdditionalResultAttribute = AdditionalResultAttribute'
  { -- | The key that identifies the attribute.
    AdditionalResultAttribute -> Text
key :: Prelude.Text,
    -- | The data type of the @Value@ property.
    AdditionalResultAttribute -> AdditionalResultAttributeValueType
valueType :: AdditionalResultAttributeValueType,
    -- | An object that contains the attribute value.
    AdditionalResultAttribute -> AdditionalResultAttributeValue
value :: AdditionalResultAttributeValue
  }
  deriving (AdditionalResultAttribute -> AdditionalResultAttribute -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: AdditionalResultAttribute -> AdditionalResultAttribute -> Bool
$c/= :: AdditionalResultAttribute -> AdditionalResultAttribute -> Bool
== :: AdditionalResultAttribute -> AdditionalResultAttribute -> Bool
$c== :: AdditionalResultAttribute -> AdditionalResultAttribute -> Bool
Prelude.Eq, ReadPrec [AdditionalResultAttribute]
ReadPrec AdditionalResultAttribute
Int -> ReadS AdditionalResultAttribute
ReadS [AdditionalResultAttribute]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [AdditionalResultAttribute]
$creadListPrec :: ReadPrec [AdditionalResultAttribute]
readPrec :: ReadPrec AdditionalResultAttribute
$creadPrec :: ReadPrec AdditionalResultAttribute
readList :: ReadS [AdditionalResultAttribute]
$creadList :: ReadS [AdditionalResultAttribute]
readsPrec :: Int -> ReadS AdditionalResultAttribute
$creadsPrec :: Int -> ReadS AdditionalResultAttribute
Prelude.Read, Int -> AdditionalResultAttribute -> ShowS
[AdditionalResultAttribute] -> ShowS
AdditionalResultAttribute -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [AdditionalResultAttribute] -> ShowS
$cshowList :: [AdditionalResultAttribute] -> ShowS
show :: AdditionalResultAttribute -> String
$cshow :: AdditionalResultAttribute -> String
showsPrec :: Int -> AdditionalResultAttribute -> ShowS
$cshowsPrec :: Int -> AdditionalResultAttribute -> ShowS
Prelude.Show, forall x.
Rep AdditionalResultAttribute x -> AdditionalResultAttribute
forall x.
AdditionalResultAttribute -> Rep AdditionalResultAttribute x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep AdditionalResultAttribute x -> AdditionalResultAttribute
$cfrom :: forall x.
AdditionalResultAttribute -> Rep AdditionalResultAttribute x
Prelude.Generic)

-- |
-- Create a value of 'AdditionalResultAttribute' 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:
--
-- 'key', 'additionalResultAttribute_key' - The key that identifies the attribute.
--
-- 'valueType', 'additionalResultAttribute_valueType' - The data type of the @Value@ property.
--
-- 'value', 'additionalResultAttribute_value' - An object that contains the attribute value.
newAdditionalResultAttribute ::
  -- | 'key'
  Prelude.Text ->
  -- | 'valueType'
  AdditionalResultAttributeValueType ->
  -- | 'value'
  AdditionalResultAttributeValue ->
  AdditionalResultAttribute
newAdditionalResultAttribute :: Text
-> AdditionalResultAttributeValueType
-> AdditionalResultAttributeValue
-> AdditionalResultAttribute
newAdditionalResultAttribute
  Text
pKey_
  AdditionalResultAttributeValueType
pValueType_
  AdditionalResultAttributeValue
pValue_ =
    AdditionalResultAttribute'
      { $sel:key:AdditionalResultAttribute' :: Text
key = Text
pKey_,
        $sel:valueType:AdditionalResultAttribute' :: AdditionalResultAttributeValueType
valueType = AdditionalResultAttributeValueType
pValueType_,
        $sel:value:AdditionalResultAttribute' :: AdditionalResultAttributeValue
value = AdditionalResultAttributeValue
pValue_
      }

-- | The key that identifies the attribute.
additionalResultAttribute_key :: Lens.Lens' AdditionalResultAttribute Prelude.Text
additionalResultAttribute_key :: Lens' AdditionalResultAttribute Text
additionalResultAttribute_key = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AdditionalResultAttribute' {Text
key :: Text
$sel:key:AdditionalResultAttribute' :: AdditionalResultAttribute -> Text
key} -> Text
key) (\s :: AdditionalResultAttribute
s@AdditionalResultAttribute' {} Text
a -> AdditionalResultAttribute
s {$sel:key:AdditionalResultAttribute' :: Text
key = Text
a} :: AdditionalResultAttribute)

-- | The data type of the @Value@ property.
additionalResultAttribute_valueType :: Lens.Lens' AdditionalResultAttribute AdditionalResultAttributeValueType
additionalResultAttribute_valueType :: Lens' AdditionalResultAttribute AdditionalResultAttributeValueType
additionalResultAttribute_valueType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AdditionalResultAttribute' {AdditionalResultAttributeValueType
valueType :: AdditionalResultAttributeValueType
$sel:valueType:AdditionalResultAttribute' :: AdditionalResultAttribute -> AdditionalResultAttributeValueType
valueType} -> AdditionalResultAttributeValueType
valueType) (\s :: AdditionalResultAttribute
s@AdditionalResultAttribute' {} AdditionalResultAttributeValueType
a -> AdditionalResultAttribute
s {$sel:valueType:AdditionalResultAttribute' :: AdditionalResultAttributeValueType
valueType = AdditionalResultAttributeValueType
a} :: AdditionalResultAttribute)

-- | An object that contains the attribute value.
additionalResultAttribute_value :: Lens.Lens' AdditionalResultAttribute AdditionalResultAttributeValue
additionalResultAttribute_value :: Lens' AdditionalResultAttribute AdditionalResultAttributeValue
additionalResultAttribute_value = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AdditionalResultAttribute' {AdditionalResultAttributeValue
value :: AdditionalResultAttributeValue
$sel:value:AdditionalResultAttribute' :: AdditionalResultAttribute -> AdditionalResultAttributeValue
value} -> AdditionalResultAttributeValue
value) (\s :: AdditionalResultAttribute
s@AdditionalResultAttribute' {} AdditionalResultAttributeValue
a -> AdditionalResultAttribute
s {$sel:value:AdditionalResultAttribute' :: AdditionalResultAttributeValue
value = AdditionalResultAttributeValue
a} :: AdditionalResultAttribute)

instance Data.FromJSON AdditionalResultAttribute where
  parseJSON :: Value -> Parser AdditionalResultAttribute
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"AdditionalResultAttribute"
      ( \Object
x ->
          Text
-> AdditionalResultAttributeValueType
-> AdditionalResultAttributeValue
-> AdditionalResultAttribute
AdditionalResultAttribute'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"Key")
            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
"ValueType")
            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
"Value")
      )

instance Prelude.Hashable AdditionalResultAttribute where
  hashWithSalt :: Int -> AdditionalResultAttribute -> Int
hashWithSalt Int
_salt AdditionalResultAttribute' {Text
AdditionalResultAttributeValueType
AdditionalResultAttributeValue
value :: AdditionalResultAttributeValue
valueType :: AdditionalResultAttributeValueType
key :: Text
$sel:value:AdditionalResultAttribute' :: AdditionalResultAttribute -> AdditionalResultAttributeValue
$sel:valueType:AdditionalResultAttribute' :: AdditionalResultAttribute -> AdditionalResultAttributeValueType
$sel:key:AdditionalResultAttribute' :: AdditionalResultAttribute -> Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
key
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` AdditionalResultAttributeValueType
valueType
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` AdditionalResultAttributeValue
value

instance Prelude.NFData AdditionalResultAttribute where
  rnf :: AdditionalResultAttribute -> ()
rnf AdditionalResultAttribute' {Text
AdditionalResultAttributeValueType
AdditionalResultAttributeValue
value :: AdditionalResultAttributeValue
valueType :: AdditionalResultAttributeValueType
key :: Text
$sel:value:AdditionalResultAttribute' :: AdditionalResultAttribute -> AdditionalResultAttributeValue
$sel:valueType:AdditionalResultAttribute' :: AdditionalResultAttribute -> AdditionalResultAttributeValueType
$sel:key:AdditionalResultAttribute' :: AdditionalResultAttribute -> Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Text
key
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf AdditionalResultAttributeValueType
valueType
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf AdditionalResultAttributeValue
value