{-# 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.ParameterControl
-- 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.ParameterControl 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.ParameterDateTimePickerControl
import Amazonka.QuickSight.Types.ParameterDropDownControl
import Amazonka.QuickSight.Types.ParameterListControl
import Amazonka.QuickSight.Types.ParameterSliderControl
import Amazonka.QuickSight.Types.ParameterTextAreaControl
import Amazonka.QuickSight.Types.ParameterTextFieldControl

-- | The control of a parameter that users can interact with in a dashboard
-- or an analysis.
--
-- This is a union type structure. For this structure to be valid, only one
-- of the attributes can be defined.
--
-- /See:/ 'newParameterControl' smart constructor.
data ParameterControl = ParameterControl'
  { -- | A control from a date parameter that specifies date and time.
    ParameterControl -> Maybe ParameterDateTimePickerControl
dateTimePicker :: Prelude.Maybe ParameterDateTimePickerControl,
    -- | A control to display a dropdown list with buttons that are used to
    -- select a single value.
    ParameterControl -> Maybe ParameterDropDownControl
dropdown :: Prelude.Maybe ParameterDropDownControl,
    -- | A control to display a list with buttons or boxes that are used to
    -- select either a single value or multiple values.
    ParameterControl -> Maybe ParameterListControl
list :: Prelude.Maybe ParameterListControl,
    -- | A control to display a horizontal toggle bar. This is used to change a
    -- value by sliding the toggle.
    ParameterControl -> Maybe ParameterSliderControl
slider :: Prelude.Maybe ParameterSliderControl,
    -- | A control to display a text box that is used to enter multiple entries.
    ParameterControl -> Maybe ParameterTextAreaControl
textArea :: Prelude.Maybe ParameterTextAreaControl,
    -- | A control to display a text box that is used to enter a single entry.
    ParameterControl -> Maybe ParameterTextFieldControl
textField :: Prelude.Maybe ParameterTextFieldControl
  }
  deriving (ParameterControl -> ParameterControl -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ParameterControl -> ParameterControl -> Bool
$c/= :: ParameterControl -> ParameterControl -> Bool
== :: ParameterControl -> ParameterControl -> Bool
$c== :: ParameterControl -> ParameterControl -> Bool
Prelude.Eq, ReadPrec [ParameterControl]
ReadPrec ParameterControl
Int -> ReadS ParameterControl
ReadS [ParameterControl]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ParameterControl]
$creadListPrec :: ReadPrec [ParameterControl]
readPrec :: ReadPrec ParameterControl
$creadPrec :: ReadPrec ParameterControl
readList :: ReadS [ParameterControl]
$creadList :: ReadS [ParameterControl]
readsPrec :: Int -> ReadS ParameterControl
$creadsPrec :: Int -> ReadS ParameterControl
Prelude.Read, Int -> ParameterControl -> ShowS
[ParameterControl] -> ShowS
ParameterControl -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ParameterControl] -> ShowS
$cshowList :: [ParameterControl] -> ShowS
show :: ParameterControl -> String
$cshow :: ParameterControl -> String
showsPrec :: Int -> ParameterControl -> ShowS
$cshowsPrec :: Int -> ParameterControl -> ShowS
Prelude.Show, forall x. Rep ParameterControl x -> ParameterControl
forall x. ParameterControl -> Rep ParameterControl x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ParameterControl x -> ParameterControl
$cfrom :: forall x. ParameterControl -> Rep ParameterControl x
Prelude.Generic)

-- |
-- Create a value of 'ParameterControl' 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:
--
-- 'dateTimePicker', 'parameterControl_dateTimePicker' - A control from a date parameter that specifies date and time.
--
-- 'dropdown', 'parameterControl_dropdown' - A control to display a dropdown list with buttons that are used to
-- select a single value.
--
-- 'list', 'parameterControl_list' - A control to display a list with buttons or boxes that are used to
-- select either a single value or multiple values.
--
-- 'slider', 'parameterControl_slider' - A control to display a horizontal toggle bar. This is used to change a
-- value by sliding the toggle.
--
-- 'textArea', 'parameterControl_textArea' - A control to display a text box that is used to enter multiple entries.
--
-- 'textField', 'parameterControl_textField' - A control to display a text box that is used to enter a single entry.
newParameterControl ::
  ParameterControl
