{-# 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.Forecast.Types.TimeAlignmentBoundary
-- 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.Forecast.Types.TimeAlignmentBoundary where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Forecast.Types.DayOfWeek
import Amazonka.Forecast.Types.Month
import qualified Amazonka.Prelude as Prelude

-- | The time boundary Forecast uses to align and aggregate your data to
-- match your forecast frequency. Provide the unit of time and the time
-- boundary as a key value pair. If you don\'t provide a time boundary,
-- Forecast uses a set of
-- <https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#default-time-boundaries Default Time Boundaries>.
--
-- For more information about aggregation, see
-- <https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html Data Aggregation for Different Forecast Frequencies>.
-- For more information setting a custom time boundary, see
-- <https://docs.aws.amazon.com/forecast/latest/dg/data-aggregation.html#specifying-time-boundary Specifying a Time Boundary>.
--
-- /See:/ 'newTimeAlignmentBoundary' smart constructor.
data TimeAlignmentBoundary = TimeAlignmentBoundary'
  { -- | The day of the month to use for time alignment during aggregation.
    TimeAlignmentBoundary -> Maybe Natural
dayOfMonth :: Prelude.Maybe Prelude.Natural,
    -- | The day of week to use for time alignment during aggregation. The day
    -- must be in uppercase.
    TimeAlignmentBoundary -> Maybe DayOfWeek
dayOfWeek :: Prelude.Maybe DayOfWeek,
    -- | The hour of day to use for time alignment during aggregation.
    TimeAlignmentBoundary -> Maybe Natural
hour :: Prelude.Maybe Prelude.Natural,
    -- | The month to use for time alignment during aggregation. The month must
    -- be in uppercase.
    TimeAlignmentBoundary -> Maybe Month
month :: Prelude.Maybe Month
  }
  deriving (TimeAlignmentBoundary -> TimeAlignmentBoundary -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: TimeAlignmentBoundary -> TimeAlignmentBoundary -> Bool
$c/= :: TimeAlignmentBoundary -> TimeAlignmentBoundary -> Bool
== :: TimeAlignmentBoundary -> TimeAlignmentBoundary -> Bool
$c== :: TimeAlignmentBoundary -> TimeAlignmentBoundary -> Bool
Prelude.Eq, ReadPrec [TimeAlignmentBoundary]
ReadPrec TimeAlignmentBoundary
Int -> ReadS TimeAlignmentBoundary
ReadS [TimeAlignmentBoundary]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [TimeAlignmentBoundary]
$creadListPrec :: ReadPrec [TimeAlignmentBoundary]
readPrec :: ReadPrec TimeAlignmentBoundary
$creadPrec :: ReadPrec TimeAlignmentBoundary
readList :: ReadS [TimeAlignmentBoundary]
$creadList :: ReadS [TimeAlignmentBoundary]
readsPrec :: Int -> ReadS TimeAlignmentBoundary
$creadsPrec :: Int -> ReadS TimeAlignmentBoundary
Prelude.Read, Int -> TimeAlignmentBoundary -> ShowS
[TimeAlignmentBoundary] -> ShowS
TimeAlignmentBoundary -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [TimeAlignmentBoundary] -> ShowS
$cshowList :: [TimeAlignmentBoundary] -> ShowS
show :: TimeAlignmentBoundary -> String
$cshow :: TimeAlignmentBoundary -> String
showsPrec :: Int -> TimeAlignmentBoundary -> ShowS
$cshowsPrec :: Int -> TimeAlignmentBoundary -> ShowS
Prelude.Show, forall x. Rep TimeAlignmentBoundary x -> TimeAlignmentBoundary
forall x. TimeAlignmentBoundary -> Rep TimeAlignmentBoundary x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep TimeAlignmentBoundary x -> TimeAlignmentBoundary
$cfrom :: forall x. TimeAlignmentBoundary -> Rep TimeAlignmentBoundary x
Prelude.Generic)

-- |
-- Create a value of 'TimeAlignmentBoundary' 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:
--
-- 'dayOfMonth', 'timeAlignmentBoundary_dayOfMonth' - The day of the month to use for time alignment during aggregation.
--
-- 'dayOfWeek', 'timeAlignmentBoundary_dayOfWeek' - The day of week to use for time alignment during aggregation. The day
-- must be in uppercase.
--
-- 'hour', 'timeAlignmentBoundary_hour' - The hour of day to use for time alignment during aggregation.
--
-- 'month', 'timeAlignmentBoundary_month' - The month to use for time alignment during aggregation. The month must
-- be in uppercase.
newTimeAlignmentBoundary ::
  TimeAlignmentBoundary
newTimeAlignmentBoundary :: TimeAlignmentBoundary
newTimeAlignmentBoundary =
  TimeAlignmentBoundary'
    { $sel:dayOfMonth:TimeAlignmentBoundary' :: Maybe Natural
dayOfMonth =
        forall a. Maybe a
Prelude.Nothing,
      $sel:dayOfWeek:TimeAlignmentBoundary' :: Maybe DayOfWeek
dayOfWeek = forall a. Maybe a
Prelude.Nothing,
      $sel:hour:TimeAlignmentBoundary' :: Maybe Natural
hour = forall a. Maybe a
Prelude.Nothing,
      $sel:month:TimeAlignmentBoundary' :: Maybe Month
month = forall a. Maybe a
Prelude.Nothing
    }

-- | The day of the month to use for time alignment during aggregation.
timeAlignmentBoundary_dayOfMonth :: Lens.Lens' TimeAlignmentBoundary (Prelude.Maybe Prelude.Natural)
timeAlignmentBoundary_dayOfMonth :: Lens' TimeAlignmentBoundary (Maybe Natural)
timeAlignmentBoundary_dayOfMonth = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeAlignmentBoundary' {Maybe Natural
dayOfMonth :: Maybe Natural
$sel:dayOfMonth:TimeAlignmentBoundary' :: TimeAlignmentBoundary -> Maybe Natural
dayOfMonth} -> Maybe Natural
dayOfMonth) (\s :: TimeAlignmentBoundary
s@TimeAlignmentBoundary' {} Maybe Natural
a -> TimeAlignmentBoundary
s {$sel:dayOfMonth:TimeAlignmentBoundary' :: Maybe Natural
dayOfMonth = Maybe Natural
a} :: TimeAlignmentBoundary)

