{-# 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.MediaTailor.Types.AvailMatchingCriteria
-- 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.MediaTailor.Types.AvailMatchingCriteria where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.MediaTailor.Types.Operator
import qualified Amazonka.Prelude as Prelude

-- | MediaTailor only places (consumes) prefetched ads if the ad break meets
-- the criteria defined by the dynamic variables. This gives you granular
-- control over which ad break to place the prefetched ads into.
--
-- As an example, let\'s say that you set @DynamicVariable@ to
-- @scte.event_id@ and @Operator@ to @EQUALS@, and your playback
-- configuration has an ADS URL of
-- @https:\/\/my.ads.server.com\/path?&podId=[scte.avail_num]&event=[scte.event_id]&duration=[session.avail_duration_secs]@.
-- And the prefetch request to the ADS contains these values
-- @https:\/\/my.ads.server.com\/path?&podId=3&event=my-awesome-event&duration=30@.
-- MediaTailor will only insert the prefetched ads into the ad break if has
-- a SCTE marker with an event id of @my-awesome-event@, since it must
-- match the event id that MediaTailor uses to query the ADS.
--
-- You can specify up to five @AvailMatchingCriteria@. If you specify
-- multiple @AvailMatchingCriteria@, MediaTailor combines them to match
-- using a logical @AND@. You can model logical @OR@ combinations by
-- creating multiple prefetch schedules.
--
-- /See:/ 'newAvailMatchingCriteria' smart constructor.
data AvailMatchingCriteria = AvailMatchingCriteria'
  { -- | The dynamic variable(s) that MediaTailor should use as avail matching
    -- criteria. MediaTailor only places the prefetched ads into the avail if
    -- the avail matches the criteria defined by the dynamic variable. For
    -- information about dynamic variables, see
    -- <https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html Using dynamic ad variables>
    -- in the /MediaTailor User Guide/.
    --
    -- You can include up to 100 dynamic variables.
    AvailMatchingCriteria -> Text
dynamicVariable :: Prelude.Text,
    -- | For the @DynamicVariable@ specified in @AvailMatchingCriteria@, the
    -- Operator that is used for the comparison.
    AvailMatchingCriteria -> Operator
operator :: Operator
  }
  deriving (AvailMatchingCriteria -> AvailMatchingCriteria -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: AvailMatchingCriteria -> AvailMatchingCriteria -> Bool
$c/= :: AvailMatchingCriteria -> AvailMatchingCriteria -> Bool
== :: AvailMatchingCriteria -> AvailMatchingCriteria -> Bool
$c== :: AvailMatchingCriteria -> AvailMatchingCriteria -> Bool
Prelude.Eq, ReadPrec [AvailMatchingCriteria]
ReadPrec AvailMatchingCriteria
Int -> ReadS AvailMatchingCriteria
ReadS [AvailMatchingCriteria]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [AvailMatchingCriteria]
$creadListPrec :: ReadPrec [AvailMatchingCriteria]
readPrec :: ReadPrec AvailMatchingCriteria
$creadPrec :: ReadPrec AvailMatchingCriteria
readList :: ReadS [AvailMatchingCriteria]
$creadList :: ReadS [AvailMatchingCriteria]
readsPrec :: Int -> ReadS AvailMatchingCriteria
$creadsPrec :: Int -> ReadS AvailMatchingCriteria
Prelude.Read, Int -> AvailMatchingCriteria -> ShowS
[AvailMatchingCriteria] -> ShowS
AvailMatchingCriteria -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [AvailMatchingCriteria] -> ShowS
$cshowList :: [AvailMatchingCriteria] -> ShowS
show :: AvailMatchingCriteria -> String
$cshow :: AvailMatchingCriteria -> String
showsPrec :: Int -> AvailMatchingCriteria -> ShowS
$cshowsPrec :: Int -> AvailMatchingCriteria -> ShowS
Prelude.Show, forall x. Rep AvailMatchingCriteria x -> AvailMatchingCriteria
forall x. AvailMatchingCriteria -> Rep AvailMatchingCriteria x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep AvailMatchingCriteria x -> AvailMatchingCriteria
$cfrom :: forall x. AvailMatchingCriteria -> Rep AvailMatchingCriteria x
Prelude.Generic)

-- |
-- Create a value of 'AvailMatchingCriteria' 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:
--
-- 'dynamicVariable', 'availMatchingCriteria_dynamicVariable' - The dynamic variable(s) that MediaTailor should use as avail matching
-- criteria. MediaTailor only places the prefetched ads into the avail if
-- the avail matches the criteria defined by the dynamic variable. For
-- information about dynamic variables, see
-- <https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html Using dynamic ad variables>
-- in the /MediaTailor User Guide/.
--
-- You can include up to 100 dynamic variables.
--
-- 'operator', 'availMatchingCriteria_operator' - For the @DynamicVariable@ specified in @AvailMatchingCriteria@, the
-- Operator that is used for the comparison.
newAvailMatchingCriteria ::
  -- | 'dynamicVariable'
  Prelude.Text ->
  -- | 'operator'
  Operator ->
  AvailMatchingCriteria
newAvailMatchingCriteria :: Text -> Operator -> AvailMatchingCriteria
newAvailMatchingCriteria Text
pDynamicVariable_ Operator
pOperator_ =
  AvailMatchingCriteria'
    { $sel:dynamicVariable:AvailMatchingCriteria' :: Text
dynamicVariable =
        Text
pDynamicVariable_,
      $sel:operator:AvailMatchingCriteria' :: Operator
operator = Operator
pOperator_
    }

-- | The dynamic variable(s) that MediaTailor should use as avail matching
-- criteria. MediaTailor only places the prefetched ads into the avail if
-- the avail matches the criteria defined by the dynamic variable. For
-- information about dynamic variables, see
-- <https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html Using dynamic ad variables>
-- in the /MediaTailor User Guide/.
--
-- You can include up to 100 dynamic variables.
availMatchingCriteria_dynamicVariable :: Lens.Lens' AvailMatchingCriteria Prelude.Text
availMatchingCriteria_dynamicVariable :: Lens' AvailMatchingCriteria Text
availMatchingCriteria_dynamicVariable = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AvailMatchingCriteria' {Text
dynamicVariable :: Text
$sel:dynamicVariable:AvailMatchingCriteria' :: AvailMatchingCriteria -> Text
dynamicVariable} -> Text
dynamicVariable) (\s :: AvailMatchingCriteria
s@AvailMatchingCriteria' {} Text
a -> AvailMatchingCriteria
s {$sel:dynamicVariable:AvailMatchingCriteria' :: Text
dynamicVariable = Text
a} :: AvailMatchingCriteria)

