{-# 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.PrefetchRetrieval
-- 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.PrefetchRetrieval 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

-- | A complex type that contains settings governing when MediaTailor
-- prefetches ads, and which dynamic variables that MediaTailor includes in
-- the request to the ad decision server.
--
-- /See:/ 'newPrefetchRetrieval' smart constructor.
data PrefetchRetrieval = PrefetchRetrieval'
  { -- | The dynamic variables to use for substitution during prefetch requests
    -- to the ad decision server (ADS).
    --
    -- You initially configure
    -- <https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html dynamic variables>
    -- for the ADS URL when you set up your playback configuration. When you
    -- specify @DynamicVariables@ for prefetch retrieval, MediaTailor includes
    -- the dynamic variables in the request to the ADS.
    PrefetchRetrieval -> Maybe (HashMap Text Text)
dynamicVariables :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text),
    -- | The time when prefetch retrievals can start for this break. Ad
    -- prefetching will be attempted for manifest requests that occur at or
    -- after this time. Defaults to the current time. If not specified, the
    -- prefetch retrieval starts as soon as possible.
    PrefetchRetrieval -> Maybe POSIX
startTime :: Prelude.Maybe Data.POSIX,
    -- | The time when prefetch retrieval ends for the ad break. Prefetching will
    -- be attempted for manifest requests that occur at or before this time.
    PrefetchRetrieval -> POSIX
endTime :: Data.POSIX
  }
  deriving (PrefetchRetrieval -> PrefetchRetrieval -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PrefetchRetrieval -> PrefetchRetrieval -> Bool
$c/= :: PrefetchRetrieval -> PrefetchRetrieval -> Bool
== :: PrefetchRetrieval -> PrefetchRetrieval -> Bool
$c== :: PrefetchRetrieval -> PrefetchRetrieval -> Bool
Prelude.Eq, ReadPrec [PrefetchRetrieval]
ReadPrec PrefetchRetrieval
Int -> ReadS PrefetchRetrieval
ReadS [PrefetchRetrieval]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [PrefetchRetrieval]
$creadListPrec :: ReadPrec [PrefetchRetrieval]
readPrec :: ReadPrec PrefetchRetrieval
$creadPrec :: ReadPrec PrefetchRetrieval
readList :: ReadS [PrefetchRetrieval]
$creadList :: ReadS [PrefetchRetrieval]
readsPrec :: Int -> ReadS PrefetchRetrieval
$creadsPrec :: Int -> ReadS PrefetchRetrieval
Prelude.Read, Int -> PrefetchRetrieval -> ShowS
[PrefetchRetrieval] -> ShowS
PrefetchRetrieval -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PrefetchRetrieval] -> ShowS
$cshowList :: [PrefetchRetrieval] -> ShowS
show :: PrefetchRetrieval -> String
$cshow :: PrefetchRetrieval -> String
showsPrec :: Int -> PrefetchRetrieval -> ShowS
$cshowsPrec :: Int -> PrefetchRetrieval -> ShowS
Prelude.Show, forall x. Rep PrefetchRetrieval x -> PrefetchRetrieval
forall x. PrefetchRetrieval -> Rep PrefetchRetrieval x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep PrefetchRetrieval x -> PrefetchRetrieval
$cfrom :: forall x. PrefetchRetrieval -> Rep PrefetchRetrieval x
Prelude.Generic)

-- |
-- Create a value of 'PrefetchRetrieval' 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:
--
-- 'dynamicVariables', 'prefetchRetrieval_dynamicVariables' - The dynamic variables to use for substitution during prefetch requests
-- to the ad decision server (ADS).
--
-- You initially configure
-- <https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html dynamic variables>
-- for the ADS URL when you set up your playback configuration. When you
-- specify @DynamicVariables@ for prefetch retrieval, MediaTailor includes
-- the dynamic variables in the request to the ADS.
--
-- 'startTime', 'prefetchRetrieval_startTime' - The time when prefetch retrievals can start for this break. Ad
-- prefetching will be attempted for manifest requests that occur at or
-- after this time. Defaults to the current time. If not specified, the
-- prefetch retrieval starts as soon as possible.
--
-- 'endTime', 'prefetchRetrieval_endTime' - The time when prefetch retrieval ends for the ad break. Prefetching will
-- be attempted for manifest requests that occur at or before this time.
newPrefetchRetrieval ::
  -- | 'endTime'
  Prelude.UTCTime ->
  PrefetchRetrieval
newPrefetchRetrieval :: UTCTime -> PrefetchRetrieval
newPrefetchRetrieval UTCTime
pEndTime_ =
  PrefetchRetrieval'
    { $sel:dynamicVariables:PrefetchRetrieval' :: Maybe (HashMap Text Text)
dynamicVariables =
        forall a. Maybe a
Prelude.Nothing,
      $sel:startTime:PrefetchRetrieval' :: Maybe POSIX
startTime = forall a. Maybe a
Prelude.Nothing,
      $sel:endTime:PrefetchRetrieval' :: POSIX
endTime = forall (a :: Format). Iso' (Time a) UTCTime
Data._Time forall t b. AReview t b -> b -> t
Lens.# UTCTime
pEndTime_
    }

