{-# 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.AggregationSortConfiguration
-- 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.AggregationSortConfiguration 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.AggregationFunction
import Amazonka.QuickSight.Types.ColumnIdentifier
import Amazonka.QuickSight.Types.SortDirection

-- | The configuration options to sort aggregated values.
--
-- /See:/ 'newAggregationSortConfiguration' smart constructor.
data AggregationSortConfiguration = AggregationSortConfiguration'
  { -- | The column that determines the sort order of aggregated values.
    AggregationSortConfiguration -> ColumnIdentifier
column :: ColumnIdentifier,
    -- | The sort direction of values.
    --
    -- -   @ASC@: Sort in ascending order.
    --
    -- -   @DESC@: Sort in descending order.
    AggregationSortConfiguration -> SortDirection
sortDirection :: SortDirection,
    -- | The function that aggregates the values in @Column@.
    AggregationSortConfiguration -> AggregationFunction
aggregationFunction :: AggregationFunction
  }
  deriving (AggregationSortConfiguration
-> AggregationSortConfiguration -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: AggregationSortConfiguration
-> AggregationSortConfiguration -> Bool
$c/= :: AggregationSortConfiguration
-> AggregationSortConfiguration -> Bool
== :: AggregationSortConfiguration
-> AggregationSortConfiguration -> Bool
$c== :: AggregationSortConfiguration
-> AggregationSortConfiguration -> Bool
Prelude.Eq, ReadPrec [AggregationSortConfiguration]
ReadPrec AggregationSortConfiguration
Int -> ReadS AggregationSortConfiguration
ReadS [AggregationSortConfiguration]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [AggregationSortConfiguration]
$creadListPrec :: ReadPrec [AggregationSortConfiguration]
readPrec :: ReadPrec AggregationSortConfiguration
$creadPrec :: ReadPrec AggregationSortConfiguration
readList :: ReadS [AggregationSortConfiguration]
$creadList :: ReadS [AggregationSortConfiguration]
readsPrec :: Int -> ReadS AggregationSortConfiguration
$creadsPrec :: Int -> ReadS AggregationSortConfiguration
Prelude.Read, Int -> AggregationSortConfiguration -> ShowS
[AggregationSortConfiguration] -> ShowS
AggregationSortConfiguration -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [AggregationSortConfiguration] -> ShowS
$cshowList :: [AggregationSortConfiguration] -> ShowS
show :: AggregationSortConfiguration -> String
$cshow :: AggregationSortConfiguration -> String
showsPrec :: Int -> AggregationSortConfiguration -> ShowS
$cshowsPrec :: Int -> AggregationSortConfiguration -> ShowS
Prelude.Show, forall x.
Rep AggregationSortConfiguration x -> AggregationSortConfiguration
forall x.
AggregationSortConfiguration -> Rep AggregationSortConfiguration x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep AggregationSortConfiguration x -> AggregationSortConfiguration
$cfrom :: forall x.
AggregationSortConfiguration -> Rep AggregationSortConfiguration x
Prelude.Generic)

-- |
-- Create a value of 'AggregationSortConfiguration' 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:
--
-- 'column', 'aggregationSortConfiguration_column' - The column that determines the sort order of aggregated values.
--
-- 'sortDirection', 'aggregationSortConfiguration_sortDirection' - The sort direction of values.
--
-- -   @ASC@: Sort in ascending order.
--
-- -   @DESC@: Sort in descending order.
--
-- 'aggregationFunction', 'aggregationSortConfiguration_aggregationFunction' - The function that aggregates the values in @Column@.
newAggregationSortConfiguration ::
  -- | 'column'
  ColumnIdentifier ->
  -- | 'sortDirection'
  SortDirection ->
  -- | 'aggregationFunction'
  AggregationFunction ->
  AggregationSortConfiguration
newAggregationSortConfiguration :: ColumnIdentifier
-> SortDirection
-> AggregationFunction
-> AggregationSortConfiguration
newAggregationSortConfiguration
  ColumnIdentifier
pColumn_
  SortDirection
pSortDirection_
  AggregationFunction
pAggregationFunction_ =
    AggregationSortConfiguration'
      { $sel:column:AggregationSortConfiguration' :: ColumnIdentifier
column = ColumnIdentifier
pColumn_,
        $sel:sortDirection:AggregationSortConfiguration' :: SortDirection
sortDirection = SortDirection
pSortDirection_,
        $sel:aggregationFunction:AggregationSortConfiguration' :: AggregationFunction
aggregationFunction = AggregationFunction
pAggregationFunction_
      }

-- | The column that determines the sort order of aggregated values.
aggregationSortConfiguration_column :: Lens.Lens' AggregationSortConfiguration ColumnIdentifier
aggregationSortConfiguration_column :: Lens' AggregationSortConfiguration ColumnIdentifier
aggregationSortConfiguration_column = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AggregationSortConfiguration' {ColumnIdentifier
column :: ColumnIdentifier
$sel:column:AggregationSortConfiguration' :: AggregationSortConfiguration -> ColumnIdentifier
column} -> ColumnIdentifier
column) (\s :: AggregationSortConfiguration
s@AggregationSortConfiguration' {} ColumnIdentifier
a -> AggregationSortConfiguration
s {$sel:column:AggregationSortConfiguration' :: ColumnIdentifier
column = ColumnIdentifier
a} :: AggregationSortConfiguration)

