{-# 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.DateDimensionField
-- 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.DateDimensionField 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.ColumnIdentifier
import Amazonka.QuickSight.Types.DateTimeFormatConfiguration
import Amazonka.QuickSight.Types.TimeGranularity

-- | The dimension type field with date type columns.
--
-- /See:/ 'newDateDimensionField' smart constructor.
data DateDimensionField = DateDimensionField'
  { -- | The date granularity of the @DateDimensionField@. Choose one of the
    -- following options:
    --
    -- -   @YEAR@
    --
    -- -   @QUARTER@
    --
    -- -   @MONTH@
    --
    -- -   @WEEK@
    --
    -- -   @DAY@
    --
    -- -   @HOUR@
    --
    -- -   @MINUTE@
    --
    -- -   @SECOND@
    --
    -- -   @MILLISECOND@
    DateDimensionField -> Maybe TimeGranularity
dateGranularity :: Prelude.Maybe TimeGranularity,
    -- | The format configuration of the field.
    DateDimensionField -> Maybe DateTimeFormatConfiguration
formatConfiguration :: Prelude.Maybe DateTimeFormatConfiguration,
    -- | The custom hierarchy ID.
    DateDimensionField -> Maybe Text
hierarchyId :: Prelude.Maybe Prelude.Text,
    -- | The custom field ID.
    DateDimensionField -> Text
fieldId :: Prelude.Text,
    -- | The column that is used in the @DateDimensionField@.
    DateDimensionField -> ColumnIdentifier
column :: ColumnIdentifier
  }
  deriving (DateDimensionField -> DateDimensionField -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DateDimensionField -> DateDimensionField -> Bool
$c/= :: DateDimensionField -> DateDimensionField -> Bool
== :: DateDimensionField -> DateDimensionField -> Bool
$c== :: DateDimensionField -> DateDimensionField -> Bool
Prelude.Eq, Int -> DateDimensionField -> ShowS
[DateDimensionField] -> ShowS
DateDimensionField -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DateDimensionField] -> ShowS
$cshowList :: [DateDimensionField] -> ShowS
show :: DateDimensionField -> String
$cshow :: DateDimensionField -> String
showsPrec :: Int -> DateDimensionField -> ShowS
$cshowsPrec :: Int -> DateDimensionField -> ShowS
Prelude.Show, forall x. Rep DateDimensionField x -> DateDimensionField
forall x. DateDimensionField -> Rep DateDimensionField x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DateDimensionField x -> DateDimensionField
$cfrom :: forall x. DateDimensionField -> Rep DateDimensionField x
Prelude.Generic)

-- |
-- Create a value of 'DateDimensionField' 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:
--
-- 'dateGranularity', 'dateDimensionField_dateGranularity' - The date granularity of the @DateDimensionField@. Choose one of the
-- following options:
--
-- -   @YEAR@
--
-- -   @QUARTER@
--
-- -   @MONTH@
--
-- -   @WEEK@
--
-- -   @DAY@
--
-- -   @HOUR@
--
-- -   @MINUTE@
--
-- -   @SECOND@
--
-- -   @MILLISECOND@
--
-- 'formatConfiguration', 'dateDimensionField_formatConfiguration' - The format configuration of the field.
--
-- 'hierarchyId', 'dateDimensionField_hierarchyId' - The custom hierarchy ID.
--
-- 'fieldId', 'dateDimensionField_fieldId' - The custom field ID.
--
-- 'column', 'dateDimensionField_column' - The column that is used in the @DateDimensionField@.
newDateDimensionField ::
  -- | 'fieldId'
  Prelude.Text ->
  -- | 'column'
  ColumnIdentifier ->
  DateDimensionField
newDateDimensionField :: Text -> ColumnIdentifier -> DateDimensionField
newDateDimensionField Text
pFieldId_ ColumnIdentifier
pColumn_ =
  DateDimensionField'
    { $sel:dateGranularity:DateDimensionField' :: Maybe TimeGranularity
dateGranularity =
        forall a. Maybe a
Prelude.Nothing,
      $sel:formatConfiguration:DateDimensionField' :: Maybe DateTimeFormatConfiguration
formatConfiguration = forall a. Maybe a
Prelude.Nothing,
      $sel:hierarchyId:DateDimensionField' :: Maybe Text
hierarchyId = forall a. Maybe a
Prelude.Nothing,
      $sel:fieldId:DateDimensionField' :: Text
fieldId = Text
pFieldId_,
      $sel:column:DateDimensionField' :: ColumnIdentifier
column = ColumnIdentifier
pColumn_
    }