-- | The dynamic variables to use for substitution during prefetch requests
-- to the ad decision server (ADS).
--
-- You initially configure
-- <https://docs.aws.amazon.com/mediatailor/latest/ug/variables.html dynamic variables>
-- for the ADS URL when you set up your playback configuration. When you
-- specify @DynamicVariables@ for prefetch retrieval, MediaTailor includes
-- the dynamic variables in the request to the ADS.
prefetchRetrieval_dynamicVariables :: Lens.Lens' PrefetchRetrieval (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))
prefetchRetrieval_dynamicVariables :: Lens' PrefetchRetrieval (Maybe (HashMap Text Text))
prefetchRetrieval_dynamicVariables = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PrefetchRetrieval' {Maybe (HashMap Text Text)
dynamicVariables :: Maybe (HashMap Text Text)
$sel:dynamicVariables:PrefetchRetrieval' :: PrefetchRetrieval -> Maybe (HashMap Text Text)
dynamicVariables} -> Maybe (HashMap Text Text)
dynamicVariables) (\s :: PrefetchRetrieval
s@PrefetchRetrieval' {} Maybe (HashMap Text Text)
a -> PrefetchRetrieval
s {$sel:dynamicVariables:PrefetchRetrieval' :: Maybe (HashMap Text Text)
dynamicVariables = Maybe (HashMap Text Text)
a} :: PrefetchRetrieval) 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

-- | The time when prefetch retrievals can start for this break. Ad
-- prefetching will be attempted for manifest requests that occur at or
-- after this time. Defaults to the current time. If not specified, the
-- prefetch retrieval starts as soon as possible.
prefetchRetrieval_startTime :: Lens.Lens' PrefetchRetrieval (Prelude.Maybe Prelude.UTCTime)
prefetchRetrieval_startTime :: Lens' PrefetchRetrieval (Maybe UTCTime)
prefetchRetrieval_startTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PrefetchRetrieval' {Maybe POSIX
startTime :: Maybe POSIX
$sel:startTime:PrefetchRetrieval' :: PrefetchRetrieval -> Maybe POSIX
startTime} -> Maybe POSIX
startTime) (\s :: PrefetchRetrieval
s@PrefetchRetrieval' {} Maybe POSIX
a -> PrefetchRetrieval
s {$sel:startTime:PrefetchRetrieval' :: Maybe POSIX
startTime = Maybe POSIX
a} :: PrefetchRetrieval) 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 (a :: Format). Iso' (Time a) UTCTime
Data._Time

-- | The time when prefetch retrieval ends for the ad break. Prefetching will
-- be attempted for manifest requests that occur at or before this time.
prefetchRetrieval_endTime :: Lens.Lens' PrefetchRetrieval Prelude.UTCTime
prefetchRetrieval_endTime :: Lens' PrefetchRetrieval UTCTime
prefetchRetrieval_endTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PrefetchRetrieval' {POSIX
endTime :: POSIX
$sel:endTime:PrefetchRetrieval' :: PrefetchRetrieval -> POSIX
endTime} -> POSIX
endTime) (\s :: PrefetchRetrieval
s@PrefetchRetrieval' {} POSIX
a -> PrefetchRetrieval
s {$sel:endTime:PrefetchRetrieval' :: POSIX
endTime = POSIX
a} :: PrefetchRetrieval) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (a :: Format). Iso' (Time a) UTCTime
Data._Time

instance Data.FromJSON PrefetchRetrieval where
  parseJSON :: Value -> Parser PrefetchRetrieval
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"PrefetchRetrieval"
      ( \Object
x ->
          Maybe (HashMap Text Text)
-> Maybe POSIX -> POSIX -> PrefetchRetrieval
PrefetchRetrieval'
            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
"DynamicVariables"
                            forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty
                        )
            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
"StartTime")
            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
"EndTime")
      )

instance Prelude.Hashable PrefetchRetrieval where
  hashWithSalt :: Int -> PrefetchRetrieval -> Int
hashWithSalt Int
_salt PrefetchRetrieval' {Maybe (HashMap Text Text)
Maybe POSIX
POSIX
endTime :: POSIX
startTime :: Maybe POSIX
dynamicVariables :: Maybe (HashMap Text Text)
$sel:endTime:PrefetchRetrieval' :: PrefetchRetrieval -> POSIX
$sel:startTime:PrefetchRetrieval' :: PrefetchRetrieval -> Maybe POSIX
$sel:dynamicVariables:PrefetchRetrieval' :: PrefetchRetrieval -> Maybe (HashMap Text Text)
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (HashMap Text Text)
dynamicVariables
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
startTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` POSIX
endTime

instance Prelude.NFData PrefetchRetrieval where
  rnf :: PrefetchRetrieval -> ()
rnf PrefetchRetrieval' {Maybe (HashMap Text Text)
Maybe POSIX
POSIX
endTime :: POSIX
startTime :: Maybe POSIX
dynamicVariables :: Maybe (HashMap Text Text)
$sel:endTime:PrefetchRetrieval' :: PrefetchRetrieval -> POSIX
$sel:startTime:PrefetchRetrieval' :: PrefetchRetrieval -> Maybe POSIX
$sel:dynamicVariables:PrefetchRetrieval' :: PrefetchRetrieval -> Maybe (HashMap Text Text)
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe (HashMap Text Text)
dynamicVariables
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
startTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf POSIX
endTime

instance Data.ToJSON PrefetchRetrieval where
  toJSON :: PrefetchRetrieval -> Value
toJSON PrefetchRetrieval' {Maybe (HashMap Text Text)
Maybe POSIX
POSIX
endTime :: POSIX
startTime :: Maybe POSIX
dynamicVariables :: Maybe (HashMap Text Text)
$sel:endTime:PrefetchRetrieval' :: PrefetchRetrieval -> POSIX
$sel:startTime:PrefetchRetrieval' :: PrefetchRetrieval -> Maybe POSIX
$sel:dynamicVariables:PrefetchRetrieval' :: PrefetchRetrieval -> Maybe (HashMap Text Text)
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"DynamicVariables" 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 (HashMap Text Text)
dynamicVariables,
            (Key
"StartTime" 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 POSIX
startTime,
            forall a. a -> Maybe a
Prelude.Just (Key
"EndTime" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= POSIX
endTime)
          ]
      )