{-# 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.TumblingWindow -- 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.TumblingWindow 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 -- | Contains a tumbling window, which is a repeating fixed-sized, -- non-overlapping, and contiguous time window. You can use this window in -- metrics to aggregate data from properties and other assets. -- -- You can use @m@, @h@, @d@, and @w@ when you specify an interval or -- offset. Note that @m@ represents minutes, @h@ represents hours, @d@ -- represents days, and @w@ represents weeks. You can also use @s@ to -- represent seconds in @offset@. -- -- The @interval@ and @offset@ parameters support the -- <https://en.wikipedia.org/wiki/ISO_8601 ISO 8601 format>. For example, -- @PT5S@ represents 5 seconds, @PT5M@ represents 5 minutes, and @PT5H@ -- represents 5 hours. -- -- /See:/ 'newTumblingWindow' smart constructor. data TumblingWindow = TumblingWindow' { -- | The offset for the tumbling window. The @offset@ parameter accepts the -- following: -- -- - The offset time. -- -- For example, if you specify @18h@ for @offset@ and @1d@ for -- @interval@, IoT SiteWise aggregates data in one of the following -- ways: -- -- - If you create the metric before or at 6 PM (UTC), you get the -- first aggregation result at 6 PM (UTC) on the day when you -- create the metric. -- -- - If you create the metric after 6 PM (UTC), you get the first -- aggregation result at 6 PM (UTC) the next day. -- -- - The ISO 8601 format. -- -- For example, if you specify @PT18H@ for @offset@ and @1d@ for -- @interval@, IoT SiteWise aggregates data in one of the following -- ways: -- -- - If you create the metric before or at 6 PM (UTC), you get the -- first aggregation result at 6 PM (UTC) on the day when you -- create the metric. -- -- - If you create the metric after 6 PM (UTC), you get the first -- aggregation result at 6 PM (UTC) the next day. -- -- - The 24-hour clock. -- -- For example, if you specify @00:03:00@ for @offset@, @5m@ for -- @interval@, and you create the metric at 2 PM (UTC), you get the -- first aggregation result at 2:03 PM (UTC). You get the second -- aggregation result at 2:08 PM (UTC). -- -- - The offset time zone. -- -- For example, if you specify @2021-07-23T18:00-08@ for @offset@ and -- @1d@ for @interval@, IoT SiteWise aggregates data in one of the -- following ways: -- -- - If you create the metric before or at 6 PM (PST), you get the -- first aggregation result at 6 PM (PST) on the day when you -- create the metric. -- -- - If you create the metric after 6 PM (PST), you get the first -- aggregation result at 6 PM (PST) the next day. TumblingWindow -> Maybe Text offset :: Prelude.Maybe Prelude.Text, -- | The time interval for the tumbling window. The interval time must be -- between 1 minute and 1 week. -- -- IoT SiteWise computes the @1w@ interval the end of Sunday at midnight -- each week (UTC), the @1d@ interval at the end of each day at midnight -- (UTC), the @1h@ interval at the end of each hour, and so on. -- -- When IoT SiteWise aggregates data points for metric computations, the -- start of each interval is exclusive and the end of each interval is -- inclusive. IoT SiteWise places the computed data point at the end of the -- interval. TumblingWindow -> Text interval :: Prelude.Text } deriving (TumblingWindow -> TumblingWindow -> Bool forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a /= :: TumblingWindow -> TumblingWindow -> Bool $c/= :: TumblingWindow -> TumblingWindow -> Bool == :: TumblingWindow -> TumblingWindow -> Bool $c== :: TumblingWindow -> TumblingWindow -> Bool Prelude.Eq, ReadPrec [TumblingWindow] ReadPrec TumblingWindow Int -> ReadS TumblingWindow ReadS [TumblingWindow] forall a. (Int -> ReadS a) -> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a readListPrec :: ReadPrec [TumblingWindow] $creadListPrec :: ReadPrec [TumblingWindow] readPrec :: ReadPrec TumblingWindow $creadPrec :: ReadPrec TumblingWindow readList :: ReadS [TumblingWindow] $creadList :: ReadS [TumblingWindow] readsPrec :: Int -> ReadS TumblingWindow $creadsPrec :: Int -> ReadS TumblingWindow Prelude.Read, Int -> TumblingWindow -> ShowS [TumblingWindow] -> ShowS TumblingWindow -> String forall a. (Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a showList :: [TumblingWindow] -> ShowS $cshowList :: [TumblingWindow] -> ShowS show :: TumblingWindow -> String $cshow :: TumblingWindow -> String showsPrec :: Int -> TumblingWindow -> ShowS $cshowsPrec :: Int -> TumblingWindow -> ShowS Prelude.Show, forall x. Rep TumblingWindow x -> TumblingWindow forall x. TumblingWindow -> Rep TumblingWindow x forall a. (forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a $cto :: forall x. Rep TumblingWindow x -> TumblingWindow $cfrom :: forall x. TumblingWindow -> Rep TumblingWindow x Prelude.Generic) -- | -- Create a value of 'TumblingWindow' 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: -- -- 'offset', 'tumblingWindow_offset' - The offset for the tumbling window. The @offset@ parameter accepts the -- following: -- -- - The offset time. -- -- For example, if you specify @18h@ for @offset@ and @1d@ for -- @interval@, IoT SiteWise aggregates data in one of the following -- ways: -- -- - If you create the metric before or at 6 PM (UTC), you get the -- first aggregation result at 6 PM (UTC) on the day when you -- create the metric. -- -- - If you create the metric after 6 PM (UTC), you get the first -- aggregation result at 6 PM (UTC) the next day. -- -- - The ISO 8601 format. -- -- For example, if you specify @PT18H@ for @offset@ and @1d@ for -- @interval@, IoT SiteWise aggregates data in one of the following -- ways: -- -- - If you create the metric before or at 6 PM (UTC), you get the -- first aggregation result at 6 PM (UTC) on the day when you -- create the metric. -- -- - If you create the metric after 6 PM (UTC), you get the first -- aggregation result at 6 PM (UTC) the next day. -- -- - The 24-hour clock. -- -- For example, if you specify @00:03:00@ for @offset@, @5m@ for -- @interval@, and you create the metric at 2 PM (UTC), you get the -- first aggregation result at 2:03 PM (UTC). You get the second -- aggregation result at 2:08 PM (UTC). -- -- - The offset time zone. -- -- For example, if you specify @2021-07-23T18:00-08@ for @offset@ and -- @1d@ for @interval@, IoT SiteWise aggregates data in one of the -- following ways: -- -- - If you create the metric before or at 6 PM (PST), you get the -- first aggregation result at 6 PM (PST) on the day when you -- create the metric. -- -- - If you create the metric after 6 PM (PST), you get the first -- aggregation result at 6 PM (PST) the next day. -- -- 'interval', 'tumblingWindow_interval' - The time interval for the tumbling window. The interval time must be -- between 1 minute and 1 week. -- -- IoT SiteWise computes the @1w@ interval the end of Sunday at midnight -- each week (UTC), the @1d@ interval at the end of each day at midnight -- (UTC), the @1h@ interval at the end of each hour, and so on. -- -- When IoT SiteWise aggregates data points for metric computations, the -- start of each interval is exclusive and the end of each interval is -- inclusive. IoT SiteWise places the computed data point at the end of the -- interval. newTumblingWindow :: -- | 'interval' Prelude.Text -> TumblingWindow newTumblingWindow :: Text -> TumblingWindow newTumblingWindow Text pInterval_ = TumblingWindow' { $sel:offset:TumblingWindow' :: Maybe Text offset = forall a. Maybe a Prelude.Nothing, $sel:interval:TumblingWindow' :: Text interval = Text pInterval_ } -- | The offset for the tumbling window. The @offset@ parameter accepts the -- following: -- -- - The offset time. -- -- For example, if you specify @18h@ for @offset@ and @1d@ for -- @interval@, IoT SiteWise aggregates data in one of the following -- ways: -- -- - If you create the metric before or at 6 PM (UTC), you get the -- first aggregation result at 6 PM (UTC) on the day when you -- create the metric. -- -- - If you create the metric after 6 PM (UTC), you get the first -- aggregation result at 6 PM (UTC) the next day. -- -- - The ISO 8601 format. -- -- For example, if you specify @PT18H@ for @offset@ and @1d@ for -- @interval@, IoT SiteWise aggregates data in one of the following -- ways: -- -- - If you create the metric before or at 6 PM (UTC), you get the -- first aggregation result at 6 PM (UTC) on the day when you -- create the metric. -- -- - If you create the metric after 6 PM (UTC), you get the first -- aggregation result at 6 PM (UTC) the next day. -- -- - The 24-hour clock. -- -- For example, if you specify @00:03:00@ for @offset@, @5m@ for -- @interval@, and you create the metric at 2 PM (UTC), you get the -- first aggregation result at 2:03 PM (UTC). You get the second -- aggregation result at 2:08 PM (UTC). -- -- - The offset time zone. -- -- For example, if you specify @2021-07-23T18:00-08@ for @offset@ and -- @1d@ for @interval@, IoT SiteWise aggregates data in one of the -- following ways: -- -- - If you create the metric before or at 6 PM (PST), you get the -- first aggregation result at 6 PM (PST) on the day when you -- create the metric. -- -- - If you create the metric after 6 PM (PST), you get the first -- aggregation result at 6 PM (PST) the next day. tumblingWindow_offset :: Lens.Lens' TumblingWindow (Prelude.Maybe Prelude.Text) tumblingWindow_offset :: Lens' TumblingWindow (Maybe Text) tumblingWindow_offset = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\TumblingWindow' {Maybe Text offset :: Maybe Text $sel:offset:TumblingWindow' :: TumblingWindow -> Maybe Text offset} -> Maybe Text offset) (\s :: TumblingWindow s@TumblingWindow' {} Maybe Text a -> TumblingWindow s {$sel:offset:TumblingWindow' :: Maybe Text offset = Maybe Text a} :: TumblingWindow) -- | The time interval for the tumbling window. The interval time must be -- between 1 minute and 1 week. -- -- IoT SiteWise computes the @1w@ interval the end of Sunday at midnight -- each week (UTC), the @1d@ interval at the end of each day at midnight -- (UTC), the @1h@ interval at the end of each hour, and so on. -- -- When IoT SiteWise aggregates data points for metric computations, the -- start of each interval is exclusive and the end of each interval is -- inclusive. IoT SiteWise places the computed data point at the end of the -- interval. tumblingWindow_interval :: Lens.Lens' TumblingWindow Prelude.Text tumblingWindow_interval :: Lens' TumblingWindow Text tumblingWindow_interval = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b Lens.lens (\TumblingWindow' {Text interval :: Text $sel:interval:TumblingWindow' :: TumblingWindow -> Text interval} -> Text interval) (\s :: TumblingWindow s@TumblingWindow' {} Text a -> TumblingWindow s {$sel:interval:TumblingWindow' :: Text interval = Text a} :: TumblingWindow) instance Data.FromJSON TumblingWindow where parseJSON :: Value -> Parser TumblingWindow parseJSON = forall a. String -> (Object -> Parser a) -> Value -> Parser a Data.withObject String "TumblingWindow" ( \Object x -> Maybe Text -> Text -> TumblingWindow TumblingWindow' 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 "offset") 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 "interval") ) instance Prelude.Hashable TumblingWindow where hashWithSalt :: Int -> TumblingWindow -> Int hashWithSalt Int _salt TumblingWindow' {Maybe Text Text interval :: Text offset :: Maybe Text $sel:interval:TumblingWindow' :: TumblingWindow -> Text $sel:offset:TumblingWindow' :: TumblingWindow -> Maybe Text ..} = Int _salt forall a. Hashable a => Int -> a -> Int `Prelude.hashWithSalt` Maybe Text offset forall a. Hashable a => Int -> a -> Int `Prelude.hashWithSalt` Text interval instance Prelude.NFData TumblingWindow where rnf :: TumblingWindow -> () rnf TumblingWindow' {Maybe Text Text interval :: Text offset :: Maybe Text $sel:interval:TumblingWindow' :: TumblingWindow -> Text $sel:offset:TumblingWindow' :: TumblingWindow -> Maybe Text ..} = forall a. NFData a => a -> () Prelude.rnf Maybe Text offset seq :: forall a b. a -> b -> b `Prelude.seq` forall a. NFData a => a -> () Prelude.rnf Text interval instance Data.ToJSON TumblingWindow where toJSON :: TumblingWindow -> Value toJSON TumblingWindow' {Maybe Text Text interval :: Text offset :: Maybe Text $sel:interval:TumblingWindow' :: TumblingWindow -> Text $sel:offset:TumblingWindow' :: TumblingWindow -> Maybe Text ..} = [Pair] -> Value Data.object ( forall a. [Maybe a] -> [a] Prelude.catMaybes [ (Key "offset" 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 Text offset, forall a. a -> Maybe a Prelude.Just (Key "interval" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv Data..= Text interval) ] )