{-# 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.CategoricalDimensionField
-- 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.CategoricalDimensionField 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.StringFormatConfiguration

-- | The dimension type field with categorical type columns..
--
-- /See:/ 'newCategoricalDimensionField' smart constructor.
data CategoricalDimensionField = CategoricalDimensionField'
  { -- | The format configuration of the field.
    CategoricalDimensionField -> Maybe StringFormatConfiguration
formatConfiguration :: Prelude.Maybe StringFormatConfiguration,
    -- | The custom hierarchy ID.
    CategoricalDimensionField -> Maybe Text
hierarchyId :: Prelude.Maybe Prelude.Text,
    -- | The custom field ID.
    CategoricalDimensionField -> Text
fieldId :: Prelude.Text,
    -- | The column that is used in the @CategoricalDimensionField@.
    CategoricalDimensionField -> ColumnIdentifier
column :: ColumnIdentifier
  }
  deriving (CategoricalDimensionField -> CategoricalDimensionField -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CategoricalDimensionField -> CategoricalDimensionField -> Bool
$c/= :: CategoricalDimensionField -> CategoricalDimensionField -> Bool
== :: CategoricalDimensionField -> CategoricalDimensionField -> Bool
$c== :: CategoricalDimensionField -> CategoricalDimensionField -> Bool
Prelude.Eq, Int -> CategoricalDimensionField -> ShowS
[CategoricalDimensionField] -> ShowS
CategoricalDimensionField -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CategoricalDimensionField] -> ShowS
$cshowList :: [CategoricalDimensionField] -> ShowS
show :: CategoricalDimensionField -> String
$cshow :: CategoricalDimensionField -> String
showsPrec :: Int -> CategoricalDimensionField -> ShowS
$cshowsPrec :: Int -> CategoricalDimensionField -> ShowS
Prelude.Show, forall x.
Rep CategoricalDimensionField x -> CategoricalDimensionField
forall x.
CategoricalDimensionField -> Rep CategoricalDimensionField x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep CategoricalDimensionField x -> CategoricalDimensionField
$cfrom :: forall x.
CategoricalDimensionField -> Rep CategoricalDimensionField x
Prelude.Generic)

-- |
-- Create a value of 'CategoricalDimensionField' 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:
--
-- 'formatConfiguration', 'categoricalDimensionField_formatConfiguration' - The format configuration of the field.
--
-- 'hierarchyId', 'categoricalDimensionField_hierarchyId' - The custom hierarchy ID.
--
-- 'fieldId', 'categoricalDimensionField_fieldId' - The custom field ID.
--
-- 'column', 'categoricalDimensionField_column' - The column that is used in the @CategoricalDimensionField@.
newCategoricalDimensionField ::
  -- | 'fieldId'
  Prelude.Text ->
  -- | 'column'
  ColumnIdentifier ->
  CategoricalDimensionField
newCategoricalDimensionField :: Text -> ColumnIdentifier -> CategoricalDimensionField
newCategoricalDimensionField Text
pFieldId_ ColumnIdentifier
pColumn_ =
  CategoricalDimensionField'
    { $sel:formatConfiguration:CategoricalDimensionField' :: Maybe StringFormatConfiguration
formatConfiguration =
        forall a. Maybe a
Prelude.Nothing,
      $sel:hierarchyId:CategoricalDimensionField' :: Maybe Text
hierarchyId = forall a. Maybe a
Prelude.Nothing,
      $sel:fieldId:CategoricalDimensionField' :: Text
fieldId = Text
pFieldId_,
      $sel:column:CategoricalDimensionField' :: ColumnIdentifier
column = ColumnIdentifier
pColumn_
    }

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

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

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

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

instance Data.FromJSON CategoricalDimensionField where
  parseJSON :: Value -> Parser CategoricalDimensionField
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"CategoricalDimensionField"
      ( \Object
x ->
          Maybe StringFormatConfiguration
-> Maybe Text
-> Text
-> ColumnIdentifier
-> CategoricalDimensionField
CategoricalDimensionField'
            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
"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 CategoricalDimensionField where
  hashWithSalt :: Int -> CategoricalDimensionField -> Int
hashWithSalt Int
_salt CategoricalDimensionField' {Maybe Text
Maybe StringFormatConfiguration
Text
ColumnIdentifier
column :: ColumnIdentifier
fieldId :: Text
hierarchyId :: Maybe Text
formatConfiguration :: Maybe StringFormatConfiguration
$sel:column:CategoricalDimensionField' :: CategoricalDimensionField -> ColumnIdentifier
$sel:fieldId:CategoricalDimensionField' :: CategoricalDimensionField -> Text
$sel:hierarchyId:CategoricalDimensionField' :: CategoricalDimensionField -> Maybe Text
$sel:formatConfiguration:CategoricalDimensionField' :: CategoricalDimensionField -> Maybe StringFormatConfiguration
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe StringFormatConfiguration
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 CategoricalDimensionField where
  rnf :: CategoricalDimensionField -> ()
rnf CategoricalDimensionField' {Maybe Text
Maybe StringFormatConfiguration
Text
ColumnIdentifier
column :: ColumnIdentifier
fieldId :: Text
hierarchyId :: Maybe Text
formatConfiguration :: Maybe StringFormatConfiguration
$sel:column:CategoricalDimensionField' :: CategoricalDimensionField -> ColumnIdentifier
$sel:fieldId:CategoricalDimensionField' :: CategoricalDimensionField -> Text
$sel:hierarchyId:CategoricalDimensionField' :: CategoricalDimensionField -> Maybe Text
$sel:formatConfiguration:CategoricalDimensionField' :: CategoricalDimensionField -> Maybe StringFormatConfiguration
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe StringFormatConfiguration
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 CategoricalDimensionField where
  toJSON :: CategoricalDimensionField -> Value
toJSON CategoricalDimensionField' {Maybe Text
Maybe StringFormatConfiguration
Text
ColumnIdentifier
column :: ColumnIdentifier
fieldId :: Text
hierarchyId :: Maybe Text
formatConfiguration :: Maybe StringFormatConfiguration
$sel:column:CategoricalDimensionField' :: CategoricalDimensionField -> ColumnIdentifier
$sel:fieldId:CategoricalDimensionField' :: CategoricalDimensionField -> Text
$sel:hierarchyId:CategoricalDimensionField' :: CategoricalDimensionField -> Maybe Text
$sel:formatConfiguration:CategoricalDimensionField' :: CategoricalDimensionField -> Maybe StringFormatConfiguration
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (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 StringFormatConfiguration
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)
          ]
      )