-- | The date granularity of the @DateDimensionField@. Choose one of the
-- following options:
--
-- -   @YEAR@
--
-- -   @QUARTER@
--
-- -   @MONTH@
--
-- -   @WEEK@
--
-- -   @DAY@
--
-- -   @HOUR@
--
-- -   @MINUTE@
--
-- -   @SECOND@
--
-- -   @MILLISECOND@
dateDimensionField_dateGranularity :: Lens.Lens' DateDimensionField (Prelude.Maybe TimeGranularity)
dateDimensionField_dateGranularity :: Lens' DateDimensionField (Maybe TimeGranularity)
dateDimensionField_dateGranularity = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DateDimensionField' {Maybe TimeGranularity
dateGranularity :: Maybe TimeGranularity
$sel:dateGranularity:DateDimensionField' :: DateDimensionField -> Maybe TimeGranularity
dateGranularity} -> Maybe TimeGranularity
dateGranularity) (\s :: DateDimensionField
s@DateDimensionField' {} Maybe TimeGranularity
a -> DateDimensionField
s {$sel:dateGranularity:DateDimensionField' :: Maybe TimeGranularity
dateGranularity = Maybe TimeGranularity
a} :: DateDimensionField)

-- | The format configuration of the field.
dateDimensionField_formatConfiguration :: Lens.Lens' DateDimensionField (Prelude.Maybe DateTimeFormatConfiguration)
dateDimensionField_formatConfiguration :: Lens' DateDimensionField (Maybe DateTimeFormatConfiguration)
dateDimensionField_formatConfiguration = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DateDimensionField' {Maybe DateTimeFormatConfiguration
formatConfiguration :: Maybe DateTimeFormatConfiguration
$sel:formatConfiguration:DateDimensionField' :: DateDimensionField -> Maybe DateTimeFormatConfiguration
formatConfiguration} -> Maybe DateTimeFormatConfiguration
formatConfiguration) (\s :: DateDimensionField
s@DateDimensionField' {} Maybe DateTimeFormatConfiguration
a -> DateDimensionField
s {$sel:formatConfiguration:DateDimensionField' :: Maybe DateTimeFormatConfiguration
formatConfiguration = Maybe DateTimeFormatConfiguration
a} :: DateDimensionField)

-- | The custom hierarchy ID.
dateDimensionField_hierarchyId :: Lens.Lens' DateDimensionField (Prelude.Maybe Prelude.Text)
dateDimensionField_hierarchyId :: Lens' DateDimensionField (Maybe Text)
dateDimensionField_hierarchyId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DateDimensionField' {Maybe Text
hierarchyId :: Maybe Text
$sel:hierarchyId:DateDimensionField' :: DateDimensionField -> Maybe Text
hierarchyId} -> Maybe Text
hierarchyId) (\s :: DateDimensionField
s@DateDimensionField' {} Maybe Text
a -> DateDimensionField
s {$sel:hierarchyId:DateDimensionField' :: Maybe Text
hierarchyId = Maybe Text
a} :: DateDimensionField)

-- | The custom field ID.
dateDimensionField_fieldId :: Lens.Lens' DateDimensionField Prelude.Text
dateDimensionField_fieldId :: Lens' DateDimensionField Text
dateDimensionField_fieldId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DateDimensionField' {Text
fieldId :: Text
$sel:fieldId:DateDimensionField' :: DateDimensionField -> Text
fieldId} -> Text
fieldId) (\s :: DateDimensionField
s@DateDimensionField' {} Text
a -> DateDimensionField
s {$sel:fieldId:DateDimensionField' :: Text
fieldId = Text
a} :: DateDimensionField)

-- | The column that is used in the @DateDimensionField@.
dateDimensionField_column :: Lens.Lens' DateDimensionField ColumnIdentifier
dateDimensionField_column :: Lens' DateDimensionField ColumnIdentifier
dateDimensionField_column = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DateDimensionField' {ColumnIdentifier
column :: ColumnIdentifier
$sel:column:DateDimensionField' :: DateDimensionField -> ColumnIdentifier
column} -> ColumnIdentifier
column) (\s :: DateDimensionField
s@DateDimensionField' {} ColumnIdentifier
a -> DateDimensionField
s {$sel:column:DateDimensionField' :: ColumnIdentifier
column = ColumnIdentifier
a} :: DateDimensionField)

