{-# 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.IoTAnalytics.Types.ChannelSummary
-- 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.IoTAnalytics.Types.ChannelSummary where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.IoTAnalytics.Types.ChannelStatus
import Amazonka.IoTAnalytics.Types.ChannelStorageSummary
import qualified Amazonka.Prelude as Prelude

-- | A summary of information about a channel.
--
-- /See:/ 'newChannelSummary' smart constructor.
data ChannelSummary = ChannelSummary'
  { -- | The name of the channel.
    ChannelSummary -> Maybe Text
channelName :: Prelude.Maybe Prelude.Text,
    -- | Where channel data is stored.
    ChannelSummary -> Maybe ChannelStorageSummary
channelStorage :: Prelude.Maybe ChannelStorageSummary,
    -- | When the channel was created.
    ChannelSummary -> Maybe POSIX
creationTime :: Prelude.Maybe Data.POSIX,
    -- | The last time when a new message arrived in the channel.
    --
    -- IoT Analytics updates this value at most once per minute for one
    -- channel. Hence, the @lastMessageArrivalTime@ value is an approximation.
    --
    -- This feature only applies to messages that arrived in the data store
    -- after October 23, 2020.
    ChannelSummary -> Maybe POSIX
lastMessageArrivalTime :: Prelude.Maybe Data.POSIX,
    -- | The last time the channel was updated.
    ChannelSummary -> Maybe POSIX
lastUpdateTime :: Prelude.Maybe Data.POSIX,
    -- | The status of the channel.
    ChannelSummary -> Maybe ChannelStatus
status :: Prelude.Maybe ChannelStatus
  }
  deriving (ChannelSummary -> ChannelSummary -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ChannelSummary -> ChannelSummary -> Bool
$c/= :: ChannelSummary -> ChannelSummary -> Bool
== :: ChannelSummary -> ChannelSummary -> Bool
$c== :: ChannelSummary -> ChannelSummary -> Bool
Prelude.Eq, ReadPrec [ChannelSummary]
ReadPrec ChannelSummary
Int -> ReadS ChannelSummary
ReadS [ChannelSummary]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ChannelSummary]
$creadListPrec :: ReadPrec [ChannelSummary]
readPrec :: ReadPrec ChannelSummary
$creadPrec :: ReadPrec ChannelSummary
readList :: ReadS [ChannelSummary]
$creadList :: ReadS [ChannelSummary]
readsPrec :: Int -> ReadS ChannelSummary
$creadsPrec :: Int -> ReadS ChannelSummary
Prelude.Read, Int -> ChannelSummary -> ShowS
[ChannelSummary] -> ShowS
ChannelSummary -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ChannelSummary] -> ShowS
$cshowList :: [ChannelSummary] -> ShowS
show :: ChannelSummary -> String
$cshow :: ChannelSummary -> String
showsPrec :: Int -> ChannelSummary -> ShowS
$cshowsPrec :: Int -> ChannelSummary -> ShowS
Prelude.Show, forall x. Rep ChannelSummary x -> ChannelSummary
forall x. ChannelSummary -> Rep ChannelSummary x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ChannelSummary x -> ChannelSummary
$cfrom :: forall x. ChannelSummary -> Rep ChannelSummary x
Prelude.Generic)

-- |
-- Create a value of 'ChannelSummary' 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:
--
-- 'channelName', 'channelSummary_channelName' - The name of the channel.
--
-- 'channelStorage', 'channelSummary_channelStorage' - Where channel data is stored.
--
-- 'creationTime', 'channelSummary_creationTime' - When the channel was created.
--
-- 'lastMessageArrivalTime', 'channelSummary_lastMessageArrivalTime' - The last time when a new message arrived in the channel.
--
-- IoT Analytics updates this value at most once per minute for one
-- channel. Hence, the @lastMessageArrivalTime@ value is an approximation.
--
-- This feature only applies to messages that arrived in the data store
-- after October 23, 2020.
--
-- 'lastUpdateTime', 'channelSummary_lastUpdateTime' - The last time the channel was updated.
--
-- 'status', 'channelSummary_status' - The status of the channel.
newChannelSummary ::
  ChannelSummary
