{-# 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.IoTThingsGraph.Types.EntityFilter
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.IoTThingsGraph.Types.EntityFilter where

import qualified Amazonka.Core as Core
import Amazonka.IoTThingsGraph.Types.EntityFilterName
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude

-- | An object that filters an entity search. Multiple filters function as OR
-- criteria in the search. For example a search that includes a @NAMESPACE@
-- and a @REFERENCED_ENTITY_ID@ filter searches for entities in the
-- specified namespace that use the entity specified by the value of
-- @REFERENCED_ENTITY_ID@.
--
-- /See:/ 'newEntityFilter' smart constructor.
data EntityFilter = EntityFilter'
  { -- | An array of string values for the search filter field. Multiple values
    -- function as AND criteria in the search.
    EntityFilter -> Maybe [Text]
value :: Prelude.Maybe [Prelude.Text],
    -- | The name of the entity search filter field. @REFERENCED_ENTITY_ID@
    -- filters on entities that are used by the entity in the result set. For
    -- example, you can filter on the ID of a property that is used in a state.
    EntityFilter -> Maybe EntityFilterName
name :: Prelude.Maybe EntityFilterName
  }
  deriving (EntityFilter -> EntityFilter -> Bool
(EntityFilter -> EntityFilter -> Bool)
-> (EntityFilter -> EntityFilter -> Bool) -> Eq EntityFilter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: EntityFilter -> EntityFilter -> Bool
$c/= :: EntityFilter -> EntityFilter -> Bool
== :: EntityFilter -> EntityFilter -> Bool
$c== :: EntityFilter -> EntityFilter -> Bool
Prelude.Eq, ReadPrec [EntityFilter]
ReadPrec EntityFilter
Int -> ReadS EntityFilter
ReadS [EntityFilter]
(Int -> ReadS EntityFilter)
-> ReadS [EntityFilter]
-> ReadPrec EntityFilter
-> ReadPrec [EntityFilter]
-> Read EntityFilter
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [EntityFilter]
$creadListPrec :: ReadPrec [EntityFilter]
readPrec :: ReadPrec EntityFilter
$creadPrec :: ReadPrec EntityFilter
readList :: ReadS [EntityFilter]
$creadList :: ReadS [EntityFilter]
readsPrec :: Int -> ReadS EntityFilter
$creadsPrec :: Int -> ReadS EntityFilter
Prelude.Read, Int -> EntityFilter -> ShowS
[EntityFilter] -> ShowS
EntityFilter -> String
(Int -> EntityFilter -> ShowS)
-> (EntityFilter -> String)
-> ([EntityFilter] -> ShowS)
-> Show EntityFilter
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [EntityFilter] -> ShowS
$cshowList :: [EntityFilter] -> ShowS
show :: EntityFilter -> String
$cshow :: EntityFilter -> String
showsPrec :: Int -> EntityFilter -> ShowS
$cshowsPrec :: Int -> EntityFilter -> ShowS
Prelude.Show, (forall x. EntityFilter -> Rep EntityFilter x)
-> (forall x. Rep EntityFilter x -> EntityFilter)
-> Generic EntityFilter
forall x. Rep EntityFilter x -> EntityFilter
forall x. EntityFilter -> Rep EntityFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep EntityFilter x -> EntityFilter
$cfrom :: forall x. EntityFilter -> Rep EntityFilter x
Prelude.Generic)

-- |
-- Create a value of 'EntityFilter' 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:
--
-- 'value', 'entityFilter_value' - An array of string values for the search filter field. Multiple values
-- function as AND criteria in the search.
--
-- 'name', 'entityFilter_name' - The name of the entity search filter field. @REFERENCED_ENTITY_ID@
-- filters on entities that are used by the entity in the result set. For
-- example, you can filter on the ID of a property that is used in a state.
newEntityFilter ::
  EntityFilter
newEntityFilter :: EntityFilter
newEntityFilter =
  EntityFilter' :: Maybe [Text] -> Maybe EntityFilterName -> EntityFilter
EntityFilter'
    { $sel:value:EntityFilter' :: Maybe [Text]
value = Maybe [Text]
forall a. Maybe a
Prelude.Nothing,
      $sel:name:EntityFilter' :: Maybe EntityFilterName
name = Maybe EntityFilterName
forall a. Maybe a
Prelude.Nothing
    }

-- | An array of string values for the search filter field. Multiple values
-- function as AND criteria in the search.
entityFilter_value :: Lens.Lens' EntityFilter (Prelude.Maybe [Prelude.Text])
entityFilter_value :: (Maybe [Text] -> f (Maybe [Text]))
-> EntityFilter -> f EntityFilter
entityFilter_value = (EntityFilter -> Maybe [Text])
-> (EntityFilter -> Maybe [Text] -> EntityFilter)
-> Lens EntityFilter EntityFilter (Maybe [Text]) (Maybe [Text])
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EntityFilter' {Maybe [Text]
value :: Maybe [Text]
$sel:value:EntityFilter' :: EntityFilter -> Maybe [Text]
value} -> Maybe [Text]
value) (\s :: EntityFilter
s@EntityFilter' {} Maybe [Text]
a -> EntityFilter
s {$sel:value:EntityFilter' :: Maybe [Text]
value = Maybe [Text]
a} :: EntityFilter) ((Maybe [Text] -> f (Maybe [Text]))
 -> EntityFilter -> f EntityFilter)
