{-# 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.QuickSight.Types.ExcludePeriodConfiguration
-- 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.QuickSight.Types.ExcludePeriodConfiguration 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
import Amazonka.QuickSight.Types.TimeGranularity
import Amazonka.QuickSight.Types.WidgetStatus

-- | The exclude period of @TimeRangeFilter@ or @RelativeDatesFilter@.
--
-- /See:/ 'newExcludePeriodConfiguration' smart constructor.
data ExcludePeriodConfiguration = ExcludePeriodConfiguration'
  { -- | The status of the exclude period. Choose from the following options:
    --
    -- -   @ENABLED@
    --
    -- -   @DISABLED@
    ExcludePeriodConfiguration -> Maybe WidgetStatus
status :: Prelude.Maybe WidgetStatus,
    -- | The amount or number of the exclude period.
    ExcludePeriodConfiguration -> Int
amount :: Prelude.Int,
    -- | The granularity or unit (day, month, year) of the exclude period.
    ExcludePeriodConfiguration -> TimeGranularity
granularity :: TimeGranularity
  }
  deriving (ExcludePeriodConfiguration -> ExcludePeriodConfiguration -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ExcludePeriodConfiguration -> ExcludePeriodConfiguration -> Bool
$c/= :: ExcludePeriodConfiguration -> ExcludePeriodConfiguration -> Bool
== :: ExcludePeriodConfiguration -> ExcludePeriodConfiguration -> Bool
$c== :: ExcludePeriodConfiguration -> ExcludePeriodConfiguration -> Bool
Prelude.Eq, ReadPrec [ExcludePeriodConfiguration]
ReadPrec ExcludePeriodConfiguration
Int -> ReadS ExcludePeriodConfiguration
ReadS [ExcludePeriodConfiguration]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ExcludePeriodConfiguration]
$creadListPrec :: ReadPrec [ExcludePeriodConfiguration]
readPrec :: ReadPrec ExcludePeriodConfiguration
$creadPrec :: ReadPrec ExcludePeriodConfiguration
readList :: ReadS [ExcludePeriodConfiguration]
$creadList :: ReadS [ExcludePeriodConfiguration]
readsPrec :: Int -> ReadS ExcludePeriodConfiguration
$creadsPrec :: Int -> ReadS ExcludePeriodConfiguration
Prelude.Read, Int -> ExcludePeriodConfiguration -> ShowS
[ExcludePeriodConfiguration] -> ShowS
ExcludePeriodConfiguration -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ExcludePeriodConfiguration] -> ShowS
$cshowList :: [ExcludePeriodConfiguration] -> ShowS
show :: ExcludePeriodConfiguration -> String
$cshow :: ExcludePeriodConfiguration -> String
showsPrec :: Int -> ExcludePeriodConfiguration -> ShowS
$cshowsPrec :: Int -> ExcludePeriodConfiguration -> ShowS
Prelude.Show, forall x.
Rep ExcludePeriodConfiguration x -> ExcludePeriodConfiguration
forall x.
ExcludePeriodConfiguration -> Rep ExcludePeriodConfiguration x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ExcludePeriodConfiguration x -> ExcludePeriodConfiguration
$cfrom :: forall x.
ExcludePeriodConfiguration -> Rep ExcludePeriodConfiguration x
Prelude.Generic)

-- |
-- Create a value of 'ExcludePeriodConfiguration' 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:
--
-- 'status', 'excludePeriodConfiguration_status' - The status of the exclude period. Choose from the following options:
--
-- -   @ENABLED@
--
-- -   @DISABLED@
--
-- 'amount', 'excludePeriodConfiguration_amount' - The amount or number of the exclude period.
--
-- 'granularity', 'excludePeriodConfiguration_granularity' - The granularity or unit (day, month, year) of the exclude period.
newExcludePeriodConfiguration ::
  -- | 'amount'
  Prelude.Int ->
  -- | 'granularity'
  TimeGranularity ->
  ExcludePeriodConfiguration
newExcludePeriodConfiguration :: Int -> TimeGranularity -> ExcludePeriodConfiguration
newExcludePeriodConfiguration Int
pAmount_ TimeGranularity
pGranularity_ =
  ExcludePeriodConfiguration'
    { $sel:status:ExcludePeriodConfiguration' :: Maybe WidgetStatus
status =
        forall a. Maybe a
Prelude.Nothing,
      $sel:amount:ExcludePeriodConfiguration' :: Int
amount = Int
pAmount_,
      $sel:granularity:ExcludePeriodConfiguration' :: TimeGranularity
granularity = TimeGranularity
pGranularity_
    }