newChannelSummary :: ChannelSummary
newChannelSummary =
  ChannelSummary'
    { $sel:channelName:ChannelSummary' :: Maybe Text
channelName = forall a. Maybe a
Prelude.Nothing,
      $sel:channelStorage:ChannelSummary' :: Maybe ChannelStorageSummary
channelStorage = forall a. Maybe a
Prelude.Nothing,
      $sel:creationTime:ChannelSummary' :: Maybe POSIX
creationTime = forall a. Maybe a
Prelude.Nothing,
      $sel:lastMessageArrivalTime:ChannelSummary' :: Maybe POSIX
lastMessageArrivalTime = forall a. Maybe a
Prelude.Nothing,
      $sel:lastUpdateTime:ChannelSummary' :: Maybe POSIX
lastUpdateTime = forall a. Maybe a
Prelude.Nothing,
      $sel:status:ChannelSummary' :: Maybe ChannelStatus
status = forall a. Maybe a
Prelude.Nothing
    }

-- | The name of the channel.
channelSummary_channelName :: Lens.Lens' ChannelSummary (Prelude.Maybe Prelude.Text)
channelSummary_channelName :: Lens' ChannelSummary (Maybe Text)
channelSummary_channelName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ChannelSummary' {Maybe Text
channelName :: Maybe Text
$sel:channelName:ChannelSummary' :: ChannelSummary -> Maybe Text
channelName} -> Maybe Text
channelName) (\s :: ChannelSummary
s@ChannelSummary' {} Maybe Text
a -> ChannelSummary
s {$sel:channelName:ChannelSummary' :: Maybe Text
channelName = Maybe Text
a} :: ChannelSummary)

-- | Where channel data is stored.
channelSummary_channelStorage :: Lens.Lens' ChannelSummary (Prelude.Maybe ChannelStorageSummary)
channelSummary_channelStorage :: Lens' ChannelSummary (Maybe ChannelStorageSummary)
channelSummary_channelStorage = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ChannelSummary' {Maybe ChannelStorageSummary
channelStorage :: Maybe ChannelStorageSummary
$sel:channelStorage:ChannelSummary' :: ChannelSummary -> Maybe ChannelStorageSummary
channelStorage} -> Maybe ChannelStorageSummary
channelStorage) (\s :: ChannelSummary
s@ChannelSummary' {} Maybe ChannelStorageSummary
a -> ChannelSummary
s {$sel:channelStorage:ChannelSummary' :: Maybe ChannelStorageSummary
channelStorage = Maybe ChannelStorageSummary
a} :: ChannelSummary)

-- | When the channel was created.
channelSummary_creationTime :: Lens.Lens' ChannelSummary (Prelude.Maybe Prelude.UTCTime)
channelSummary_creationTime :: Lens' ChannelSummary (Maybe UTCTime)
channelSummary_creationTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ChannelSummary' {Maybe POSIX
creationTime :: Maybe POSIX
$sel:creationTime:ChannelSummary' :: ChannelSummary -> Maybe POSIX
creationTime} -> Maybe POSIX
creationTime) (\s :: ChannelSummary
s@ChannelSummary' {} Maybe POSIX
a -> ChannelSummary
s {$sel:creationTime:ChannelSummary' :: Maybe POSIX
creationTime = Maybe POSIX
a} :: ChannelSummary) 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 last time when a new message arrived in the channel.
--
-- IoT Analytics updates this value at most once per minute for one
-- channel. Hence, the @lastMessageArrivalTime@ value is an approximation.
--
-- This feature only applies to messages that arrived in the data store
-- after October 23, 2020.
channelSummary_lastMessageArrivalTime :: Lens.Lens' ChannelSummary (Prelude.Maybe Prelude.UTCTime)
channelSummary_lastMessageArrivalTime :: Lens' ChannelSummary (Maybe UTCTime)
channelSummary_lastMessageArrivalTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ChannelSummary' {Maybe POSIX
lastMessageArrivalTime :: Maybe POSIX
$sel:lastMessageArrivalTime:ChannelSummary' :: ChannelSummary -> Maybe POSIX
lastMessageArrivalTime} -> Maybe POSIX
lastMessageArrivalTime) (\s :: ChannelSummary
s@ChannelSummary' {} Maybe POSIX
a -> ChannelSummary
s {$sel:lastMessageArrivalTime:ChannelSummary' :: Maybe POSIX
lastMessageArrivalTime = Maybe POSIX
a} :: ChannelSummary) 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 last time the channel was updated.
channelSummary_lastUpdateTime :: Lens.Lens' ChannelSummary (Prelude.Maybe Prelude.UTCTime)
channelSummary_lastUpdateTime :: Lens' ChannelSummary (Maybe UTCTime)
channelSummary_lastUpdateTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ChannelSummary' {Maybe POSIX
lastUpdateTime :: Maybe POSIX
$sel:lastUpdateTime:ChannelSummary' :: ChannelSummary -> Maybe POSIX
lastUpdateTime} -> Maybe POSIX
lastUpdateTime) (\s :: ChannelSummary
s@ChannelSummary' {} Maybe POSIX
a -> ChannelSummary
s {$sel:lastUpdateTime:ChannelSummary' :: Maybe POSIX
lastUpdateTime = Maybe POSIX
a} :: ChannelSummary) 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 status of the channel.
channelSummary_status :: Lens.Lens' ChannelSummary (Prelude.Maybe ChannelStatus)
channelSummary_status :: Lens' ChannelSummary (Maybe ChannelStatus)
channelSummary_status = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ChannelSummary' {Maybe ChannelStatus
status :: Maybe ChannelStatus
$sel:status:ChannelSummary' :: ChannelSummary -> Maybe ChannelStatus
status} -> Maybe ChannelStatus
status) (\s :: ChannelSummary
s@ChannelSummary' {} Maybe ChannelStatus
a -> ChannelSummary
s {$sel:status:ChannelSummary' :: Maybe ChannelStatus
status = Maybe ChannelStatus
a} :: ChannelSummary)

