{-# 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.Inspector2.Types.SortCriteria
-- 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.Inspector2.Types.SortCriteria where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Inspector2.Types.SortField
import Amazonka.Inspector2.Types.SortOrder
import qualified Amazonka.Prelude as Prelude

-- | Details about the criteria used to sort finding results.
--
-- /See:/ 'newSortCriteria' smart constructor.
data SortCriteria = SortCriteria'
  { -- | The finding detail field by which results are sorted.
    SortCriteria -> SortField
field :: SortField,
    -- | The order by which findings are sorted.
    SortCriteria -> SortOrder
sortOrder :: SortOrder
  }
  deriving (SortCriteria -> SortCriteria -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: SortCriteria -> SortCriteria -> Bool
$c/= :: SortCriteria -> SortCriteria -> Bool
== :: SortCriteria -> SortCriteria -> Bool
$c== :: SortCriteria -> SortCriteria -> Bool
Prelude.Eq, ReadPrec [SortCriteria]
ReadPrec SortCriteria
Int -> ReadS SortCriteria
ReadS [SortCriteria]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [SortCriteria]
$creadListPrec :: ReadPrec [SortCriteria]
readPrec :: ReadPrec SortCriteria
$creadPrec :: ReadPrec SortCriteria
readList :: ReadS [SortCriteria]
$creadList :: ReadS [SortCriteria]
readsPrec :: Int -> ReadS SortCriteria
$creadsPrec :: Int -> ReadS SortCriteria
Prelude.Read, Int -> SortCriteria -> ShowS
[SortCriteria] -> ShowS
SortCriteria -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [SortCriteria] -> ShowS
$cshowList :: [SortCriteria] -> ShowS
show :: SortCriteria -> String
$cshow :: SortCriteria -> String
showsPrec :: Int -> SortCriteria -> ShowS
$cshowsPrec :: Int -> SortCriteria -> ShowS
Prelude.Show, forall x. Rep SortCriteria x -> SortCriteria
forall x. SortCriteria -> Rep SortCriteria x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep SortCriteria x -> SortCriteria
$cfrom :: forall x. SortCriteria -> Rep SortCriteria x
Prelude.Generic)

-- |
-- Create a value of 'SortCriteria' 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:
--
-- 'field', 'sortCriteria_field' - The finding detail field by which results are sorted.
--
-- 'sortOrder', 'sortCriteria_sortOrder' - The order by which findings are sorted.
newSortCriteria ::
  -- | 'field'
  SortField ->
  -- | 'sortOrder'
  SortOrder ->
  SortCriteria
newSortCriteria :: SortField -> SortOrder -> SortCriteria
newSortCriteria SortField
pField_ SortOrder
pSortOrder_ =
  SortCriteria'
    { $sel:field:SortCriteria' :: SortField
field = SortField
pField_,
      $sel:sortOrder:SortCriteria' :: SortOrder
sortOrder = SortOrder
pSortOrder_
    }

-- | The finding detail field by which results are sorted.
sortCriteria_field :: Lens.Lens' SortCriteria SortField
sortCriteria_field :: Lens' SortCriteria SortField
sortCriteria_field = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SortCriteria' {SortField
field :: SortField
$sel:field:SortCriteria' :: SortCriteria -> SortField
field} -> SortField
field) (\s :: SortCriteria
s@SortCriteria' {} SortField
a -> SortCriteria
s {$sel:field:SortCriteria' :: SortField
field = SortField
a} :: SortCriteria)

-- | The order by which findings are sorted.
sortCriteria_sortOrder :: Lens.Lens' SortCriteria SortOrder
sortCriteria_sortOrder :: Lens' SortCriteria SortOrder
sortCriteria_sortOrder = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SortCriteria' {SortOrder
sortOrder :: SortOrder
$sel:sortOrder:SortCriteria' :: SortCriteria -> SortOrder
sortOrder} -> SortOrder
sortOrder) (\s :: SortCriteria
s@SortCriteria' {} SortOrder
a -> SortCriteria
s {$sel:sortOrder:SortCriteria' :: SortOrder
sortOrder = SortOrder
a} :: SortCriteria)

instance Prelude.Hashable SortCriteria where
  hashWithSalt :: Int -> SortCriteria -> Int
hashWithSalt Int
_salt SortCriteria' {SortField
SortOrder
sortOrder :: SortOrder
field :: SortField
$sel:sortOrder:SortCriteria' :: SortCriteria -> SortOrder
$sel:field:SortCriteria' :: SortCriteria -> SortField
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` SortField
field
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` SortOrder
sortOrder

instance Prelude.NFData SortCriteria where
  rnf :: SortCriteria -> ()
rnf SortCriteria' {SortField
SortOrder
sortOrder :: SortOrder
field :: SortField
$sel:sortOrder:SortCriteria' :: SortCriteria -> SortOrder
$sel:field:SortCriteria' :: SortCriteria -> SortField
..} =
    forall a. NFData a => a -> ()
Prelude.rnf SortField
field
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf SortOrder
sortOrder

instance Data.ToJSON SortCriteria where
  toJSON :: SortCriteria -> Value
toJSON SortCriteria' {SortField
SortOrder
sortOrder :: SortOrder
field :: SortField
$sel:sortOrder:SortCriteria' :: SortCriteria -> SortOrder
$sel:field:SortCriteria' :: SortCriteria -> SortField
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just (Key
"field" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= SortField
field),
            forall a. a -> Maybe a
Prelude.Just (Key
"sortOrder" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= SortOrder
sortOrder)
          ]
      )