{-# 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.PivotTableFieldOption
-- 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.PivotTableFieldOption 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.Visibility

-- | The selected field options for the pivot table field options.
--
-- /See:/ 'newPivotTableFieldOption' smart constructor.
data PivotTableFieldOption = PivotTableFieldOption'
  { -- | The custom label of the pivot table field.
    PivotTableFieldOption -> Maybe Text
customLabel :: Prelude.Maybe Prelude.Text,
    -- | The visibility of the pivot table field.
    PivotTableFieldOption -> Maybe Visibility
visibility :: Prelude.Maybe Visibility,
    -- | The field ID of the pivot table field.
    PivotTableFieldOption -> Text
fieldId :: Prelude.Text
  }
  deriving (PivotTableFieldOption -> PivotTableFieldOption -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PivotTableFieldOption -> PivotTableFieldOption -> Bool
$c/= :: PivotTableFieldOption -> PivotTableFieldOption -> Bool
== :: PivotTableFieldOption -> PivotTableFieldOption -> Bool
$c== :: PivotTableFieldOption -> PivotTableFieldOption -> Bool
Prelude.Eq, ReadPrec [PivotTableFieldOption]
ReadPrec PivotTableFieldOption
Int -> ReadS PivotTableFieldOption
ReadS [PivotTableFieldOption]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [PivotTableFieldOption]
$creadListPrec :: ReadPrec [PivotTableFieldOption]
readPrec :: ReadPrec PivotTableFieldOption
$creadPrec :: ReadPrec PivotTableFieldOption
readList :: ReadS [PivotTableFieldOption]
$creadList :: ReadS [PivotTableFieldOption]
readsPrec :: Int -> ReadS PivotTableFieldOption
$creadsPrec :: Int -> ReadS PivotTableFieldOption
Prelude.Read, Int -> PivotTableFieldOption -> ShowS
[PivotTableFieldOption] -> ShowS
PivotTableFieldOption -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PivotTableFieldOption] -> ShowS
$cshowList :: [PivotTableFieldOption] -> ShowS
show :: PivotTableFieldOption -> String
$cshow :: PivotTableFieldOption -> String
showsPrec :: Int -> PivotTableFieldOption -> ShowS
$cshowsPrec :: Int -> PivotTableFieldOption -> ShowS
Prelude.Show, forall x. Rep PivotTableFieldOption x -> PivotTableFieldOption
forall x. PivotTableFieldOption -> Rep PivotTableFieldOption x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep PivotTableFieldOption x -> PivotTableFieldOption
$cfrom :: forall x. PivotTableFieldOption -> Rep PivotTableFieldOption x
Prelude.Generic)

-- |
-- Create a value of 'PivotTableFieldOption' 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:
--
-- 'customLabel', 'pivotTableFieldOption_customLabel' - The custom label of the pivot table field.
--
-- 'visibility', 'pivotTableFieldOption_visibility' - The visibility of the pivot table field.
--
-- 'fieldId', 'pivotTableFieldOption_fieldId' - The field ID of the pivot table field.
newPivotTableFieldOption ::
  -- | 'fieldId'
  Prelude.Text ->
  PivotTableFieldOption
newPivotTableFieldOption :: Text -> PivotTableFieldOption
newPivotTableFieldOption Text
pFieldId_ =
  PivotTableFieldOption'
    { $sel:customLabel:PivotTableFieldOption' :: Maybe Text
customLabel =
        forall a. Maybe a
Prelude.Nothing,
      $sel:visibility:PivotTableFieldOption' :: Maybe Visibility
visibility = forall a. Maybe a
Prelude.Nothing,
      $sel:fieldId:PivotTableFieldOption' :: Text
fieldId = Text
pFieldId_
    }

-- | The custom label of the pivot table field.
pivotTableFieldOption_customLabel :: Lens.Lens' PivotTableFieldOption (Prelude.Maybe Prelude.Text)
pivotTableFieldOption_customLabel :: Lens' PivotTableFieldOption (Maybe Text)
pivotTableFieldOption_customLabel = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PivotTableFieldOption' {Maybe Text
customLabel :: Maybe Text
$sel:customLabel:PivotTableFieldOption' :: PivotTableFieldOption -> Maybe Text
customLabel} -> Maybe Text
customLabel) (\s :: PivotTableFieldOption
s@PivotTableFieldOption' {} Maybe Text
a -> PivotTableFieldOption
s {$sel:customLabel:PivotTableFieldOption' :: Maybe Text
customLabel = Maybe Text
a} :: PivotTableFieldOption)