newParameterControl :: ParameterControl
newParameterControl =
  ParameterControl'
    { $sel:dateTimePicker:ParameterControl' :: Maybe ParameterDateTimePickerControl
dateTimePicker = forall a. Maybe a
Prelude.Nothing,
      $sel:dropdown:ParameterControl' :: Maybe ParameterDropDownControl
dropdown = forall a. Maybe a
Prelude.Nothing,
      $sel:list:ParameterControl' :: Maybe ParameterListControl
list = forall a. Maybe a
Prelude.Nothing,
      $sel:slider:ParameterControl' :: Maybe ParameterSliderControl
slider = forall a. Maybe a
Prelude.Nothing,
      $sel:textArea:ParameterControl' :: Maybe ParameterTextAreaControl
textArea = forall a. Maybe a
Prelude.Nothing,
      $sel:textField:ParameterControl' :: Maybe ParameterTextFieldControl
textField = forall a. Maybe a
Prelude.Nothing
    }

-- | A control from a date parameter that specifies date and time.
parameterControl_dateTimePicker :: Lens.Lens' ParameterControl (Prelude.Maybe ParameterDateTimePickerControl)
parameterControl_dateTimePicker :: Lens' ParameterControl (Maybe ParameterDateTimePickerControl)
parameterControl_dateTimePicker = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ParameterControl' {Maybe ParameterDateTimePickerControl
dateTimePicker :: Maybe ParameterDateTimePickerControl
$sel:dateTimePicker:ParameterControl' :: ParameterControl -> Maybe ParameterDateTimePickerControl
dateTimePicker} -> Maybe ParameterDateTimePickerControl
dateTimePicker) (\s :: ParameterControl
s@ParameterControl' {} Maybe ParameterDateTimePickerControl
a -> ParameterControl
s {$sel:dateTimePicker:ParameterControl' :: Maybe ParameterDateTimePickerControl
dateTimePicker = Maybe ParameterDateTimePickerControl
a} :: ParameterControl)

-- | A control to display a dropdown list with buttons that are used to
-- select a single value.
parameterControl_dropdown :: Lens.Lens' ParameterControl (Prelude.Maybe ParameterDropDownControl)
parameterControl_dropdown :: Lens' ParameterControl (Maybe ParameterDropDownControl)
parameterControl_dropdown = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ParameterControl' {Maybe ParameterDropDownControl
dropdown :: Maybe ParameterDropDownControl
$sel:dropdown:ParameterControl' :: ParameterControl -> Maybe ParameterDropDownControl
dropdown} -> Maybe ParameterDropDownControl
dropdown) (\s :: ParameterControl
s@ParameterControl' {} Maybe ParameterDropDownControl
a -> ParameterControl
s {$sel:dropdown:ParameterControl' :: Maybe ParameterDropDownControl
dropdown = Maybe ParameterDropDownControl
a} :: ParameterControl)

-- | A control to display a list with buttons or boxes that are used to
-- select either a single value or multiple values.
parameterControl_list :: Lens.Lens' ParameterControl (Prelude.Maybe ParameterListControl)
parameterControl_list :: Lens' ParameterControl (Maybe ParameterListControl)
parameterControl_list = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ParameterControl' {Maybe ParameterListControl
list :: Maybe ParameterListControl
$sel:list:ParameterControl' :: ParameterControl -> Maybe ParameterListControl
list} -> Maybe ParameterListControl
list) (\s :: ParameterControl
s@ParameterControl' {} Maybe ParameterListControl
a -> ParameterControl
s {$sel:list:ParameterControl' :: Maybe ParameterListControl
list = Maybe ParameterListControl
a} :: ParameterControl)