-- | The day of week to use for time alignment during aggregation. The day
-- must be in uppercase.
timeAlignmentBoundary_dayOfWeek :: Lens.Lens' TimeAlignmentBoundary (Prelude.Maybe DayOfWeek)
timeAlignmentBoundary_dayOfWeek :: Lens' TimeAlignmentBoundary (Maybe DayOfWeek)
timeAlignmentBoundary_dayOfWeek = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeAlignmentBoundary' {Maybe DayOfWeek
dayOfWeek :: Maybe DayOfWeek
$sel:dayOfWeek:TimeAlignmentBoundary' :: TimeAlignmentBoundary -> Maybe DayOfWeek
dayOfWeek} -> Maybe DayOfWeek
dayOfWeek) (\s :: TimeAlignmentBoundary
s@TimeAlignmentBoundary' {} Maybe DayOfWeek
a -> TimeAlignmentBoundary
s {$sel:dayOfWeek:TimeAlignmentBoundary' :: Maybe DayOfWeek
dayOfWeek = Maybe DayOfWeek
a} :: TimeAlignmentBoundary)

-- | The hour of day to use for time alignment during aggregation.
timeAlignmentBoundary_hour :: Lens.Lens' TimeAlignmentBoundary (Prelude.Maybe Prelude.Natural)
timeAlignmentBoundary_hour :: Lens' TimeAlignmentBoundary (Maybe Natural)
timeAlignmentBoundary_hour = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeAlignmentBoundary' {Maybe Natural
hour :: Maybe Natural
$sel:hour:TimeAlignmentBoundary' :: TimeAlignmentBoundary -> Maybe Natural
hour} -> Maybe Natural
hour) (\s :: TimeAlignmentBoundary
s@TimeAlignmentBoundary' {} Maybe Natural
a -> TimeAlignmentBoundary
s {$sel:hour:TimeAlignmentBoundary' :: Maybe Natural
hour = Maybe Natural
a} :: TimeAlignmentBoundary)

