{-# 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.Evidently.Types.EvaluationRequest
-- 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.Evidently.Types.EvaluationRequest where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude

-- | This structure assigns a feature variation to one user session.
--
-- /See:/ 'newEvaluationRequest' smart constructor.
data EvaluationRequest = EvaluationRequest'
  { -- | A JSON block of attributes that you can optionally pass in. This JSON
    -- block is included in the evaluation events sent to Evidently from the
    -- user session.
    EvaluationRequest -> Maybe Text
evaluationContext :: Prelude.Maybe Prelude.Text,
    -- | An internal ID that represents a unique user session of the application.
    -- This @entityID@ is checked against any override rules assigned for this
    -- feature.
    EvaluationRequest -> Text
entityId :: Prelude.Text,
    -- | The name of the feature being evaluated.
    EvaluationRequest -> Text
feature :: Prelude.Text
  }
  deriving (EvaluationRequest -> EvaluationRequest -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: EvaluationRequest -> EvaluationRequest -> Bool
$c/= :: EvaluationRequest -> EvaluationRequest -> Bool
== :: EvaluationRequest -> EvaluationRequest -> Bool
$c== :: EvaluationRequest -> EvaluationRequest -> Bool
Prelude.Eq, ReadPrec [EvaluationRequest]
ReadPrec EvaluationRequest
Int -> ReadS EvaluationRequest
ReadS [EvaluationRequest]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [EvaluationRequest]
$creadListPrec :: ReadPrec [EvaluationRequest]
readPrec :: ReadPrec EvaluationRequest
$creadPrec :: ReadPrec EvaluationRequest
readList :: ReadS [EvaluationRequest]
$creadList :: ReadS [EvaluationRequest]
readsPrec :: Int -> ReadS EvaluationRequest
$creadsPrec :: Int -> ReadS EvaluationRequest
Prelude.Read, Int -> EvaluationRequest -> ShowS
[EvaluationRequest] -> ShowS
EvaluationRequest -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [EvaluationRequest] -> ShowS
$cshowList :: [EvaluationRequest] -> ShowS
show :: EvaluationRequest -> String
$cshow :: EvaluationRequest -> String
showsPrec :: Int -> EvaluationRequest -> ShowS
$cshowsPrec :: Int -> EvaluationRequest -> ShowS
Prelude.Show, forall x. Rep EvaluationRequest x -> EvaluationRequest
forall x. EvaluationRequest -> Rep EvaluationRequest x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep EvaluationRequest x -> EvaluationRequest
$cfrom :: forall x. EvaluationRequest -> Rep EvaluationRequest x
Prelude.Generic)

-- |
-- Create a value of 'EvaluationRequest' 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:
--
-- 'evaluationContext', 'evaluationRequest_evaluationContext' - A JSON block of attributes that you can optionally pass in. This JSON
-- block is included in the evaluation events sent to Evidently from the
-- user session.
--
-- 'entityId', 'evaluationRequest_entityId' - An internal ID that represents a unique user session of the application.
-- This @entityID@ is checked against any override rules assigned for this
-- feature.
--
-- 'feature', 'evaluationRequest_feature' - The name of the feature being evaluated.
newEvaluationRequest ::
  -- | 'entityId'
  Prelude.Text ->
  -- | 'feature'
  Prelude.Text ->
  EvaluationRequest
newEvaluationRequest :: Text -> Text -> EvaluationRequest
newEvaluationRequest Text
pEntityId_ Text
pFeature_ =
  EvaluationRequest'
    { $sel:evaluationContext:EvaluationRequest' :: Maybe Text
evaluationContext =
        forall a. Maybe a
Prelude.Nothing,
      $sel:entityId:EvaluationRequest' :: Text
entityId = Text
pEntityId_,
      $sel:feature:EvaluationRequest' :: Text
feature = Text
pFeature_
    }

-- | A JSON block of attributes that you can optionally pass in. This JSON
-- block is included in the evaluation events sent to Evidently from the
-- user session.
evaluationRequest_evaluationContext :: Lens.Lens' EvaluationRequest (Prelude.Maybe Prelude.Text)
evaluationRequest_evaluationContext :: Lens' EvaluationRequest (Maybe Text)
evaluationRequest_evaluationContext = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EvaluationRequest' {Maybe Text
evaluationContext :: Maybe Text
$sel:evaluationContext:EvaluationRequest' :: EvaluationRequest -> Maybe Text
evaluationContext} -> Maybe Text
evaluationContext) (\s :: EvaluationRequest
s@EvaluationRequest' {} Maybe Text
a -> EvaluationRequest
s {$sel:evaluationContext:EvaluationRequest' :: Maybe Text
evaluationContext = Maybe Text
a} :: EvaluationRequest)