-- | For the @DynamicVariable@ specified in @AvailMatchingCriteria@, the
-- Operator that is used for the comparison.
availMatchingCriteria_operator :: Lens.Lens' AvailMatchingCriteria Operator
availMatchingCriteria_operator :: Lens' AvailMatchingCriteria Operator
availMatchingCriteria_operator = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AvailMatchingCriteria' {Operator
operator :: Operator
$sel:operator:AvailMatchingCriteria' :: AvailMatchingCriteria -> Operator
operator} -> Operator
operator) (\s :: AvailMatchingCriteria
s@AvailMatchingCriteria' {} Operator
a -> AvailMatchingCriteria
s {$sel:operator:AvailMatchingCriteria' :: Operator
operator = Operator
a} :: AvailMatchingCriteria)

instance Data.FromJSON AvailMatchingCriteria where
  parseJSON :: Value -> Parser AvailMatchingCriteria
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"AvailMatchingCriteria"
      ( \Object
x ->
          Text -> Operator -> AvailMatchingCriteria
AvailMatchingCriteria'
            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
"DynamicVariable")
            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
"Operator")
      )

instance Prelude.Hashable AvailMatchingCriteria where
  hashWithSalt :: Int -> AvailMatchingCriteria -> Int
hashWithSalt Int
_salt AvailMatchingCriteria' {Text
Operator
operator :: Operator
dynamicVariable :: Text
$sel:operator:AvailMatchingCriteria' :: AvailMatchingCriteria -> Operator
$sel:dynamicVariable:AvailMatchingCriteria' :: AvailMatchingCriteria -> Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
dynamicVariable
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Operator
operator

instance Prelude.NFData AvailMatchingCriteria where
  rnf :: AvailMatchingCriteria -> ()
rnf AvailMatchingCriteria' {Text
Operator
operator :: Operator
dynamicVariable :: Text
$sel:operator:AvailMatchingCriteria' :: AvailMatchingCriteria -> Operator
$sel:dynamicVariable:AvailMatchingCriteria' :: AvailMatchingCriteria -> Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Text
dynamicVariable
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Operator
operator

instance Data.ToJSON AvailMatchingCriteria where
  toJSON :: AvailMatchingCriteria -> Value
toJSON AvailMatchingCriteria' {Text
Operator
operator :: Operator
dynamicVariable :: Text
$sel:operator:AvailMatchingCriteria' :: AvailMatchingCriteria -> Operator
$sel:dynamicVariable:AvailMatchingCriteria' :: AvailMatchingCriteria -> Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just
              (Key
"DynamicVariable" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
dynamicVariable),
            forall a. a -> Maybe a
Prelude.Just (Key
"Operator" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Operator
operator)
          ]
      )