{-# 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.KinesisVideoArchivedMedia.Types.Image
-- 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.KinesisVideoArchivedMedia.Types.Image where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.KinesisVideoArchivedMedia.Types.ImageError
import qualified Amazonka.Prelude as Prelude

-- | A structure that contains the @Timestamp@, @Error@, and @ImageContent@.
--
-- /See:/ 'newImage' smart constructor.
data Image = Image'
  { -- | The error message shown when the image for the provided timestamp was
    -- not extracted due to a non-tryable error. An error will be returned if:
    --
    -- -   There is no media that exists for the specified @Timestamp@.
    --
    -- -   The media for the specified time does not allow an image to be
    --     extracted. In this case the media is audio only, or the incorrect
    --     media has been ingested.
    Image -> Maybe ImageError
error :: Prelude.Maybe ImageError,
    -- | An attribute of the @Image@ object that is Base64 encoded.
    Image -> Maybe Text
imageContent :: Prelude.Maybe Prelude.Text,
    -- | An attribute of the @Image@ object that is used to extract an image from
    -- the video stream. This field is used to manage gaps on images or to
    -- better understand the pagination window.
    Image -> Maybe POSIX
timeStamp :: Prelude.Maybe Data.POSIX
  }
  deriving (Image -> Image -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Image -> Image -> Bool
$c/= :: Image -> Image -> Bool
== :: Image -> Image -> Bool
$c== :: Image -> Image -> Bool
Prelude.Eq, ReadPrec [Image]
ReadPrec Image
Int -> ReadS Image
ReadS [Image]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Image]
$creadListPrec :: ReadPrec [Image]
readPrec :: ReadPrec Image
$creadPrec :: ReadPrec Image
readList :: ReadS [Image]
$creadList :: ReadS [Image]
readsPrec :: Int -> ReadS Image
$creadsPrec :: Int -> ReadS Image
Prelude.Read, Int -> Image -> ShowS
[Image] -> ShowS
Image -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Image] -> ShowS
$cshowList :: [Image] -> ShowS
show :: Image -> String
$cshow :: Image -> String
showsPrec :: Int -> Image -> ShowS
$cshowsPrec :: Int -> Image -> ShowS
Prelude.Show, forall x. Rep Image x -> Image
forall x. Image -> Rep Image x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Image x -> Image
$cfrom :: forall x. Image -> Rep Image x
Prelude.Generic)

-- |
-- Create a value of 'Image' 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:
--
-- 'error', 'image_error' - The error message shown when the image for the provided timestamp was
-- not extracted due to a non-tryable error. An error will be returned if:
--
-- -   There is no media that exists for the specified @Timestamp@.
--
-- -   The media for the specified time does not allow an image to be
--     extracted. In this case the media is audio only, or the incorrect
--     media has been ingested.
--
-- 'imageContent', 'image_imageContent' - An attribute of the @Image@ object that is Base64 encoded.
--
-- 'timeStamp', 'image_timeStamp' - An attribute of the @Image@ object that is used to extract an image from
-- the video stream. This field is used to manage gaps on images or to
-- better understand the pagination window.
newImage ::
  Image
newImage :: Image
newImage =
  Image'
    { $sel:error:Image' :: Maybe ImageError
error = forall a. Maybe a
Prelude.Nothing,
      $sel:imageContent:Image' :: Maybe Text
imageContent = forall a. Maybe a
Prelude.Nothing,
      $sel:timeStamp:Image' :: Maybe POSIX
timeStamp = forall a. Maybe a
Prelude.Nothing
    }

-- | The error message shown when the image for the provided timestamp was
-- not extracted due to a non-tryable error. An error will be returned if:
--
-- -   There is no media that exists for the specified @Timestamp@.
--
-- -   The media for the specified time does not allow an image to be
--     extracted. In this case the media is audio only, or the incorrect
--     media has been ingested.
image_error :: Lens.Lens' Image (Prelude.Maybe ImageError)
image_error :: Lens' Image (Maybe ImageError)
image_error = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Image' {Maybe ImageError
error :: Maybe ImageError
$sel:error:Image' :: Image -> Maybe ImageError
error} -> Maybe ImageError
error) (\s :: Image
s@Image' {} Maybe ImageError
a -> Image
s {$sel:error:Image' :: Maybe ImageError
error = Maybe ImageError
a} :: Image)

-- | An attribute of the @Image@ object that is Base64 encoded.
image_imageContent :: Lens.Lens' Image (Prelude.Maybe Prelude.Text)
image_imageContent :: Lens' Image (Maybe Text)
image_imageContent = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Image' {Maybe Text
imageContent :: Maybe Text
$sel:imageContent:Image' :: Image -> Maybe Text
imageContent} -> Maybe Text
imageContent) (\s :: Image
s@Image' {} Maybe Text
a -> Image
s {$sel:imageContent:Image' :: Maybe Text
imageContent = Maybe Text
a} :: Image)

-- | An attribute of the @Image@ object that is used to extract an image from
-- the video stream. This field is used to manage gaps on images or to
-- better understand the pagination window.
image_timeStamp :: Lens.Lens' Image (Prelude.Maybe Prelude.UTCTime)
image_timeStamp :: Lens' Image (Maybe UTCTime)
image_timeStamp = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Image' {Maybe POSIX
timeStamp :: Maybe POSIX
$sel:timeStamp:Image' :: Image -> Maybe POSIX
timeStamp} -> Maybe POSIX
timeStamp) (\s :: Image
s@Image' {} Maybe POSIX
a -> Image
s {$sel:timeStamp:Image' :: Maybe POSIX
timeStamp = Maybe POSIX
a} :: Image) 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

instance Data.FromJSON Image where
  parseJSON :: Value -> Parser Image
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"Image"
      ( \Object
x ->
          Maybe ImageError -> Maybe Text -> Maybe POSIX -> Image
Image'
            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
"Error")
            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
"ImageContent")
            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
"TimeStamp")
      )

instance Prelude.Hashable Image where
  hashWithSalt :: Int -> Image -> Int
hashWithSalt Int
_salt Image' {Maybe Text
Maybe POSIX
Maybe ImageError
timeStamp :: Maybe POSIX
imageContent :: Maybe Text
error :: Maybe ImageError
$sel:timeStamp:Image' :: Image -> Maybe POSIX
$sel:imageContent:Image' :: Image -> Maybe Text
$sel:error:Image' :: Image -> Maybe ImageError
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ImageError
error
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
imageContent
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
timeStamp

instance Prelude.NFData Image where
  rnf :: Image -> ()
rnf Image' {Maybe Text
Maybe POSIX
Maybe ImageError
timeStamp :: Maybe POSIX
imageContent :: Maybe Text
error :: Maybe ImageError
$sel:timeStamp:Image' :: Image -> Maybe POSIX
$sel:imageContent:Image' :: Image -> Maybe Text
$sel:error:Image' :: Image -> Maybe ImageError
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe ImageError
error
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
imageContent
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
timeStamp