{-# 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.IoTSiteWise.Types.TimeSeriesSummary
-- 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.IoTSiteWise.Types.TimeSeriesSummary where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.IoTSiteWise.Types.PropertyDataType
import qualified Amazonka.Prelude as Prelude

-- | Contains a summary of a time series (data stream).
--
-- /See:/ 'newTimeSeriesSummary' smart constructor.
data TimeSeriesSummary = TimeSeriesSummary'
  { -- | The alias that identifies the time series.
    TimeSeriesSummary -> Maybe Text
alias :: Prelude.Maybe Prelude.Text,
    -- | The ID of the asset in which the asset property was created.
    TimeSeriesSummary -> Maybe Text
assetId :: Prelude.Maybe Prelude.Text,
    -- | The data type of the structure for this time series. This parameter is
    -- required for time series that have the @STRUCT@ data type.
    --
    -- The options for this parameter depend on the type of the composite model
    -- in which you created the asset property that is associated with your
    -- time series. Use @AWS\/ALARM_STATE@ for alarm state in alarm composite
    -- models.
    TimeSeriesSummary -> Maybe Text
dataTypeSpec :: Prelude.Maybe Prelude.Text,
    -- | The ID of the asset property.
    TimeSeriesSummary -> Maybe Text
propertyId :: Prelude.Maybe Prelude.Text,
    -- | The ID of the time series.
    TimeSeriesSummary -> Text
timeSeriesId :: Prelude.Text,
    -- | The data type of the time series.
    --
    -- If you specify @STRUCT@, you must also specify @dataTypeSpec@ to
    -- identify the type of the structure for this time series.
    TimeSeriesSummary -> PropertyDataType
dataType :: PropertyDataType,
    -- | The date that the time series was created, in Unix epoch time.
    TimeSeriesSummary -> POSIX
timeSeriesCreationDate :: Data.POSIX,
    -- | The date that the time series was last updated, in Unix epoch time.
    TimeSeriesSummary -> POSIX
timeSeriesLastUpdateDate :: Data.POSIX
  }
  deriving (TimeSeriesSummary -> TimeSeriesSummary -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: TimeSeriesSummary -> TimeSeriesSummary -> Bool
$c/= :: TimeSeriesSummary -> TimeSeriesSummary -> Bool
== :: TimeSeriesSummary -> TimeSeriesSummary -> Bool
$c== :: TimeSeriesSummary -> TimeSeriesSummary -> Bool
Prelude.Eq, ReadPrec [TimeSeriesSummary]
ReadPrec TimeSeriesSummary
Int -> ReadS TimeSeriesSummary
ReadS [TimeSeriesSummary]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [TimeSeriesSummary]
$creadListPrec :: ReadPrec [TimeSeriesSummary]
readPrec :: ReadPrec TimeSeriesSummary
$creadPrec :: ReadPrec TimeSeriesSummary
readList :: ReadS [TimeSeriesSummary]
$creadList :: ReadS [TimeSeriesSummary]
readsPrec :: Int -> ReadS TimeSeriesSummary
$creadsPrec :: Int -> ReadS TimeSeriesSummary
Prelude.Read, Int -> TimeSeriesSummary -> ShowS
[TimeSeriesSummary] -> ShowS
TimeSeriesSummary -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [TimeSeriesSummary] -> ShowS
$cshowList :: [TimeSeriesSummary] -> ShowS
show :: TimeSeriesSummary -> String
$cshow :: TimeSeriesSummary -> String
showsPrec :: Int -> TimeSeriesSummary -> ShowS
$cshowsPrec :: Int -> TimeSeriesSummary -> ShowS
Prelude.Show, forall x. Rep TimeSeriesSummary x -> TimeSeriesSummary
forall x. TimeSeriesSummary -> Rep TimeSeriesSummary x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep TimeSeriesSummary x -> TimeSeriesSummary
$cfrom :: forall x. TimeSeriesSummary -> Rep TimeSeriesSummary x
Prelude.Generic)

-- |
-- Create a value of 'TimeSeriesSummary' 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:
--
-- 'alias', 'timeSeriesSummary_alias' - The alias that identifies the time series.
--
-- 'assetId', 'timeSeriesSummary_assetId' - The ID of the asset in which the asset property was created.
--
-- 'dataTypeSpec', 'timeSeriesSummary_dataTypeSpec' - The data type of the structure for this time series. This parameter is
-- required for time series that have the @STRUCT@ data type.
--
-- The options for this parameter depend on the type of the composite model
-- in which you created the asset property that is associated with your
-- time series. Use @AWS\/ALARM_STATE@ for alarm state in alarm composite
-- models.
--
-- 'propertyId', 'timeSeriesSummary_propertyId' - The ID of the asset property.
--
-- 'timeSeriesId', 'timeSeriesSummary_timeSeriesId' - The ID of the time series.
--
-- 'dataType', 'timeSeriesSummary_dataType' - The data type of the time series.
--
-- If you specify @STRUCT@, you must also specify @dataTypeSpec@ to
-- identify the type of the structure for this time series.
--
-- 'timeSeriesCreationDate', 'timeSeriesSummary_timeSeriesCreationDate' - The date that the time series was created, in Unix epoch time.
--
-- 'timeSeriesLastUpdateDate', 'timeSeriesSummary_timeSeriesLastUpdateDate' - The date that the time series was last updated, in Unix epoch time.
newTimeSeriesSummary ::
  -- | 'timeSeriesId'
  Prelude.Text ->
  -- | 'dataType'
  PropertyDataType ->
  -- | 'timeSeriesCreationDate'
  Prelude.UTCTime ->
  -- | 'timeSeriesLastUpdateDate'
  Prelude.UTCTime ->
  TimeSeriesSummary
newTimeSeriesSummary :: Text -> PropertyDataType -> UTCTime -> UTCTime -> TimeSeriesSummary
newTimeSeriesSummary
  Text
pTimeSeriesId_
  PropertyDataType
pDataType_
  UTCTime
pTimeSeriesCreationDate_
  UTCTime
pTimeSeriesLastUpdateDate_ =
    TimeSeriesSummary'
      { $sel:alias:TimeSeriesSummary' :: Maybe Text
alias = forall a. Maybe a
Prelude.Nothing,
        $sel:assetId:TimeSeriesSummary' :: Maybe Text
assetId = forall a. Maybe a
Prelude.Nothing,
        $sel:dataTypeSpec:TimeSeriesSummary' :: Maybe Text
dataTypeSpec = forall a. Maybe a
Prelude.Nothing,
        $sel:propertyId:TimeSeriesSummary' :: Maybe Text
propertyId = forall a. Maybe a
Prelude.Nothing,
        $sel:timeSeriesId:TimeSeriesSummary' :: Text
timeSeriesId = Text
pTimeSeriesId_,
        $sel:dataType:TimeSeriesSummary' :: PropertyDataType
dataType = PropertyDataType
pDataType_,
        $sel:timeSeriesCreationDate:TimeSeriesSummary' :: POSIX
timeSeriesCreationDate =
          forall (a :: Format). Iso' (Time a) UTCTime
Data._Time forall t b. AReview t b -> b -> t
Lens.# UTCTime
pTimeSeriesCreationDate_,
        $sel:timeSeriesLastUpdateDate:TimeSeriesSummary' :: POSIX
timeSeriesLastUpdateDate =
          forall (a :: Format). Iso' (Time a) UTCTime
Data._Time forall t b. AReview t b -> b -> t
Lens.# UTCTime
pTimeSeriesLastUpdateDate_
      }

-- | The alias that identifies the time series.
timeSeriesSummary_alias :: Lens.Lens' TimeSeriesSummary (Prelude.Maybe Prelude.Text)
timeSeriesSummary_alias :: Lens' TimeSeriesSummary (Maybe Text)
timeSeriesSummary_alias = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeSeriesSummary' {Maybe Text
alias :: Maybe Text
$sel:alias:TimeSeriesSummary' :: TimeSeriesSummary -> Maybe Text
alias} -> Maybe Text
alias) (\s :: TimeSeriesSummary
s@TimeSeriesSummary' {} Maybe Text
a -> TimeSeriesSummary
s {$sel:alias:TimeSeriesSummary' :: Maybe Text
alias = Maybe Text
a} :: TimeSeriesSummary)

