{-# 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.SegmentOverride
-- 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.SegmentOverride 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 specifies a segment that you have already created, and
-- defines the traffic split for that segment to be used in a launch.
--
-- /See:/ 'newSegmentOverride' smart constructor.
data SegmentOverride = SegmentOverride'
  { -- | A number indicating the order to use to evaluate segment overrides, if
    -- there are more than one. Segment overrides with lower numbers are
    -- evaluated first.
    SegmentOverride -> Integer
evaluationOrder :: Prelude.Integer,
    -- | The ARN of the segment to use.
    SegmentOverride -> Text
segment :: Prelude.Text,
    -- | The traffic allocation percentages among the feature variations to
    -- assign to this segment. This is a set of key-value pairs. The keys are
    -- variation names. The values represent the amount of traffic to allocate
    -- to that variation for this segment. This is expressed in thousandths of
    -- a percent, so a weight of 50000 represents 50% of traffic.
    SegmentOverride -> HashMap Text Natural
weights :: Prelude.HashMap Prelude.Text Prelude.Natural
  }
  deriving (SegmentOverride -> SegmentOverride -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: SegmentOverride -> SegmentOverride -> Bool
$c/= :: SegmentOverride -> SegmentOverride -> Bool
== :: SegmentOverride -> SegmentOverride -> Bool
$c== :: SegmentOverride -> SegmentOverride -> Bool
Prelude.Eq, ReadPrec [SegmentOverride]
ReadPrec SegmentOverride
Int -> ReadS SegmentOverride
ReadS [SegmentOverride]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [SegmentOverride]
$creadListPrec :: ReadPrec [SegmentOverride]
readPrec :: ReadPrec SegmentOverride
$creadPrec :: ReadPrec SegmentOverride
readList :: ReadS [SegmentOverride]
$creadList :: ReadS [SegmentOverride]
readsPrec :: Int -> ReadS SegmentOverride
$creadsPrec :: Int -> ReadS SegmentOverride
Prelude.Read, Int -> SegmentOverride -> ShowS
[SegmentOverride] -> ShowS
SegmentOverride -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [SegmentOverride] -> ShowS
$cshowList :: [SegmentOverride] -> ShowS
show :: SegmentOverride -> String
$cshow :: SegmentOverride -> String
showsPrec :: Int -> SegmentOverride -> ShowS
$cshowsPrec :: Int -> SegmentOverride -> ShowS
Prelude.Show, forall x. Rep SegmentOverride x -> SegmentOverride
forall x. SegmentOverride -> Rep SegmentOverride x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep SegmentOverride x -> SegmentOverride
$cfrom :: forall x. SegmentOverride -> Rep SegmentOverride x
Prelude.Generic)

-- |
-- Create a value of 'SegmentOverride' 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:
--
-- 'evaluationOrder', 'segmentOverride_evaluationOrder' - A number indicating the order to use to evaluate segment overrides, if
-- there are more than one. Segment overrides with lower numbers are
-- evaluated first.
--
-- 'segment', 'segmentOverride_segment' - The ARN of the segment to use.
--
-- 'weights', 'segmentOverride_weights' - The traffic allocation percentages among the feature variations to
-- assign to this segment. This is a set of key-value pairs. The keys are
-- variation names. The values represent the amount of traffic to allocate
-- to that variation for this segment. This is expressed in thousandths of
-- a percent, so a weight of 50000 represents 50% of traffic.
newSegmentOverride ::
  -- | 'evaluationOrder'
  Prelude.Integer ->
  -- | 'segment'
  Prelude.Text ->
  SegmentOverride
newSegmentOverride :: Integer -> Text -> SegmentOverride
newSegmentOverride Integer
pEvaluationOrder_ Text
pSegment_ =
  SegmentOverride'
    { $sel:evaluationOrder:SegmentOverride' :: Integer
evaluationOrder =
        Integer
pEvaluationOrder_,
      $sel:segment:SegmentOverride' :: Text
segment = Text
pSegment_,
      $sel:weights:SegmentOverride' :: HashMap Text Natural
weights = forall a. Monoid a => a
Prelude.mempty
    }

-- | A number indicating the order to use to evaluate segment overrides, if
-- there are more than one. Segment overrides with lower numbers are
-- evaluated first.
segmentOverride_evaluationOrder :: Lens.Lens' SegmentOverride Prelude.Integer
segmentOverride_evaluationOrder :: Lens' SegmentOverride Integer
segmentOverride_evaluationOrder = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SegmentOverride' {Integer
evaluationOrder :: Integer
$sel:evaluationOrder:SegmentOverride' :: SegmentOverride -> Integer
evaluationOrder} -> Integer
evaluationOrder) (\s :: SegmentOverride
s@SegmentOverride' {} Integer
a -> SegmentOverride
s {$sel:evaluationOrder:SegmentOverride' :: Integer
evaluationOrder = Integer
a} :: SegmentOverride)