-- | A control to display a horizontal toggle bar. This is used to change a
-- value by sliding the toggle.
parameterControl_slider :: Lens.Lens' ParameterControl (Prelude.Maybe ParameterSliderControl)
parameterControl_slider :: Lens' ParameterControl (Maybe ParameterSliderControl)
parameterControl_slider = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ParameterControl' {Maybe ParameterSliderControl
slider :: Maybe ParameterSliderControl
$sel:slider:ParameterControl' :: ParameterControl -> Maybe ParameterSliderControl
slider} -> Maybe ParameterSliderControl
slider) (\s :: ParameterControl
s@ParameterControl' {} Maybe ParameterSliderControl
a -> ParameterControl
s {$sel:slider:ParameterControl' :: Maybe ParameterSliderControl
slider = Maybe ParameterSliderControl
a} :: ParameterControl)

-- | A control to display a text box that is used to enter multiple entries.
parameterControl_textArea :: Lens.Lens' ParameterControl (Prelude.Maybe ParameterTextAreaControl)
parameterControl_textArea :: Lens' ParameterControl (Maybe ParameterTextAreaControl)
parameterControl_textArea = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ParameterControl' {Maybe ParameterTextAreaControl
textArea :: Maybe ParameterTextAreaControl
$sel:textArea:ParameterControl' :: ParameterControl -> Maybe ParameterTextAreaControl
textArea} -> Maybe ParameterTextAreaControl
textArea) (\s :: ParameterControl
s@ParameterControl' {} Maybe ParameterTextAreaControl
a -> ParameterControl
s {$sel:textArea:ParameterControl' :: Maybe ParameterTextAreaControl
textArea = Maybe ParameterTextAreaControl
a} :: ParameterControl)

-- | A control to display a text box that is used to enter a single entry.
parameterControl_textField :: Lens.Lens' ParameterControl (Prelude.Maybe ParameterTextFieldControl)
parameterControl_textField :: Lens' ParameterControl (Maybe ParameterTextFieldControl)
parameterControl_textField = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ParameterControl' {Maybe ParameterTextFieldControl
textField :: Maybe ParameterTextFieldControl
$sel:textField:ParameterControl' :: ParameterControl -> Maybe ParameterTextFieldControl
textField} -> Maybe ParameterTextFieldControl
textField) (\s :: ParameterControl
s@ParameterControl' {} Maybe ParameterTextFieldControl
a -> ParameterControl
s {$sel:textField:ParameterControl' :: Maybe ParameterTextFieldControl
textField = Maybe ParameterTextFieldControl
a} :: ParameterControl)

instance Data.FromJSON ParameterControl where
  parseJSON :: Value -> Parser ParameterControl
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ParameterControl"
      ( \Object
x ->
          Maybe ParameterDateTimePickerControl
-> Maybe ParameterDropDownControl
-> Maybe ParameterListControl
-> Maybe ParameterSliderControl
-> Maybe ParameterTextAreaControl
-> Maybe ParameterTextFieldControl
-> ParameterControl
ParameterControl'
            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
"DateTimePicker")
            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
"Dropdown")
            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
"List")
            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
"Slider")
            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
"TextArea")
            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
"TextField")
      )

instance Prelude.Hashable ParameterControl where
  hashWithSalt :: Int -> ParameterControl -> Int