-- | The ID of the asset in which the asset property was created.
timeSeriesSummary_assetId :: Lens.Lens' TimeSeriesSummary (Prelude.Maybe Prelude.Text)
timeSeriesSummary_assetId :: Lens' TimeSeriesSummary (Maybe Text)
timeSeriesSummary_assetId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeSeriesSummary' {Maybe Text
assetId :: Maybe Text
$sel:assetId:TimeSeriesSummary' :: TimeSeriesSummary -> Maybe Text
assetId} -> Maybe Text
assetId) (\s :: TimeSeriesSummary
s@TimeSeriesSummary' {} Maybe Text
a -> TimeSeriesSummary
s {$sel:assetId:TimeSeriesSummary' :: Maybe Text
assetId = Maybe Text
a} :: TimeSeriesSummary)

-- | The data type of the structure for this time series. This parameter is
-- required for time series that have the @STRUCT@ data type.
--
-- The options for this parameter depend on the type of the composite model
-- in which you created the asset property that is associated with your
-- time series. Use @AWS\/ALARM_STATE@ for alarm state in alarm composite
-- models.
timeSeriesSummary_dataTypeSpec :: Lens.Lens' TimeSeriesSummary (Prelude.Maybe Prelude.Text)
timeSeriesSummary_dataTypeSpec :: Lens' TimeSeriesSummary (Maybe Text)
timeSeriesSummary_dataTypeSpec = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeSeriesSummary' {Maybe Text
dataTypeSpec :: Maybe Text
$sel:dataTypeSpec:TimeSeriesSummary' :: TimeSeriesSummary -> Maybe Text
dataTypeSpec} -> Maybe Text
dataTypeSpec) (\s :: TimeSeriesSummary
s@TimeSeriesSummary' {} Maybe Text
a -> TimeSeriesSummary
s {$sel:dataTypeSpec:TimeSeriesSummary' :: Maybe Text
dataTypeSpec = Maybe Text
a} :: TimeSeriesSummary)

