{-# 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.QuickSight.Types.DashboardSearchFilter
-- 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.QuickSight.Types.DashboardSearchFilter where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude
import Amazonka.QuickSight.Types.DashboardFilterAttribute
import Amazonka.QuickSight.Types.FilterOperator

-- | A filter that you apply when searching for dashboards.
--
-- /See:/ 'newDashboardSearchFilter' smart constructor.
data DashboardSearchFilter = DashboardSearchFilter'
  { -- | The value of the named item, in this case @QUICKSIGHT_USER@, that you
    -- want to use as a filter, for example,
    -- @\"Value\": \"arn:aws:quicksight:us-east-1:1:user\/default\/UserName1\"@.
    DashboardSearchFilter -> Maybe Text
value :: Prelude.Maybe Prelude.Text,
    -- | The name of the value that you want to use as a filter, for example,
    -- @\"Name\": \"QUICKSIGHT_USER\"@.
    DashboardSearchFilter -> Maybe DashboardFilterAttribute
name :: Prelude.Maybe DashboardFilterAttribute,
    -- | The comparison operator that you want to use as a filter, for example,
    -- @\"Operator\": \"StringEquals\"@.
    DashboardSearchFilter -> FilterOperator
operator :: FilterOperator
  }
  deriving (DashboardSearchFilter -> DashboardSearchFilter -> Bool
(DashboardSearchFilter -> DashboardSearchFilter -> Bool)
-> (DashboardSearchFilter -> DashboardSearchFilter -> Bool)
-> Eq DashboardSearchFilter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DashboardSearchFilter -> DashboardSearchFilter -> Bool
$c/= :: DashboardSearchFilter -> DashboardSearchFilter -> Bool
== :: DashboardSearchFilter -> DashboardSearchFilter -> Bool
$c== :: DashboardSearchFilter -> DashboardSearchFilter -> Bool
Prelude.Eq, ReadPrec [DashboardSearchFilter]
ReadPrec DashboardSearchFilter
Int -> ReadS DashboardSearchFilter
ReadS [DashboardSearchFilter]
(Int -> ReadS DashboardSearchFilter)
-> ReadS [DashboardSearchFilter]
-> ReadPrec DashboardSearchFilter
-> ReadPrec [DashboardSearchFilter]
-> Read DashboardSearchFilter
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DashboardSearchFilter]
$creadListPrec :: ReadPrec [DashboardSearchFilter]
readPrec :: ReadPrec DashboardSearchFilter
$creadPrec :: ReadPrec DashboardSearchFilter
readList :: ReadS [DashboardSearchFilter]
$creadList :: ReadS [DashboardSearchFilter]
readsPrec :: Int -> ReadS DashboardSearchFilter
$creadsPrec :: Int -> ReadS DashboardSearchFilter
Prelude.Read, Int -> DashboardSearchFilter -> ShowS
[DashboardSearchFilter] -> ShowS
DashboardSearchFilter -> String
(Int -> DashboardSearchFilter -> ShowS)
-> (DashboardSearchFilter -> String)
-> ([DashboardSearchFilter] -> ShowS)
-> Show DashboardSearchFilter
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DashboardSearchFilter] -> ShowS
$cshowList :: [DashboardSearchFilter] -> ShowS
show :: DashboardSearchFilter -> String
$cshow :: DashboardSearchFilter -> String
showsPrec :: Int -> DashboardSearchFilter -> ShowS
$cshowsPrec :: Int -> DashboardSearchFilter -> ShowS
Prelude.Show, (forall x. DashboardSearchFilter -> Rep DashboardSearchFilter x)
-> (forall x. Rep DashboardSearchFilter x -> DashboardSearchFilter)
-> Generic DashboardSearchFilter
forall x. Rep DashboardSearchFilter x -> DashboardSearchFilter
forall x. DashboardSearchFilter -> Rep DashboardSearchFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DashboardSearchFilter x -> DashboardSearchFilter
$cfrom :: forall x. DashboardSearchFilter -> Rep DashboardSearchFilter x
Prelude.Generic)

-- |
-- Create a value of 'DashboardSearchFilter' 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', 'dashboardSearchFilter_value' - The value of the named item, in this case @QUICKSIGHT_USER@, that you
-- want to use as a filter, for example,
-- @\"Value\": \"arn:aws:quicksight:us-east-1:1:user\/default\/UserName1\"@.
--
-- 'name', 'dashboardSearchFilter_name' - The name of the value that you want to use as a filter, for example,
-- @\"Name\": \"QUICKSIGHT_USER\"@.
--
-- 'operator', 'dashboardSearchFilter_operator' - The comparison operator that you want to use as a filter, for example,
-- @\"Operator\": \"StringEquals\"@.
newDashboardSearchFilter ::
  -- | 'operator'
  FilterOperator ->
  DashboardSearchFilter
newDashboardSearchFilter :: FilterOperator -> DashboardSearchFilter
newDashboardSearchFilter FilterOperator
pOperator_ =
  DashboardSearchFilter' :: Maybe Text