-- | The visibility of the pivot table field.
pivotTableFieldOption_visibility :: Lens.Lens' PivotTableFieldOption (Prelude.Maybe Visibility)
pivotTableFieldOption_visibility :: Lens' PivotTableFieldOption (Maybe Visibility)
pivotTableFieldOption_visibility = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PivotTableFieldOption' {Maybe Visibility
visibility :: Maybe Visibility
$sel:visibility:PivotTableFieldOption' :: PivotTableFieldOption -> Maybe Visibility
visibility} -> Maybe Visibility
visibility) (\s :: PivotTableFieldOption
s@PivotTableFieldOption' {} Maybe Visibility
a -> PivotTableFieldOption
s {$sel:visibility:PivotTableFieldOption' :: Maybe Visibility
visibility = Maybe Visibility
a} :: PivotTableFieldOption)

-- | The field ID of the pivot table field.
pivotTableFieldOption_fieldId :: Lens.Lens' PivotTableFieldOption Prelude.Text
pivotTableFieldOption_fieldId :: Lens' PivotTableFieldOption Text
pivotTableFieldOption_fieldId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PivotTableFieldOption' {Text
fieldId :: Text
$sel:fieldId:PivotTableFieldOption' :: PivotTableFieldOption -> Text
fieldId} -> Text
fieldId) (\s :: PivotTableFieldOption
s@PivotTableFieldOption' {} Text
a -> PivotTableFieldOption
s {$sel:fieldId:PivotTableFieldOption' :: Text
fieldId = Text
a} :: PivotTableFieldOption)

instance Data.FromJSON PivotTableFieldOption where
  parseJSON :: Value -> Parser PivotTableFieldOption
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"PivotTableFieldOption"
      ( \Object
x ->
          Maybe Text -> Maybe Visibility -> Text -> PivotTableFieldOption
PivotTableFieldOption'
            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
"CustomLabel")
            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
"Visibility")
            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")
      )

instance Prelude.Hashable PivotTableFieldOption where
  hashWithSalt :: Int -> PivotTableFieldOption -> Int
hashWithSalt Int
_salt PivotTableFieldOption' {Maybe Text
Maybe Visibility
Text
fieldId :: Text
visibility :: Maybe Visibility
customLabel :: Maybe Text
$sel:fieldId:PivotTableFieldOption' :: PivotTableFieldOption -> Text
$sel:visibility:PivotTableFieldOption' :: PivotTableFieldOption -> Maybe Visibility
$sel:customLabel:PivotTableFieldOption' :: PivotTableFieldOption -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
customLabel
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Visibility
visibility
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
fieldId

instance Prelude.NFData PivotTableFieldOption where
  rnf :: PivotTableFieldOption -> ()
rnf PivotTableFieldOption' {Maybe Text
Maybe Visibility
Text
fieldId :: Text
visibility :: Maybe Visibility
customLabel :: Maybe Text
$sel:fieldId:PivotTableFieldOption' :: PivotTableFieldOption -> Text
$sel:visibility:PivotTableFieldOption' :: PivotTableFieldOption -> Maybe Visibility
$sel:customLabel:PivotTableFieldOption' :: PivotTableFieldOption -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
customLabel
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Visibility
visibility
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
fieldId

instance Data.ToJSON PivotTableFieldOption where
  toJSON :: PivotTableFieldOption -> Value
toJSON PivotTableFieldOption' {Maybe Text
Maybe Visibility
Text
fieldId :: Text
visibility :: Maybe Visibility
customLabel :: Maybe Text
$sel:fieldId:PivotTableFieldOption' :: PivotTableFieldOption -> Text
$sel:visibility:PivotTableFieldOption' :: PivotTableFieldOption -> Maybe Visibility
$sel:customLabel:PivotTableFieldOption' :: PivotTableFieldOption -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"CustomLabel" 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
customLabel,
            (Key
"Visibility" 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 Visibility
visibility,
            forall a. a -> Maybe a
Prelude.Just (Key
"FieldId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
fieldId)
          ]
      )