-- | The ID of the asset property.
timeSeriesSummary_propertyId :: Lens.Lens' TimeSeriesSummary (Prelude.Maybe Prelude.Text)
timeSeriesSummary_propertyId :: Lens' TimeSeriesSummary (Maybe Text)
timeSeriesSummary_propertyId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeSeriesSummary' {Maybe Text
propertyId :: Maybe Text
$sel:propertyId:TimeSeriesSummary' :: TimeSeriesSummary -> Maybe Text
propertyId} -> Maybe Text
propertyId) (\s :: TimeSeriesSummary
s@TimeSeriesSummary' {} Maybe Text
a -> TimeSeriesSummary
s {$sel:propertyId:TimeSeriesSummary' :: Maybe Text
propertyId = Maybe Text
a} :: TimeSeriesSummary)

-- | The ID of the time series.
timeSeriesSummary_timeSeriesId :: Lens.Lens' TimeSeriesSummary Prelude.Text
timeSeriesSummary_timeSeriesId :: Lens' TimeSeriesSummary Text
timeSeriesSummary_timeSeriesId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeSeriesSummary' {Text
timeSeriesId :: Text
$sel:timeSeriesId:TimeSeriesSummary' :: TimeSeriesSummary -> Text
timeSeriesId} -> Text
timeSeriesId) (\s :: TimeSeriesSummary
s@TimeSeriesSummary' {} Text
a -> TimeSeriesSummary
s {$sel:timeSeriesId:TimeSeriesSummary' :: Text
timeSeriesId = Text
a} :: TimeSeriesSummary)

-- | The data type of the time series.
--
-- If you specify @STRUCT@, you must also specify @dataTypeSpec@ to
-- identify the type of the structure for this time series.
timeSeriesSummary_dataType :: Lens.Lens' TimeSeriesSummary PropertyDataType
timeSeriesSummary_dataType :: Lens' TimeSeriesSummary PropertyDataType
timeSeriesSummary_dataType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeSeriesSummary' {PropertyDataType
dataType :: PropertyDataType
$sel:dataType:TimeSeriesSummary' :: TimeSeriesSummary -> PropertyDataType
dataType} -> PropertyDataType
dataType) (\s :: TimeSeriesSummary
s@TimeSeriesSummary' {} PropertyDataType
a -> TimeSeriesSummary
s {$sel:dataType:TimeSeriesSummary' :: PropertyDataType
dataType = PropertyDataType
a} :: TimeSeriesSummary)

-- | The date that the time series was created, in Unix epoch time.
timeSeriesSummary_timeSeriesCreationDate :: Lens.Lens' TimeSeriesSummary Prelude.UTCTime
timeSeriesSummary_timeSeriesCreationDate :: Lens' TimeSeriesSummary UTCTime
timeSeriesSummary_timeSeriesCreationDate = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeSeriesSummary' {POSIX
timeSeriesCreationDate :: POSIX
$sel:timeSeriesCreationDate:TimeSeriesSummary' :: TimeSeriesSummary -> POSIX
timeSeriesCreationDate} -> POSIX
timeSeriesCreationDate) (\s :: TimeSeriesSummary
s@TimeSeriesSummary' {} POSIX
a -> TimeSeriesSummary
s {$sel:timeSeriesCreationDate:TimeSeriesSummary' :: POSIX
timeSeriesCreationDate = POSIX
a} :: TimeSeriesSummary) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (a :: Format). Iso' (Time a) UTCTime
Data._Time