-> Maybe DashboardFilterAttribute
-> FilterOperator
-> DashboardSearchFilter
DashboardSearchFilter'
    { $sel:value:DashboardSearchFilter' :: Maybe Text
value = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:name:DashboardSearchFilter' :: Maybe DashboardFilterAttribute
name = Maybe DashboardFilterAttribute
forall a. Maybe a
Prelude.Nothing,
      $sel:operator:DashboardSearchFilter' :: FilterOperator
operator = FilterOperator
pOperator_
    }

-- | The value of the named item, in this case @QUICKSIGHT_USER@, that you
-- want to use as a filter, for example,
-- @\"Value\": \"arn:aws:quicksight:us-east-1:1:user\/default\/UserName1\"@.
dashboardSearchFilter_value :: Lens.Lens' DashboardSearchFilter (Prelude.Maybe Prelude.Text)
dashboardSearchFilter_value :: (Maybe Text -> f (Maybe Text))
-> DashboardSearchFilter -> f DashboardSearchFilter
dashboardSearchFilter_value = (DashboardSearchFilter -> Maybe Text)
-> (DashboardSearchFilter -> Maybe Text -> DashboardSearchFilter)
-> Lens
     DashboardSearchFilter
     DashboardSearchFilter
     (Maybe Text)
     (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DashboardSearchFilter' {Maybe Text
value :: Maybe Text
$sel:value:DashboardSearchFilter' :: DashboardSearchFilter -> Maybe Text
value} -> Maybe Text
value) (\s :: DashboardSearchFilter
s@DashboardSearchFilter' {} Maybe Text
a -> DashboardSearchFilter
s {$sel:value:DashboardSearchFilter' :: Maybe Text
value = Maybe Text
a} :: DashboardSearchFilter)

-- | The name of the value that you want to use as a filter, for example,
-- @\"Name\": \"QUICKSIGHT_USER\"@.
dashboardSearchFilter_name :: Lens.Lens' DashboardSearchFilter (Prelude.Maybe DashboardFilterAttribute)
dashboardSearchFilter_name :: (Maybe DashboardFilterAttribute
 -> f (Maybe DashboardFilterAttribute))
-> DashboardSearchFilter -> f DashboardSearchFilter
dashboardSearchFilter_name = (DashboardSearchFilter -> Maybe DashboardFilterAttribute)
-> (DashboardSearchFilter
    -> Maybe DashboardFilterAttribute -> DashboardSearchFilter)
-> Lens
     DashboardSearchFilter
     DashboardSearchFilter
     (Maybe DashboardFilterAttribute)
     (Maybe DashboardFilterAttribute)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DashboardSearchFilter' {Maybe DashboardFilterAttribute
name :: Maybe DashboardFilterAttribute
$sel:name:DashboardSearchFilter' :: DashboardSearchFilter -> Maybe DashboardFilterAttribute
name} -> Maybe DashboardFilterAttribute
name) (\s :: DashboardSearchFilter
s@DashboardSearchFilter' {} Maybe DashboardFilterAttribute
a -> DashboardSearchFilter
s {$sel:name:DashboardSearchFilter' :: Maybe DashboardFilterAttribute
name = Maybe DashboardFilterAttribute
a} :: DashboardSearchFilter)

-- | The comparison operator that you want to use as a filter, for example,
-- @\"Operator\": \"StringEquals\"@.
dashboardSearchFilter_operator :: Lens.Lens' DashboardSearchFilter FilterOperator
dashboardSearchFilter_operator :: (FilterOperator -> f FilterOperator)
-> DashboardSearchFilter -> f DashboardSearchFilter
dashboardSearchFilter_operator = (DashboardSearchFilter -> FilterOperator)
-> (DashboardSearchFilter
    -> FilterOperator -> DashboardSearchFilter)
-> Lens
     DashboardSearchFilter
     DashboardSearchFilter
     FilterOperator
     FilterOperator
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DashboardSearchFilter' {FilterOperator
operator :: FilterOperator
$sel:operator:DashboardSearchFilter' :: DashboardSearchFilter -> FilterOperator
operator} -> FilterOperator
operator) (\s :: DashboardSearchFilter
s@DashboardSearchFilter' {} FilterOperator
a -> DashboardSearchFilter
s {$sel:operator:DashboardSearchFilter' :: FilterOperator
operator = FilterOperator
a} :: DashboardSearchFilter)

instance Prelude.Hashable DashboardSearchFilter

instance Prelude.NFData DashboardSearchFilter

instance Core.ToJSON DashboardSearchFilter where
  toJSON :: DashboardSearchFilter -> Value
toJSON DashboardSearchFilter' {Maybe Text
Maybe DashboardFilterAttribute
FilterOperator
operator :: FilterOperator
name :: Maybe DashboardFilterAttribute
value :: Maybe Text
$sel:operator:DashboardSearchFilter' :: DashboardSearchFilter -> FilterOperator
$sel:name:DashboardSearchFilter' :: DashboardSearchFilter -> Maybe DashboardFilterAttribute
$sel:value:DashboardSearchFilter' :: DashboardSearchFilter -> 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 -> DashboardFilterAttribute -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (DashboardFilterAttribute -> Pair)
-> Maybe DashboardFilterAttribute -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe DashboardFilterAttribute
name,
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"Operator" Text -> FilterOperator -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= FilterOperator
operator)
          ]
      )