hashWithSalt Int
_salt ParameterControl' {Maybe ParameterTextFieldControl
Maybe ParameterTextAreaControl
Maybe ParameterSliderControl
Maybe ParameterListControl
Maybe ParameterDropDownControl
Maybe ParameterDateTimePickerControl
textField :: Maybe ParameterTextFieldControl
textArea :: Maybe ParameterTextAreaControl
slider :: Maybe ParameterSliderControl
list :: Maybe ParameterListControl
dropdown :: Maybe ParameterDropDownControl
dateTimePicker :: Maybe ParameterDateTimePickerControl
$sel:textField:ParameterControl' :: ParameterControl -> Maybe ParameterTextFieldControl
$sel:textArea:ParameterControl' :: ParameterControl -> Maybe ParameterTextAreaControl
$sel:slider:ParameterControl' :: ParameterControl -> Maybe ParameterSliderControl
$sel:list:ParameterControl' :: ParameterControl -> Maybe ParameterListControl
$sel:dropdown:ParameterControl' :: ParameterControl -> Maybe ParameterDropDownControl
$sel:dateTimePicker:ParameterControl' :: ParameterControl -> Maybe ParameterDateTimePickerControl
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ParameterDateTimePickerControl
dateTimePicker
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ParameterDropDownControl
dropdown
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ParameterListControl
list
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ParameterSliderControl
slider
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ParameterTextAreaControl
textArea
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ParameterTextFieldControl
textField

instance Prelude.NFData ParameterControl where
  rnf :: ParameterControl -> ()
rnf ParameterControl' {Maybe ParameterTextFieldControl
Maybe ParameterTextAreaControl
Maybe ParameterSliderControl
Maybe ParameterListControl
Maybe ParameterDropDownControl
Maybe ParameterDateTimePickerControl
textField :: Maybe ParameterTextFieldControl
textArea :: Maybe ParameterTextAreaControl
slider :: Maybe ParameterSliderControl
list :: Maybe ParameterListControl
dropdown :: Maybe ParameterDropDownControl
dateTimePicker :: Maybe ParameterDateTimePickerControl
$sel:textField:ParameterControl' :: ParameterControl -> Maybe ParameterTextFieldControl
$sel:textArea:ParameterControl' :: ParameterControl -> Maybe ParameterTextAreaControl
$sel:slider:ParameterControl' :: ParameterControl -> Maybe ParameterSliderControl
$sel:list:ParameterControl' :: ParameterControl -> Maybe ParameterListControl
$sel:dropdown:ParameterControl' :: ParameterControl -> Maybe ParameterDropDownControl
$sel:dateTimePicker:ParameterControl' :: ParameterControl -> Maybe ParameterDateTimePickerControl
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe ParameterDateTimePickerControl
dateTimePicker
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ParameterDropDownControl
dropdown
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ParameterListControl
list
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ParameterSliderControl
slider
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ParameterTextAreaControl
textArea
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ParameterTextFieldControl
textField

instance Data.ToJSON ParameterControl where
  toJSON :: ParameterControl -> Value
toJSON ParameterControl' {Maybe ParameterTextFieldControl
Maybe ParameterTextAreaControl
Maybe ParameterSliderControl
Maybe ParameterListControl
Maybe ParameterDropDownControl
Maybe ParameterDateTimePickerControl
textField :: Maybe ParameterTextFieldControl
textArea :: Maybe ParameterTextAreaControl
slider :: Maybe ParameterSliderControl
list :: Maybe ParameterListControl
dropdown :: Maybe ParameterDropDownControl
dateTimePicker :: Maybe ParameterDateTimePickerControl
$sel:textField:ParameterControl' :: ParameterControl -> Maybe ParameterTextFieldControl
$sel:textArea:ParameterControl' :: ParameterControl -> Maybe ParameterTextAreaControl
$sel:slider:ParameterControl' :: ParameterControl -> Maybe ParameterSliderControl
$sel:list:ParameterControl' :: ParameterControl -> Maybe ParameterListControl
$sel:dropdown:ParameterControl' :: ParameterControl -> Maybe ParameterDropDownControl
$sel:dateTimePicker:ParameterControl' :: ParameterControl -> Maybe ParameterDateTimePickerControl
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"DateTimePicker" 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 ParameterDateTimePickerControl
dateTimePicker,
            (Key
"Dropdown" 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 ParameterDropDownControl
dropdown,
            (Key
"List" 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 ParameterListControl
list,
            (Key
"Slider" 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 ParameterSliderControl
slider,
            (Key
"TextArea" 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 ParameterTextAreaControl
textArea,
            (Key
"TextField" 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 ParameterTextFieldControl
textField
          ]
      )