{-# 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.IotTwinMaker.Types.OrderBy
-- 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.IotTwinMaker.Types.OrderBy where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.IotTwinMaker.Types.Order
import qualified Amazonka.Prelude as Prelude

-- | Filter criteria that orders the return output. It can be sorted in
-- ascending or descending order.
--
-- /See:/ 'newOrderBy' smart constructor.
data OrderBy = OrderBy'
  { -- | The set order that filters results.
    OrderBy -> Maybe Order
order :: Prelude.Maybe Order,
    -- | The property name.
    OrderBy -> Text
propertyName :: Prelude.Text
  }
  deriving (OrderBy -> OrderBy -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: OrderBy -> OrderBy -> Bool
$c/= :: OrderBy -> OrderBy -> Bool
== :: OrderBy -> OrderBy -> Bool
$c== :: OrderBy -> OrderBy -> Bool
Prelude.Eq, ReadPrec [OrderBy]
ReadPrec OrderBy
Int -> ReadS OrderBy
ReadS [OrderBy]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [OrderBy]
$creadListPrec :: ReadPrec [OrderBy]
readPrec :: ReadPrec OrderBy
$creadPrec :: ReadPrec OrderBy
readList :: ReadS [OrderBy]
$creadList :: ReadS [OrderBy]
readsPrec :: Int -> ReadS OrderBy
$creadsPrec :: Int -> ReadS OrderBy
Prelude.Read, Int -> OrderBy -> ShowS
[OrderBy] -> ShowS
OrderBy -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [OrderBy] -> ShowS
$cshowList :: [OrderBy] -> ShowS
show :: OrderBy -> String
$cshow :: OrderBy -> String
showsPrec :: Int -> OrderBy -> ShowS
$cshowsPrec :: Int -> OrderBy -> ShowS
Prelude.Show, forall x. Rep OrderBy x -> OrderBy
forall x. OrderBy -> Rep OrderBy x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep OrderBy x -> OrderBy
$cfrom :: forall x. OrderBy -> Rep OrderBy x
Prelude.Generic)

-- |
-- Create a value of 'OrderBy' 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:
--
-- 'order', 'orderBy_order' - The set order that filters results.
--
-- 'propertyName', 'orderBy_propertyName' - The property name.
newOrderBy ::
  -- | 'propertyName'
  Prelude.Text ->
  OrderBy
newOrderBy :: Text -> OrderBy
newOrderBy Text
pPropertyName_ =
  OrderBy'
    { $sel:order:OrderBy' :: Maybe Order
order = forall a. Maybe a
Prelude.Nothing,
      $sel:propertyName:OrderBy' :: Text
propertyName = Text
pPropertyName_
    }

-- | The set order that filters results.
orderBy_order :: Lens.Lens' OrderBy (Prelude.Maybe Order)
orderBy_order :: Lens' OrderBy (Maybe Order)
orderBy_order = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\OrderBy' {Maybe Order
order :: Maybe Order
$sel:order:OrderBy' :: OrderBy -> Maybe Order
order} -> Maybe Order
order) (\s :: OrderBy
s@OrderBy' {} Maybe Order
a -> OrderBy
s {$sel:order:OrderBy' :: Maybe Order
order = Maybe Order
a} :: OrderBy)

-- | The property name.
orderBy_propertyName :: Lens.Lens' OrderBy Prelude.Text
orderBy_propertyName :: Lens' OrderBy Text
orderBy_propertyName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\OrderBy' {Text
propertyName :: Text
$sel:propertyName:OrderBy' :: OrderBy -> Text
propertyName} -> Text
propertyName) (\s :: OrderBy
s@OrderBy' {} Text
a -> OrderBy
s {$sel:propertyName:OrderBy' :: Text
propertyName = Text
a} :: OrderBy)

instance Prelude.Hashable OrderBy where
  hashWithSalt :: Int -> OrderBy -> Int
hashWithSalt Int
_salt OrderBy' {Maybe Order
Text
propertyName :: Text
order :: Maybe Order
$sel:propertyName:OrderBy' :: OrderBy -> Text
$sel:order:OrderBy' :: OrderBy -> Maybe Order
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Order
order
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
propertyName

instance Prelude.NFData OrderBy where
  rnf :: OrderBy -> ()
rnf OrderBy' {Maybe Order
Text
propertyName :: Text
order :: Maybe Order
$sel:propertyName:OrderBy' :: OrderBy -> Text
$sel:order:OrderBy' :: OrderBy -> Maybe Order
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Order
order
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
propertyName

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