-- | The status of the exclude period. Choose from the following options:
--
-- -   @ENABLED@
--
-- -   @DISABLED@
excludePeriodConfiguration_status :: Lens.Lens' ExcludePeriodConfiguration (Prelude.Maybe WidgetStatus)
excludePeriodConfiguration_status :: Lens' ExcludePeriodConfiguration (Maybe WidgetStatus)
excludePeriodConfiguration_status = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ExcludePeriodConfiguration' {Maybe WidgetStatus
status :: Maybe WidgetStatus
$sel:status:ExcludePeriodConfiguration' :: ExcludePeriodConfiguration -> Maybe WidgetStatus
status} -> Maybe WidgetStatus
status) (\s :: ExcludePeriodConfiguration
s@ExcludePeriodConfiguration' {} Maybe WidgetStatus
a -> ExcludePeriodConfiguration
s {$sel:status:ExcludePeriodConfiguration' :: Maybe WidgetStatus
status = Maybe WidgetStatus
a} :: ExcludePeriodConfiguration)

-- | The amount or number of the exclude period.
excludePeriodConfiguration_amount :: Lens.Lens' ExcludePeriodConfiguration Prelude.Int
excludePeriodConfiguration_amount :: Lens' ExcludePeriodConfiguration Int
excludePeriodConfiguration_amount = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ExcludePeriodConfiguration' {Int
amount :: Int
$sel:amount:ExcludePeriodConfiguration' :: ExcludePeriodConfiguration -> Int
amount} -> Int
amount) (\s :: ExcludePeriodConfiguration
s@ExcludePeriodConfiguration' {} Int
a -> ExcludePeriodConfiguration
s {$sel:amount:ExcludePeriodConfiguration' :: Int
amount = Int
a} :: ExcludePeriodConfiguration)

-- | The granularity or unit (day, month, year) of the exclude period.
excludePeriodConfiguration_granularity :: Lens.Lens' ExcludePeriodConfiguration TimeGranularity
excludePeriodConfiguration_granularity :: Lens' ExcludePeriodConfiguration TimeGranularity
excludePeriodConfiguration_granularity = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ExcludePeriodConfiguration' {TimeGranularity
granularity :: TimeGranularity
$sel:granularity:ExcludePeriodConfiguration' :: ExcludePeriodConfiguration -> TimeGranularity
granularity} -> TimeGranularity
granularity) (\s :: ExcludePeriodConfiguration
s@ExcludePeriodConfiguration' {} TimeGranularity
a -> ExcludePeriodConfiguration
s {$sel:granularity:ExcludePeriodConfiguration' :: TimeGranularity
granularity = TimeGranularity
a} :: ExcludePeriodConfiguration)

instance Data.FromJSON ExcludePeriodConfiguration where
  parseJSON :: Value -> Parser ExcludePeriodConfiguration
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ExcludePeriodConfiguration"
      ( \Object
x ->
          Maybe WidgetStatus
-> Int -> TimeGranularity -> ExcludePeriodConfiguration
ExcludePeriodConfiguration'
            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
"Status")
            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
"Amount")
            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
"Granularity")
      )

instance Prelude.Hashable ExcludePeriodConfiguration where
  hashWithSalt :: Int -> ExcludePeriodConfiguration -> Int
hashWithSalt Int
_salt ExcludePeriodConfiguration' {Int
Maybe WidgetStatus
TimeGranularity
granularity :: TimeGranularity
amount :: Int
status :: Maybe WidgetStatus
$sel:granularity:ExcludePeriodConfiguration' :: ExcludePeriodConfiguration -> TimeGranularity
$sel:amount:ExcludePeriodConfiguration' :: ExcludePeriodConfiguration -> Int
$sel:status:ExcludePeriodConfiguration' :: ExcludePeriodConfiguration -> Maybe WidgetStatus
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe WidgetStatus
status
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Int
amount
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` TimeGranularity
granularity

instance Prelude.NFData ExcludePeriodConfiguration where
  rnf :: ExcludePeriodConfiguration -> ()
rnf ExcludePeriodConfiguration' {Int
Maybe WidgetStatus
TimeGranularity
granularity :: TimeGranularity
amount :: Int
status :: Maybe WidgetStatus
$sel:granularity:ExcludePeriodConfiguration' :: ExcludePeriodConfiguration -> TimeGranularity
$sel:amount:ExcludePeriodConfiguration' :: ExcludePeriodConfiguration -> Int
$sel:status:ExcludePeriodConfiguration' :: ExcludePeriodConfiguration -> Maybe WidgetStatus
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe WidgetStatus
status
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
amount
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf TimeGranularity
granularity

instance Data.ToJSON ExcludePeriodConfiguration where
  toJSON :: ExcludePeriodConfiguration -> Value
toJSON ExcludePeriodConfiguration' {Int
Maybe WidgetStatus
TimeGranularity
granularity :: TimeGranularity
amount :: Int
status :: Maybe WidgetStatus
$sel:granularity:ExcludePeriodConfiguration' :: ExcludePeriodConfiguration -> TimeGranularity
$sel:amount:ExcludePeriodConfiguration' :: ExcludePeriodConfiguration -> Int
$sel:status:ExcludePeriodConfiguration' :: ExcludePeriodConfiguration -> Maybe WidgetStatus
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"Status" 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 WidgetStatus
status,
            forall a. a -> Maybe a
Prelude.Just (Key
"Amount" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Int
amount),
            forall a. a -> Maybe a
Prelude.Just (Key
"Granularity" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= TimeGranularity
granularity)
          ]
      )