-> ((Maybe [Text] -> f (Maybe [Text]))
    -> Maybe [Text] -> f (Maybe [Text]))
-> (Maybe [Text] -> f (Maybe [Text]))
-> EntityFilter
-> f EntityFilter
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso [Text] [Text] [Text] [Text]
-> Iso (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text])
forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping AnIso [Text] [Text] [Text] [Text]
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The name of the entity search filter field. @REFERENCED_ENTITY_ID@
-- filters on entities that are used by the entity in the result set. For
-- example, you can filter on the ID of a property that is used in a state.
entityFilter_name :: Lens.Lens' EntityFilter (Prelude.Maybe EntityFilterName)
entityFilter_name :: (Maybe EntityFilterName -> f (Maybe EntityFilterName))
-> EntityFilter -> f EntityFilter
entityFilter_name = (EntityFilter -> Maybe EntityFilterName)
-> (EntityFilter -> Maybe EntityFilterName -> EntityFilter)
-> Lens
     EntityFilter
     EntityFilter
     (Maybe EntityFilterName)
     (Maybe EntityFilterName)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EntityFilter' {Maybe EntityFilterName
name :: Maybe EntityFilterName
$sel:name:EntityFilter' :: EntityFilter -> Maybe EntityFilterName
name} -> Maybe EntityFilterName
name) (\s :: EntityFilter
s@EntityFilter' {} Maybe EntityFilterName
a -> EntityFilter
s {$sel:name:EntityFilter' :: Maybe EntityFilterName
name = Maybe EntityFilterName
a} :: EntityFilter)

instance Prelude.Hashable EntityFilter

instance Prelude.NFData EntityFilter

instance Core.ToJSON EntityFilter where
  toJSON :: EntityFilter -> Value
toJSON EntityFilter' {Maybe [Text]
Maybe EntityFilterName
name :: Maybe EntityFilterName
value :: Maybe [Text]
$sel:name:EntityFilter' :: EntityFilter -> Maybe EntityFilterName
$sel:value:EntityFilter' :: EntityFilter -> Maybe [Text]
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"value" Text -> [Text] -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) ([Text] -> Pair) -> Maybe [Text] -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [Text]
value,
            (Text
"name" Text -> EntityFilterName -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (EntityFilterName -> Pair) -> Maybe EntityFilterName -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe EntityFilterName
name
          ]
      )