-- | The date that the time series was last updated, in Unix epoch time.
timeSeriesSummary_timeSeriesLastUpdateDate :: Lens.Lens' TimeSeriesSummary Prelude.UTCTime
timeSeriesSummary_timeSeriesLastUpdateDate :: Lens' TimeSeriesSummary UTCTime
timeSeriesSummary_timeSeriesLastUpdateDate = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeSeriesSummary' {POSIX
timeSeriesLastUpdateDate :: POSIX
$sel:timeSeriesLastUpdateDate:TimeSeriesSummary' :: TimeSeriesSummary -> POSIX
timeSeriesLastUpdateDate} -> POSIX
timeSeriesLastUpdateDate) (\s :: TimeSeriesSummary
s@TimeSeriesSummary' {} POSIX
a -> TimeSeriesSummary
s {$sel:timeSeriesLastUpdateDate:TimeSeriesSummary' :: POSIX
timeSeriesLastUpdateDate = POSIX
a} :: TimeSeriesSummary) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (a :: Format). Iso' (Time a) UTCTime
Data._Time

instance Data.FromJSON TimeSeriesSummary where
  parseJSON :: Value -> Parser TimeSeriesSummary
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"TimeSeriesSummary"
      ( \Object
x ->
          Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Text
-> PropertyDataType
-> POSIX
-> POSIX
-> TimeSeriesSummary
TimeSeriesSummary'
            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
"alias")
            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
"assetId")
            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
"dataTypeSpec")
            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
"propertyId")
            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
"timeSeriesId")
            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
"dataType")
            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
"timeSeriesCreationDate")
            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
"timeSeriesLastUpdateDate")
      )

instance Prelude.Hashable TimeSeriesSummary where
  hashWithSalt :: Int -> TimeSeriesSummary -> Int
hashWithSalt Int
_salt TimeSeriesSummary' {Maybe Text
Text
POSIX
PropertyDataType
timeSeriesLastUpdateDate :: POSIX
timeSeriesCreationDate :: POSIX
dataType :: PropertyDataType
timeSeriesId :: Text
propertyId :: Maybe Text
dataTypeSpec :: Maybe Text
assetId :: Maybe Text
alias :: Maybe Text
$sel:timeSeriesLastUpdateDate:TimeSeriesSummary' :: TimeSeriesSummary -> POSIX
$sel:timeSeriesCreationDate:TimeSeriesSummary' :: TimeSeriesSummary -> POSIX
$sel:dataType:TimeSeriesSummary' :: TimeSeriesSummary -> PropertyDataType
$sel:timeSeriesId:TimeSeriesSummary' :: TimeSeriesSummary -> Text
$sel:propertyId:TimeSeriesSummary' :: TimeSeriesSummary -> Maybe Text
$sel:dataTypeSpec:TimeSeriesSummary' :: TimeSeriesSummary -> Maybe Text
$sel:assetId:TimeSeriesSummary' :: TimeSeriesSummary -> Maybe Text
$sel:alias:TimeSeriesSummary' :: TimeSeriesSummary -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
alias
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
assetId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
dataTypeSpec
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
propertyId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
timeSeriesId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` PropertyDataType
dataType
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` POSIX
timeSeriesCreationDate
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` POSIX
timeSeriesLastUpdateDate

instance Prelude.NFData TimeSeriesSummary where
  rnf :: TimeSeriesSummary -> ()
rnf TimeSeriesSummary' {Maybe Text
Text
POSIX
PropertyDataType
timeSeriesLastUpdateDate :: POSIX
timeSeriesCreationDate :: POSIX
dataType :: PropertyDataType
timeSeriesId :: Text
propertyId :: Maybe Text
dataTypeSpec :: Maybe Text
assetId :: Maybe Text
alias :: Maybe Text
$sel:timeSeriesLastUpdateDate:TimeSeriesSummary' :: TimeSeriesSummary -> POSIX
$sel:timeSeriesCreationDate:TimeSeriesSummary' :: TimeSeriesSummary -> POSIX
$sel:dataType:TimeSeriesSummary' :: TimeSeriesSummary -> PropertyDataType
$sel:timeSeriesId:TimeSeriesSummary' :: TimeSeriesSummary -> Text
$sel:propertyId:TimeSeriesSummary' :: TimeSeriesSummary -> Maybe Text
$sel:dataTypeSpec:TimeSeriesSummary' :: TimeSeriesSummary -> Maybe Text
$sel:assetId:TimeSeriesSummary' :: TimeSeriesSummary -> Maybe Text
$sel:alias:TimeSeriesSummary' :: TimeSeriesSummary -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
alias
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
assetId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
dataTypeSpec
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
propertyId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
timeSeriesId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf PropertyDataType
dataType
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf POSIX
timeSeriesCreationDate
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf POSIX
timeSeriesLastUpdateDate