{-# 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.Wisdom.Types.Filter
-- 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.Wisdom.Types.Filter 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.Wisdom.Types.FilterField
import Amazonka.Wisdom.Types.FilterOperator

-- | A search filter.
--
-- /See:/ 'newFilter' smart constructor.
data Filter = Filter'
  { -- | The field on which to filter.
    Filter -> FilterField
field :: FilterField,
    -- | The operator to use for comparing the field’s value with the provided
    -- value.
    Filter -> FilterOperator
operator :: FilterOperator,
    -- | The desired field value on which to filter.
    Filter -> Text
value :: Prelude.Text
  }
  deriving (Filter -> Filter -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Filter -> Filter -> Bool
$c/= :: Filter -> Filter -> Bool
== :: Filter -> Filter -> Bool
$c== :: Filter -> Filter -> Bool
Prelude.Eq, ReadPrec [Filter]
ReadPrec Filter
Int -> ReadS Filter
ReadS [Filter]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Filter]
$creadListPrec :: ReadPrec [Filter]
readPrec :: ReadPrec Filter
$creadPrec :: ReadPrec Filter
readList :: ReadS [Filter]
$creadList :: ReadS [Filter]
readsPrec :: Int -> ReadS Filter
$creadsPrec :: Int -> ReadS Filter
Prelude.Read, Int -> Filter -> ShowS
[Filter] -> ShowS
Filter -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Filter] -> ShowS
$cshowList :: [Filter] -> ShowS
show :: Filter -> String
$cshow :: Filter -> String
showsPrec :: Int -> Filter -> ShowS
$cshowsPrec :: Int -> Filter -> ShowS
Prelude.Show, forall x. Rep Filter x -> Filter
forall x. Filter -> Rep Filter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Filter x -> Filter
$cfrom :: forall x. Filter -> Rep Filter x
Prelude.Generic)

-- |
-- Create a value of 'Filter' 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', 'filter_field' - The field on which to filter.
--
-- 'operator', 'filter_operator' - The operator to use for comparing the field’s value with the provided
-- value.
--
-- 'value', 'filter_value' - The desired field value on which to filter.
newFilter ::
  -- | 'field'
  FilterField ->
  -- | 'operator'
  FilterOperator ->
  -- | 'value'
  Prelude.Text ->
  Filter
newFilter :: FilterField -> FilterOperator -> Text -> Filter
newFilter FilterField
pField_ FilterOperator
pOperator_ Text
pValue_ =
  Filter'
    { $sel:field:Filter' :: FilterField
field = FilterField
pField_,
      $sel:operator:Filter' :: FilterOperator
operator = FilterOperator
pOperator_,
      $sel:value:Filter' :: Text
value = Text
pValue_
    }

-- | The field on which to filter.
filter_field :: Lens.Lens' Filter FilterField
filter_field :: Lens' Filter FilterField
filter_field = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Filter' {FilterField
field :: FilterField
$sel:field:Filter' :: Filter -> FilterField
field} -> FilterField
field) (\s :: Filter
s@Filter' {} FilterField
a -> Filter
s {$sel:field:Filter' :: FilterField
field = FilterField
a} :: Filter)

-- | The operator to use for comparing the field’s value with the provided
-- value.
filter_operator :: Lens.Lens' Filter FilterOperator
filter_operator :: Lens' Filter FilterOperator
filter_operator = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Filter' {FilterOperator
operator :: FilterOperator
$sel:operator:Filter' :: Filter -> FilterOperator
operator} -> FilterOperator
operator) (\s :: Filter
s@Filter' {} FilterOperator
a -> Filter
s {$sel:operator:Filter' :: FilterOperator
operator = FilterOperator
a} :: Filter)

-- | The desired field value on which to filter.
filter_value :: Lens.Lens' Filter Prelude.Text
filter_value :: Lens' Filter Text
filter_value = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Filter' {Text
value :: Text
$sel:value:Filter' :: Filter -> Text
value} -> Text
value) (\s :: Filter
s@Filter' {} Text
a -> Filter
s {$sel:value:Filter' :: Text
value = Text
a} :: Filter)

instance Prelude.Hashable Filter where
  hashWithSalt :: Int -> Filter -> Int
hashWithSalt Int
_salt Filter' {Text
FilterField
FilterOperator
value :: Text
operator :: FilterOperator
field :: FilterField
$sel:value:Filter' :: Filter -> Text
$sel:operator:Filter' :: Filter -> FilterOperator
$sel:field:Filter' :: Filter -> FilterField
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` FilterField
field
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` FilterOperator
operator
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
value

instance Prelude.NFData Filter where
  rnf :: Filter -> ()
rnf Filter' {Text
FilterField
FilterOperator
value :: Text
operator :: FilterOperator
field :: FilterField
$sel:value:Filter' :: Filter -> Text
$sel:operator:Filter' :: Filter -> FilterOperator
$sel:field:Filter' :: Filter -> FilterField
..} =
    forall a. NFData a => a -> ()
Prelude.rnf FilterField
field
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf FilterOperator
operator
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
value

instance Data.ToJSON Filter where
  toJSON :: Filter -> Value
toJSON Filter' {Text
FilterField
FilterOperator
value :: Text
operator :: FilterOperator
field :: FilterField
$sel:value:Filter' :: Filter -> Text
$sel:operator:Filter' :: Filter -> FilterOperator
$sel:field:Filter' :: Filter -> FilterField
..} =
    [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..= FilterField
field),
            forall a. a -> Maybe a
Prelude.Just (Key
"operator" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= FilterOperator
operator),
            forall a. a -> Maybe a
Prelude.Just (Key
"value" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
value)
          ]
      )