instance Data.FromJSON ChannelSummary where
  parseJSON :: Value -> Parser ChannelSummary
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ChannelSummary"
      ( \Object
x ->
          Maybe Text
-> Maybe ChannelStorageSummary
-> Maybe POSIX
-> Maybe POSIX
-> Maybe POSIX
-> Maybe ChannelStatus
-> ChannelSummary
ChannelSummary'
            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
"channelName")
            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
"channelStorage")
            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
"creationTime")
            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
"lastMessageArrivalTime")
            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
"lastUpdateTime")
            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
"status")
      )

instance Prelude.Hashable ChannelSummary where
  hashWithSalt :: Int -> ChannelSummary -> Int
hashWithSalt Int
_salt ChannelSummary' {Maybe Text
Maybe POSIX
Maybe ChannelStatus
Maybe ChannelStorageSummary
status :: Maybe ChannelStatus
lastUpdateTime :: Maybe POSIX
lastMessageArrivalTime :: Maybe POSIX
creationTime :: Maybe POSIX
channelStorage :: Maybe ChannelStorageSummary
channelName :: Maybe Text
$sel:status:ChannelSummary' :: ChannelSummary -> Maybe ChannelStatus
$sel:lastUpdateTime:ChannelSummary' :: ChannelSummary -> Maybe POSIX
$sel:lastMessageArrivalTime:ChannelSummary' :: ChannelSummary -> Maybe POSIX
$sel:creationTime:ChannelSummary' :: ChannelSummary -> Maybe POSIX
$sel:channelStorage:ChannelSummary' :: ChannelSummary -> Maybe ChannelStorageSummary
$sel:channelName:ChannelSummary' :: ChannelSummary -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
channelName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ChannelStorageSummary
channelStorage
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
creationTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
lastMessageArrivalTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
lastUpdateTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ChannelStatus
status

instance Prelude.NFData ChannelSummary where
  rnf :: ChannelSummary -> ()
rnf ChannelSummary' {Maybe Text
Maybe POSIX
Maybe ChannelStatus
Maybe ChannelStorageSummary
status :: Maybe ChannelStatus
lastUpdateTime :: Maybe POSIX
lastMessageArrivalTime :: Maybe POSIX
creationTime :: Maybe POSIX
channelStorage :: Maybe ChannelStorageSummary
channelName :: Maybe Text
$sel:status:ChannelSummary' :: ChannelSummary -> Maybe ChannelStatus
$sel:lastUpdateTime:ChannelSummary' :: ChannelSummary -> Maybe POSIX
$sel:lastMessageArrivalTime:ChannelSummary' :: ChannelSummary -> Maybe POSIX
$sel:creationTime:ChannelSummary' :: ChannelSummary -> Maybe POSIX
$sel:channelStorage:ChannelSummary' :: ChannelSummary -> Maybe ChannelStorageSummary
$sel:channelName:ChannelSummary' :: ChannelSummary -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
channelName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ChannelStorageSummary
channelStorage
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
creationTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
lastMessageArrivalTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
lastUpdateTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ChannelStatus
status