-- | An internal ID that represents a unique user session of the application.
-- This @entityID@ is checked against any override rules assigned for this
-- feature.
evaluationRequest_entityId :: Lens.Lens' EvaluationRequest Prelude.Text
evaluationRequest_entityId :: Lens' EvaluationRequest Text
evaluationRequest_entityId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EvaluationRequest' {Text
entityId :: Text
$sel:entityId:EvaluationRequest' :: EvaluationRequest -> Text
entityId} -> Text
entityId) (\s :: EvaluationRequest
s@EvaluationRequest' {} Text
a -> EvaluationRequest
s {$sel:entityId:EvaluationRequest' :: Text
entityId = Text
a} :: EvaluationRequest)

-- | The name of the feature being evaluated.
evaluationRequest_feature :: Lens.Lens' EvaluationRequest Prelude.Text
evaluationRequest_feature :: Lens' EvaluationRequest Text
evaluationRequest_feature = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EvaluationRequest' {Text
feature :: Text
$sel:feature:EvaluationRequest' :: EvaluationRequest -> Text
feature} -> Text
feature) (\s :: EvaluationRequest
s@EvaluationRequest' {} Text
a -> EvaluationRequest
s {$sel:feature:EvaluationRequest' :: Text
feature = Text
a} :: EvaluationRequest)

instance Prelude.Hashable EvaluationRequest where
  hashWithSalt :: Int -> EvaluationRequest -> Int
hashWithSalt Int
_salt EvaluationRequest' {Maybe Text
Text
feature :: Text
entityId :: Text
evaluationContext :: Maybe Text
$sel:feature:EvaluationRequest' :: EvaluationRequest -> Text
$sel:entityId:EvaluationRequest' :: EvaluationRequest -> Text
$sel:evaluationContext:EvaluationRequest' :: EvaluationRequest -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
evaluationContext
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
entityId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
feature

instance Prelude.NFData EvaluationRequest where
  rnf :: EvaluationRequest -> ()
rnf EvaluationRequest' {Maybe Text
Text
feature :: Text
entityId :: Text
evaluationContext :: Maybe Text
$sel:feature:EvaluationRequest' :: EvaluationRequest -> Text
$sel:entityId:EvaluationRequest' :: EvaluationRequest -> Text
$sel:evaluationContext:EvaluationRequest' :: EvaluationRequest -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
evaluationContext
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
entityId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
feature

instance Data.ToJSON EvaluationRequest where
  toJSON :: EvaluationRequest -> Value
toJSON EvaluationRequest' {Maybe Text
Text
feature :: Text
entityId :: Text
evaluationContext :: Maybe Text
$sel:feature:EvaluationRequest' :: EvaluationRequest -> Text
$sel:entityId:EvaluationRequest' :: EvaluationRequest -> Text
$sel:evaluationContext:EvaluationRequest' :: EvaluationRequest -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"evaluationContext" 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
evaluationContext,
            forall a. a -> Maybe a
Prelude.Just (Key
"entityId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
entityId),
            forall a. a -> Maybe a
Prelude.Just (Key
"feature" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
feature)
          ]
      )