{-# 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.Rum.Types.QueryFilter
-- 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.Rum.Types.QueryFilter 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

-- | A structure that defines a key and values that you can use to filter the
-- results. The only performance events that are returned are those that
-- have values matching the ones that you specify in one of your
-- @QueryFilter@ structures.
--
-- For example, you could specify @Browser@ as the @Name@ and specify
-- @Chrome,Firefox@ as the @Values@ to return events generated only from
-- those browsers.
--
-- Specifying @Invert@ as the @Name@ works as a \"not equal to\" filter.
-- For example, specify @Invert@ as the @Name@ and specify @Chrome@ as the
-- value to return all events except events from user sessions with the
-- Chrome browser.
--
-- /See:/ 'newQueryFilter' smart constructor.
data QueryFilter = QueryFilter'
  { -- | The name of a key to search for. The filter returns only the events that
    -- match the @Name@ and @Values@ that you specify.
    --
    -- Valid values for @Name@ are @Browser@ | @Device@ | @Country@ | @Page@ |
    -- @OS@ | @EventType@ | @Invert@
    QueryFilter -> Maybe Text
name :: Prelude.Maybe Prelude.Text,
    -- | The values of the @Name@ that are to be be included in the returned
    -- results.
    QueryFilter -> Maybe [Text]
values :: Prelude.Maybe [Prelude.Text]
  }
  deriving (QueryFilter -> QueryFilter -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: QueryFilter -> QueryFilter -> Bool
$c/= :: QueryFilter -> QueryFilter -> Bool
== :: QueryFilter -> QueryFilter -> Bool
$c== :: QueryFilter -> QueryFilter -> Bool
Prelude.Eq, ReadPrec [QueryFilter]
ReadPrec QueryFilter
Int -> ReadS QueryFilter
ReadS [QueryFilter]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [QueryFilter]
$creadListPrec :: ReadPrec [QueryFilter]
readPrec :: ReadPrec QueryFilter
$creadPrec :: ReadPrec QueryFilter
readList :: ReadS [QueryFilter]
$creadList :: ReadS [QueryFilter]
readsPrec :: Int -> ReadS QueryFilter
$creadsPrec :: Int -> ReadS QueryFilter
Prelude.Read, Int -> QueryFilter -> ShowS
[QueryFilter] -> ShowS
QueryFilter -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [QueryFilter] -> ShowS
$cshowList :: [QueryFilter] -> ShowS
show :: QueryFilter -> String
$cshow :: QueryFilter -> String
showsPrec :: Int -> QueryFilter -> ShowS
$cshowsPrec :: Int -> QueryFilter -> ShowS
Prelude.Show, forall x. Rep QueryFilter x -> QueryFilter
forall x. QueryFilter -> Rep QueryFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep QueryFilter x -> QueryFilter
$cfrom :: forall x. QueryFilter -> Rep QueryFilter x
Prelude.Generic)

-- |
-- Create a value of 'QueryFilter' 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:
--
-- 'name', 'queryFilter_name' - The name of a key to search for. The filter returns only the events that
-- match the @Name@ and @Values@ that you specify.
--
-- Valid values for @Name@ are @Browser@ | @Device@ | @Country@ | @Page@ |
-- @OS@ | @EventType@ | @Invert@
--
-- 'values', 'queryFilter_values' - The values of the @Name@ that are to be be included in the returned
-- results.
newQueryFilter ::
  QueryFilter
newQueryFilter :: QueryFilter
newQueryFilter =
  QueryFilter'
    { $sel:name:QueryFilter' :: Maybe Text
name = forall a. Maybe a
Prelude.Nothing,
      $sel:values:QueryFilter' :: Maybe [Text]
values = forall a. Maybe a
Prelude.Nothing
    }

-- | The name of a key to search for. The filter returns only the events that
-- match the @Name@ and @Values@ that you specify.
--
-- Valid values for @Name@ are @Browser@ | @Device@ | @Country@ | @Page@ |
-- @OS@ | @EventType@ | @Invert@
queryFilter_name :: Lens.Lens' QueryFilter (Prelude.Maybe Prelude.Text)
queryFilter_name :: Lens' QueryFilter (Maybe Text)
queryFilter_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryFilter' {Maybe Text
name :: Maybe Text
$sel:name:QueryFilter' :: QueryFilter -> Maybe Text
name} -> Maybe Text
name) (\s :: QueryFilter
s@QueryFilter' {} Maybe Text
a -> QueryFilter
s {$sel:name:QueryFilter' :: Maybe Text
name = Maybe Text
a} :: QueryFilter)

-- | The values of the @Name@ that are to be be included in the returned
-- results.
queryFilter_values :: Lens.Lens' QueryFilter (Prelude.Maybe [Prelude.Text])
queryFilter_values :: Lens' QueryFilter (Maybe [Text])
queryFilter_values = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryFilter' {Maybe [Text]
values :: Maybe [Text]
$sel:values:QueryFilter' :: QueryFilter -> Maybe [Text]
values} -> Maybe [Text]
values) (\s :: QueryFilter
s@QueryFilter' {} Maybe [Text]
a -> QueryFilter
s {$sel:values:QueryFilter' :: Maybe [Text]
values = Maybe [Text]
a} :: QueryFilter) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. 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 forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Prelude.Hashable QueryFilter where
  hashWithSalt :: Int -> QueryFilter -> Int
hashWithSalt Int
_salt QueryFilter' {Maybe [Text]
Maybe Text
values :: Maybe [Text]
name :: Maybe Text
$sel:values:QueryFilter' :: QueryFilter -> Maybe [Text]
$sel:name:QueryFilter' :: QueryFilter -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
values

instance Prelude.NFData QueryFilter where
  rnf :: QueryFilter -> ()
rnf QueryFilter' {Maybe [Text]
Maybe Text
values :: Maybe [Text]
name :: Maybe Text
$sel:values:QueryFilter' :: QueryFilter -> Maybe [Text]
$sel:name:QueryFilter' :: QueryFilter -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
name seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
values

instance Data.ToJSON QueryFilter where
  toJSON :: QueryFilter -> Value
toJSON QueryFilter' {Maybe [Text]
Maybe Text
values :: Maybe [Text]
name :: Maybe Text
$sel:values:QueryFilter' :: QueryFilter -> Maybe [Text]
$sel:name:QueryFilter' :: QueryFilter -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"Name" 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 Text
name,
            (Key
"Values" 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 [Text]
values
          ]
      )