-- | The sort direction of values.
--
-- -   @ASC@: Sort in ascending order.
--
-- -   @DESC@: Sort in descending order.
aggregationSortConfiguration_sortDirection :: Lens.Lens' AggregationSortConfiguration SortDirection
aggregationSortConfiguration_sortDirection :: Lens' AggregationSortConfiguration SortDirection
aggregationSortConfiguration_sortDirection = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AggregationSortConfiguration' {SortDirection
sortDirection :: SortDirection
$sel:sortDirection:AggregationSortConfiguration' :: AggregationSortConfiguration -> SortDirection
sortDirection} -> SortDirection
sortDirection) (\s :: AggregationSortConfiguration
s@AggregationSortConfiguration' {} SortDirection
a -> AggregationSortConfiguration
s {$sel:sortDirection:AggregationSortConfiguration' :: SortDirection
sortDirection = SortDirection
a} :: AggregationSortConfiguration)

-- | The function that aggregates the values in @Column@.
aggregationSortConfiguration_aggregationFunction :: Lens.Lens' AggregationSortConfiguration AggregationFunction
aggregationSortConfiguration_aggregationFunction :: Lens' AggregationSortConfiguration AggregationFunction
aggregationSortConfiguration_aggregationFunction = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AggregationSortConfiguration' {AggregationFunction
aggregationFunction :: AggregationFunction
$sel:aggregationFunction:AggregationSortConfiguration' :: AggregationSortConfiguration -> AggregationFunction
aggregationFunction} -> AggregationFunction
aggregationFunction) (\s :: AggregationSortConfiguration
s@AggregationSortConfiguration' {} AggregationFunction
a -> AggregationSortConfiguration
s {$sel:aggregationFunction:AggregationSortConfiguration' :: AggregationFunction
aggregationFunction = AggregationFunction
a} :: AggregationSortConfiguration)

instance Data.FromJSON AggregationSortConfiguration where
  parseJSON :: Value -> Parser AggregationSortConfiguration
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"AggregationSortConfiguration"
      ( \Object
x ->
          ColumnIdentifier
-> SortDirection
-> AggregationFunction
-> AggregationSortConfiguration
AggregationSortConfiguration'
            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
"Column")
            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
"SortDirection")
            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
"AggregationFunction")
      )

instance
  Prelude.Hashable
    AggregationSortConfiguration
  where
  hashWithSalt :: Int -> AggregationSortConfiguration -> Int
hashWithSalt Int
_salt AggregationSortConfiguration' {ColumnIdentifier
AggregationFunction
SortDirection
aggregationFunction :: AggregationFunction
sortDirection :: SortDirection
column :: ColumnIdentifier
$sel:aggregationFunction:AggregationSortConfiguration' :: AggregationSortConfiguration -> AggregationFunction
$sel:sortDirection:AggregationSortConfiguration' :: AggregationSortConfiguration -> SortDirection
$sel:column:AggregationSortConfiguration' :: AggregationSortConfiguration -> ColumnIdentifier
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` ColumnIdentifier
column
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` SortDirection
sortDirection
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` AggregationFunction
aggregationFunction

instance Prelude.NFData AggregationSortConfiguration where
  rnf :: AggregationSortConfiguration -> ()
rnf AggregationSortConfiguration' {ColumnIdentifier
AggregationFunction
SortDirection
aggregationFunction :: AggregationFunction
sortDirection :: SortDirection
column :: ColumnIdentifier
$sel:aggregationFunction:AggregationSortConfiguration' :: AggregationSortConfiguration -> AggregationFunction
$sel:sortDirection:AggregationSortConfiguration' :: AggregationSortConfiguration -> SortDirection
$sel:column:AggregationSortConfiguration' :: AggregationSortConfiguration -> ColumnIdentifier
..} =
    forall a. NFData a => a -> ()
Prelude.rnf ColumnIdentifier
column
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf SortDirection
sortDirection
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf AggregationFunction
aggregationFunction

instance Data.ToJSON AggregationSortConfiguration where
  toJSON :: AggregationSortConfiguration -> Value
toJSON AggregationSortConfiguration' {ColumnIdentifier
AggregationFunction
SortDirection
aggregationFunction :: AggregationFunction
sortDirection :: SortDirection
column :: ColumnIdentifier
$sel:aggregationFunction:AggregationSortConfiguration' :: AggregationSortConfiguration -> AggregationFunction
$sel:sortDirection:AggregationSortConfiguration' :: AggregationSortConfiguration -> SortDirection
$sel:column:AggregationSortConfiguration' :: AggregationSortConfiguration -> ColumnIdentifier
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just (Key
"Column" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= ColumnIdentifier
column),
            forall a. a -> Maybe a
Prelude.Just (Key
"SortDirection" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= SortDirection
sortDirection),
            forall a. a -> Maybe a
Prelude.Just
              (Key
"AggregationFunction" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= AggregationFunction
aggregationFunction)
          ]
      )