{-# 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.CalculatedColumn
-- 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.CalculatedColumn 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

-- | A calculated column for a dataset.
--
-- /See:/ 'newCalculatedColumn' smart constructor.
data CalculatedColumn = CalculatedColumn'
  { -- | Column name.
    CalculatedColumn -> Text
columnName :: Prelude.Text,
    -- | A unique ID to identify a calculated column. During a dataset update, if
    -- the column ID of a calculated column matches that of an existing
    -- calculated column, Amazon QuickSight preserves the existing calculated
    -- column.
    CalculatedColumn -> Text
columnId :: Prelude.Text,
    -- | An expression that defines the calculated column.
    CalculatedColumn -> Sensitive Text
expression :: Data.Sensitive Prelude.Text
  }
  deriving (CalculatedColumn -> CalculatedColumn -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CalculatedColumn -> CalculatedColumn -> Bool
$c/= :: CalculatedColumn -> CalculatedColumn -> Bool
== :: CalculatedColumn -> CalculatedColumn -> Bool
$c== :: CalculatedColumn -> CalculatedColumn -> Bool
Prelude.Eq, Int -> CalculatedColumn -> ShowS
[CalculatedColumn] -> ShowS
CalculatedColumn -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CalculatedColumn] -> ShowS
$cshowList :: [CalculatedColumn] -> ShowS
show :: CalculatedColumn -> String
$cshow :: CalculatedColumn -> String
showsPrec :: Int -> CalculatedColumn -> ShowS
$cshowsPrec :: Int -> CalculatedColumn -> ShowS
Prelude.Show, forall x. Rep CalculatedColumn x -> CalculatedColumn
forall x. CalculatedColumn -> Rep CalculatedColumn x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep CalculatedColumn x -> CalculatedColumn
$cfrom :: forall x. CalculatedColumn -> Rep CalculatedColumn x
Prelude.Generic)

-- |
-- Create a value of 'CalculatedColumn' 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:
--
-- 'columnName', 'calculatedColumn_columnName' - Column name.
--
-- 'columnId', 'calculatedColumn_columnId' - A unique ID to identify a calculated column. During a dataset update, if
-- the column ID of a calculated column matches that of an existing
-- calculated column, Amazon QuickSight preserves the existing calculated
-- column.
--
-- 'expression', 'calculatedColumn_expression' - An expression that defines the calculated column.
newCalculatedColumn ::
  -- | 'columnName'
  Prelude.Text ->
  -- | 'columnId'
  Prelude.Text ->
  -- | 'expression'
  Prelude.Text ->
  CalculatedColumn
newCalculatedColumn :: Text -> Text -> Text -> CalculatedColumn
newCalculatedColumn
  Text
pColumnName_
  Text
pColumnId_
  Text
pExpression_ =
    CalculatedColumn'
      { $sel:columnName:CalculatedColumn' :: Text
columnName = Text
pColumnName_,
        $sel:columnId:CalculatedColumn' :: Text
columnId = Text
pColumnId_,
        $sel:expression:CalculatedColumn' :: Sensitive Text
expression = forall a. Iso' (Sensitive a) a
Data._Sensitive forall t b. AReview t b -> b -> t
Lens.# Text
pExpression_
      }

-- | Column name.
calculatedColumn_columnName :: Lens.Lens' CalculatedColumn Prelude.Text
calculatedColumn_columnName :: Lens' CalculatedColumn Text
calculatedColumn_columnName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CalculatedColumn' {Text
columnName :: Text
$sel:columnName:CalculatedColumn' :: CalculatedColumn -> Text
columnName} -> Text
columnName) (\s :: CalculatedColumn
s@CalculatedColumn' {} Text
a -> CalculatedColumn
s {$sel:columnName:CalculatedColumn' :: Text
columnName = Text
a} :: CalculatedColumn)

-- | A unique ID to identify a calculated column. During a dataset update, if
-- the column ID of a calculated column matches that of an existing
-- calculated column, Amazon QuickSight preserves the existing calculated
-- column.
calculatedColumn_columnId :: Lens.Lens' CalculatedColumn Prelude.Text
calculatedColumn_columnId :: Lens' CalculatedColumn Text
calculatedColumn_columnId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CalculatedColumn' {Text
columnId :: Text
$sel:columnId:CalculatedColumn' :: CalculatedColumn -> Text
columnId} -> Text
columnId) (\s :: CalculatedColumn
s@CalculatedColumn' {} Text
a -> CalculatedColumn
s {$sel:columnId:CalculatedColumn' :: Text
columnId = Text
a} :: CalculatedColumn)

-- | An expression that defines the calculated column.
calculatedColumn_expression :: Lens.Lens' CalculatedColumn Prelude.Text
calculatedColumn_expression :: Lens' CalculatedColumn Text
calculatedColumn_expression = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CalculatedColumn' {Sensitive Text
expression :: Sensitive Text
$sel:expression:CalculatedColumn' :: CalculatedColumn -> Sensitive Text
expression} -> Sensitive Text
expression) (\s :: CalculatedColumn
s@CalculatedColumn' {} Sensitive Text
a -> CalculatedColumn
s {$sel:expression:CalculatedColumn' :: Sensitive Text
expression = Sensitive Text
a} :: CalculatedColumn) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a. Iso' (Sensitive a) a
Data._Sensitive

instance Data.FromJSON CalculatedColumn where
  parseJSON :: Value -> Parser CalculatedColumn
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"CalculatedColumn"
      ( \Object
x ->
          Text -> Text -> Sensitive Text -> CalculatedColumn
CalculatedColumn'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"ColumnName")
            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
"ColumnId")
            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
"Expression")
      )

instance Prelude.Hashable CalculatedColumn where
  hashWithSalt :: Int -> CalculatedColumn -> Int
hashWithSalt Int
_salt CalculatedColumn' {Text
Sensitive Text
expression :: Sensitive Text
columnId :: Text
columnName :: Text
$sel:expression:CalculatedColumn' :: CalculatedColumn -> Sensitive Text
$sel:columnId:CalculatedColumn' :: CalculatedColumn -> Text
$sel:columnName:CalculatedColumn' :: CalculatedColumn -> Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
columnName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
columnId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Sensitive Text
expression

instance Prelude.NFData CalculatedColumn where
  rnf :: CalculatedColumn -> ()
rnf CalculatedColumn' {Text
Sensitive Text
expression :: Sensitive Text
columnId :: Text
columnName :: Text
$sel:expression:CalculatedColumn' :: CalculatedColumn -> Sensitive Text
$sel:columnId:CalculatedColumn' :: CalculatedColumn -> Text
$sel:columnName:CalculatedColumn' :: CalculatedColumn -> Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Text
columnName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
columnId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Sensitive Text
expression

instance Data.ToJSON CalculatedColumn where
  toJSON :: CalculatedColumn -> Value
toJSON CalculatedColumn' {Text
Sensitive Text
expression :: Sensitive Text
columnId :: Text
columnName :: Text
$sel:expression:CalculatedColumn' :: CalculatedColumn -> Sensitive Text
$sel:columnId:CalculatedColumn' :: CalculatedColumn -> Text
$sel:columnName:CalculatedColumn' :: CalculatedColumn -> Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just (Key
"ColumnName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
columnName),
            forall a. a -> Maybe a
Prelude.Just (Key
"ColumnId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
columnId),
            forall a. a -> Maybe a
Prelude.Just (Key
"Expression" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Sensitive Text
expression)
          ]
      )