{-# 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.PivotFieldSortOptions
-- 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.PivotFieldSortOptions 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.PivotTableSortBy

-- | The field sort options for a pivot table sort configuration.
--
-- /See:/ 'newPivotFieldSortOptions' smart constructor.
data PivotFieldSortOptions = PivotFieldSortOptions'
  { -- | The field ID for the field sort options.
    PivotFieldSortOptions -> Text
fieldId :: Prelude.Text,
    -- | The sort by field for the field sort options.
    PivotFieldSortOptions -> PivotTableSortBy
sortBy :: PivotTableSortBy
  }
  deriving (PivotFieldSortOptions -> PivotFieldSortOptions -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PivotFieldSortOptions -> PivotFieldSortOptions -> Bool
$c/= :: PivotFieldSortOptions -> PivotFieldSortOptions -> Bool
== :: PivotFieldSortOptions -> PivotFieldSortOptions -> Bool
$c== :: PivotFieldSortOptions -> PivotFieldSortOptions -> Bool
Prelude.Eq, Int -> PivotFieldSortOptions -> ShowS
[PivotFieldSortOptions] -> ShowS
PivotFieldSortOptions -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PivotFieldSortOptions] -> ShowS
$cshowList :: [PivotFieldSortOptions] -> ShowS
show :: PivotFieldSortOptions -> String
$cshow :: PivotFieldSortOptions -> String
showsPrec :: Int -> PivotFieldSortOptions -> ShowS
$cshowsPrec :: Int -> PivotFieldSortOptions -> ShowS
Prelude.Show, forall x. Rep PivotFieldSortOptions x -> PivotFieldSortOptions
forall x. PivotFieldSortOptions -> Rep PivotFieldSortOptions x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep PivotFieldSortOptions x -> PivotFieldSortOptions
$cfrom :: forall x. PivotFieldSortOptions -> Rep PivotFieldSortOptions x
Prelude.Generic)

-- |
-- Create a value of 'PivotFieldSortOptions' 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:
--
-- 'fieldId', 'pivotFieldSortOptions_fieldId' - The field ID for the field sort options.
--
-- 'sortBy', 'pivotFieldSortOptions_sortBy' - The sort by field for the field sort options.
newPivotFieldSortOptions ::
  -- | 'fieldId'
  Prelude.Text ->
  -- | 'sortBy'
  PivotTableSortBy ->
  PivotFieldSortOptions
newPivotFieldSortOptions :: Text -> PivotTableSortBy -> PivotFieldSortOptions
newPivotFieldSortOptions Text
pFieldId_ PivotTableSortBy
pSortBy_ =
  PivotFieldSortOptions'
    { $sel:fieldId:PivotFieldSortOptions' :: Text
fieldId = Text
pFieldId_,
      $sel:sortBy:PivotFieldSortOptions' :: PivotTableSortBy
sortBy = PivotTableSortBy
pSortBy_
    }

-- | The field ID for the field sort options.
pivotFieldSortOptions_fieldId :: Lens.Lens' PivotFieldSortOptions Prelude.Text
pivotFieldSortOptions_fieldId :: Lens' PivotFieldSortOptions Text
pivotFieldSortOptions_fieldId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PivotFieldSortOptions' {Text
fieldId :: Text
$sel:fieldId:PivotFieldSortOptions' :: PivotFieldSortOptions -> Text
fieldId} -> Text
fieldId) (\s :: PivotFieldSortOptions
s@PivotFieldSortOptions' {} Text
a -> PivotFieldSortOptions
s {$sel:fieldId:PivotFieldSortOptions' :: Text
fieldId = Text
a} :: PivotFieldSortOptions)

-- | The sort by field for the field sort options.
pivotFieldSortOptions_sortBy :: Lens.Lens' PivotFieldSortOptions PivotTableSortBy
pivotFieldSortOptions_sortBy :: Lens' PivotFieldSortOptions PivotTableSortBy
pivotFieldSortOptions_sortBy = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PivotFieldSortOptions' {PivotTableSortBy
sortBy :: PivotTableSortBy
$sel:sortBy:PivotFieldSortOptions' :: PivotFieldSortOptions -> PivotTableSortBy
sortBy} -> PivotTableSortBy
sortBy) (\s :: PivotFieldSortOptions
s@PivotFieldSortOptions' {} PivotTableSortBy
a -> PivotFieldSortOptions
s {$sel:sortBy:PivotFieldSortOptions' :: PivotTableSortBy
sortBy = PivotTableSortBy
a} :: PivotFieldSortOptions)

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

instance Prelude.Hashable PivotFieldSortOptions where
  hashWithSalt :: Int -> PivotFieldSortOptions -> Int
hashWithSalt Int
_salt PivotFieldSortOptions' {Text
PivotTableSortBy
sortBy :: PivotTableSortBy
fieldId :: Text
$sel:sortBy:PivotFieldSortOptions' :: PivotFieldSortOptions -> PivotTableSortBy
$sel:fieldId:PivotFieldSortOptions' :: PivotFieldSortOptions -> Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
fieldId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` PivotTableSortBy
sortBy

instance Prelude.NFData PivotFieldSortOptions where
  rnf :: PivotFieldSortOptions -> ()
rnf PivotFieldSortOptions' {Text
PivotTableSortBy
sortBy :: PivotTableSortBy
fieldId :: Text
$sel:sortBy:PivotFieldSortOptions' :: PivotFieldSortOptions -> PivotTableSortBy
$sel:fieldId:PivotFieldSortOptions' :: PivotFieldSortOptions -> Text
..} =
    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 PivotTableSortBy
sortBy

instance Data.ToJSON PivotFieldSortOptions where
  toJSON :: PivotFieldSortOptions -> Value
toJSON PivotFieldSortOptions' {Text
PivotTableSortBy
sortBy :: PivotTableSortBy
fieldId :: Text
$sel:sortBy:PivotFieldSortOptions' :: PivotFieldSortOptions -> PivotTableSortBy
$sel:fieldId:PivotFieldSortOptions' :: PivotFieldSortOptions -> Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ 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
"SortBy" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= PivotTableSortBy
sortBy)
          ]
      )