-- | The ARN of the segment to use.
segmentOverride_segment :: Lens.Lens' SegmentOverride Prelude.Text
segmentOverride_segment :: Lens' SegmentOverride Text
segmentOverride_segment = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SegmentOverride' {Text
segment :: Text
$sel:segment:SegmentOverride' :: SegmentOverride -> Text
segment} -> Text
segment) (\s :: SegmentOverride
s@SegmentOverride' {} Text
a -> SegmentOverride
s {$sel:segment:SegmentOverride' :: Text
segment = Text
a} :: SegmentOverride)

-- | The traffic allocation percentages among the feature variations to
-- assign to this segment. This is a set of key-value pairs. The keys are
-- variation names. The values represent the amount of traffic to allocate
-- to that variation for this segment. This is expressed in thousandths of
-- a percent, so a weight of 50000 represents 50% of traffic.
segmentOverride_weights :: Lens.Lens' SegmentOverride (Prelude.HashMap Prelude.Text Prelude.Natural)
segmentOverride_weights :: Lens' SegmentOverride (HashMap Text Natural)
segmentOverride_weights = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SegmentOverride' {HashMap Text Natural
weights :: HashMap Text Natural
$sel:weights:SegmentOverride' :: SegmentOverride -> HashMap Text Natural
weights} -> HashMap Text Natural
weights) (\s :: SegmentOverride
s@SegmentOverride' {} HashMap Text Natural
a -> SegmentOverride
s {$sel:weights:SegmentOverride' :: HashMap Text Natural
weights = HashMap Text Natural
a} :: SegmentOverride) 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 SegmentOverride where
  parseJSON :: Value -> Parser SegmentOverride
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"SegmentOverride"
      ( \Object
x ->
          Integer -> Text -> HashMap Text Natural -> SegmentOverride
SegmentOverride'
            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
"evaluationOrder")
            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
"segment")
            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
"weights" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
      )

instance Prelude.Hashable SegmentOverride where
  hashWithSalt :: Int -> SegmentOverride -> Int
hashWithSalt Int
_salt SegmentOverride' {Integer
Text
HashMap Text Natural
weights :: HashMap Text Natural
segment :: Text
evaluationOrder :: Integer
$sel:weights:SegmentOverride' :: SegmentOverride -> HashMap Text Natural
$sel:segment:SegmentOverride' :: SegmentOverride -> Text
$sel:evaluationOrder:SegmentOverride' :: SegmentOverride -> Integer
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Integer
evaluationOrder
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
segment
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` HashMap Text Natural
weights

instance Prelude.NFData SegmentOverride where
  rnf :: SegmentOverride -> ()
rnf SegmentOverride' {Integer
Text
HashMap Text Natural
weights :: HashMap Text Natural
segment :: Text
evaluationOrder :: Integer
$sel:weights:SegmentOverride' :: SegmentOverride -> HashMap Text Natural
$sel:segment:SegmentOverride' :: SegmentOverride -> Text
$sel:evaluationOrder:SegmentOverride' :: SegmentOverride -> Integer
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Integer
evaluationOrder
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
segment
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf HashMap Text Natural
weights

instance Data.ToJSON SegmentOverride where
  toJSON :: SegmentOverride -> Value
toJSON SegmentOverride' {Integer
Text
HashMap Text Natural
weights :: HashMap Text Natural
segment :: Text
evaluationOrder :: Integer
$sel:weights:SegmentOverride' :: SegmentOverride -> HashMap Text Natural
$sel:segment:SegmentOverride' :: SegmentOverride -> Text
$sel:evaluationOrder:SegmentOverride' :: SegmentOverride -> Integer
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just
              (Key
"evaluationOrder" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Integer
evaluationOrder),
            forall a. a -> Maybe a
Prelude.Just (Key
"segment" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
segment),
            forall a. a -> Maybe a
Prelude.Just (Key
"weights" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= HashMap Text Natural
weights)
          ]
      )