instance Data.FromJSON DateDimensionField where
  parseJSON :: Value -> Parser DateDimensionField
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"DateDimensionField"
      ( \Object
x ->
          Maybe TimeGranularity
-> Maybe DateTimeFormatConfiguration
-> Maybe Text
-> Text
-> ColumnIdentifier
-> DateDimensionField
DateDimensionField'
            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
"DateGranularity")
            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
"FormatConfiguration")
            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
"HierarchyId")
            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
"FieldId")
            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
"Column")
      )

instance Prelude.Hashable DateDimensionField where
  hashWithSalt :: Int -> DateDimensionField -> Int
hashWithSalt Int
_salt DateDimensionField' {Maybe Text
Maybe TimeGranularity
Maybe DateTimeFormatConfiguration
Text
ColumnIdentifier
column :: ColumnIdentifier
fieldId :: Text
hierarchyId :: Maybe Text
formatConfiguration :: Maybe DateTimeFormatConfiguration
dateGranularity :: Maybe TimeGranularity
$sel:column:DateDimensionField' :: DateDimensionField -> ColumnIdentifier
$sel:fieldId:DateDimensionField' :: DateDimensionField -> Text
$sel:hierarchyId:DateDimensionField' :: DateDimensionField -> Maybe Text
$sel:formatConfiguration:DateDimensionField' :: DateDimensionField -> Maybe DateTimeFormatConfiguration
$sel:dateGranularity:DateDimensionField' :: DateDimensionField -> Maybe TimeGranularity
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe TimeGranularity
dateGranularity
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe DateTimeFormatConfiguration
formatConfiguration
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
hierarchyId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
fieldId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` ColumnIdentifier
column

instance Prelude.NFData DateDimensionField where
  rnf :: DateDimensionField -> ()
rnf DateDimensionField' {Maybe Text
Maybe TimeGranularity
Maybe DateTimeFormatConfiguration
Text
ColumnIdentifier
column :: ColumnIdentifier
fieldId :: Text
hierarchyId :: Maybe Text
formatConfiguration :: Maybe DateTimeFormatConfiguration
dateGranularity :: Maybe TimeGranularity
$sel:column:DateDimensionField' :: DateDimensionField -> ColumnIdentifier
$sel:fieldId:DateDimensionField' :: DateDimensionField -> Text
$sel:hierarchyId:DateDimensionField' :: DateDimensionField -> Maybe Text
$sel:formatConfiguration:DateDimensionField' :: DateDimensionField -> Maybe DateTimeFormatConfiguration
$sel:dateGranularity:DateDimensionField' :: DateDimensionField -> Maybe TimeGranularity
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe TimeGranularity
dateGranularity
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe DateTimeFormatConfiguration
formatConfiguration
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
hierarchyId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
fieldId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf ColumnIdentifier
column

instance Data.ToJSON DateDimensionField where
  toJSON :: DateDimensionField -> Value
toJSON DateDimensionField' {Maybe Text
Maybe TimeGranularity
Maybe DateTimeFormatConfiguration
Text
ColumnIdentifier
column :: ColumnIdentifier
fieldId :: Text
hierarchyId :: Maybe Text
formatConfiguration :: Maybe DateTimeFormatConfiguration
dateGranularity :: Maybe TimeGranularity
$sel:column:DateDimensionField' :: DateDimensionField -> ColumnIdentifier
$sel:fieldId:DateDimensionField' :: DateDimensionField -> Text
$sel:hierarchyId:DateDimensionField' :: DateDimensionField -> Maybe Text
$sel:formatConfiguration:DateDimensionField' :: DateDimensionField -> Maybe DateTimeFormatConfiguration
$sel:dateGranularity:DateDimensionField' :: DateDimensionField -> Maybe TimeGranularity
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"DateGranularity" 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 TimeGranularity
dateGranularity,
            (Key
"FormatConfiguration" 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 DateTimeFormatConfiguration
formatConfiguration,
            (Key
"HierarchyId" 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
hierarchyId,
            forall a. a -> Maybe a
Prelude.Just (Key
"FieldId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
fieldId),
            forall a. a -> Maybe a
Prelude.Just (Key
"Column" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= ColumnIdentifier
column)
          ]
      )