-- | The month to use for time alignment during aggregation. The month must
-- be in uppercase.
timeAlignmentBoundary_month :: Lens.Lens' TimeAlignmentBoundary (Prelude.Maybe Month)
timeAlignmentBoundary_month :: Lens' TimeAlignmentBoundary (Maybe Month)
timeAlignmentBoundary_month = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeAlignmentBoundary' {Maybe Month
month :: Maybe Month
$sel:month:TimeAlignmentBoundary' :: TimeAlignmentBoundary -> Maybe Month
month} -> Maybe Month
month) (\s :: TimeAlignmentBoundary
s@TimeAlignmentBoundary' {} Maybe Month
a -> TimeAlignmentBoundary
s {$sel:month:TimeAlignmentBoundary' :: Maybe Month
month = Maybe Month
a} :: TimeAlignmentBoundary)

instance Data.FromJSON TimeAlignmentBoundary where
  parseJSON :: Value -> Parser TimeAlignmentBoundary
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"TimeAlignmentBoundary"
      ( \Object
x ->
          Maybe Natural
-> Maybe DayOfWeek
-> Maybe Natural
-> Maybe Month
-> TimeAlignmentBoundary
TimeAlignmentBoundary'
            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
"DayOfMonth")
            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
"DayOfWeek")
            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
"Hour")
            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
"Month")
      )

instance Prelude.Hashable TimeAlignmentBoundary where
  hashWithSalt :: Int -> TimeAlignmentBoundary -> Int
hashWithSalt Int
_salt TimeAlignmentBoundary' {Maybe Natural
Maybe DayOfWeek
Maybe Month
month :: Maybe Month
hour :: Maybe Natural
dayOfWeek :: Maybe DayOfWeek
dayOfMonth :: Maybe Natural
$sel:month:TimeAlignmentBoundary' :: TimeAlignmentBoundary -> Maybe Month
$sel:hour:TimeAlignmentBoundary' :: TimeAlignmentBoundary -> Maybe Natural
$sel:dayOfWeek:TimeAlignmentBoundary' :: TimeAlignmentBoundary -> Maybe DayOfWeek
$sel:dayOfMonth:TimeAlignmentBoundary' :: TimeAlignmentBoundary -> Maybe Natural
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
dayOfMonth
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe DayOfWeek
dayOfWeek
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
hour
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Month
month

instance Prelude.NFData TimeAlignmentBoundary where
  rnf :: TimeAlignmentBoundary -> ()
rnf TimeAlignmentBoundary' {Maybe Natural
Maybe DayOfWeek
Maybe Month
month :: Maybe Month
hour :: Maybe Natural
dayOfWeek :: Maybe DayOfWeek
dayOfMonth :: Maybe Natural
$sel:month:TimeAlignmentBoundary' :: TimeAlignmentBoundary -> Maybe Month
$sel:hour:TimeAlignmentBoundary' :: TimeAlignmentBoundary -> Maybe Natural
$sel:dayOfWeek:TimeAlignmentBoundary' :: TimeAlignmentBoundary -> Maybe DayOfWeek
$sel:dayOfMonth:TimeAlignmentBoundary' :: TimeAlignmentBoundary -> Maybe Natural
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
dayOfMonth
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe DayOfWeek
dayOfWeek
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
hour
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Month
month

instance Data.ToJSON TimeAlignmentBoundary where
  toJSON :: TimeAlignmentBoundary -> Value
toJSON TimeAlignmentBoundary' {Maybe Natural
Maybe DayOfWeek
Maybe Month
month :: Maybe Month
hour :: Maybe Natural
dayOfWeek :: Maybe DayOfWeek
dayOfMonth :: Maybe Natural
$sel:month:TimeAlignmentBoundary' :: TimeAlignmentBoundary -> Maybe Month
$sel:hour:TimeAlignmentBoundary' :: TimeAlignmentBoundary -> Maybe Natural
$sel:dayOfWeek:TimeAlignmentBoundary' :: TimeAlignmentBoundary -> Maybe DayOfWeek
$sel:dayOfMonth:TimeAlignmentBoundary' :: TimeAlignmentBoundary -> Maybe Natural
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"DayOfMonth" 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 Natural
dayOfMonth,
            (Key
"DayOfWeek" 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 DayOfWeek
dayOfWeek,
            (Key
"Hour" 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 Natural
hour,
            (Key
"Month" 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 Month
month
          ]
      )