{-# 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.ElasticBeanstalk.Types.SearchFilter
-- 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.ElasticBeanstalk.Types.SearchFilter where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude

-- | Describes criteria to restrict a list of results.
--
-- For operators that apply a single value to the attribute, the filter is
-- evaluated as follows: @Attribute Operator Values[1]@
--
-- Some operators, e.g. @in@, can apply multiple values. In this case, the
-- filter is evaluated as a logical union (OR) of applications of the
-- operator to the attribute with each one of the values:
-- @(Attribute Operator Values[1]) OR (Attribute Operator Values[2]) OR ...@
--
-- The valid values for attributes of @SearchFilter@ depend on the API
-- action. For valid values, see the reference page for the API action
-- you\'re calling that takes a @SearchFilter@ parameter.
--
-- /See:/ 'newSearchFilter' smart constructor.
data SearchFilter = SearchFilter'
  { -- | The result attribute to which the filter values are applied. Valid
    -- values vary by API action.
    SearchFilter -> Maybe Text
attribute :: Prelude.Maybe Prelude.Text,
    -- | The list of values applied to the @Attribute@ and @Operator@ attributes.
    -- Number of values and valid values vary by @Attribute@.
    SearchFilter -> Maybe [Text]
values :: Prelude.Maybe [Prelude.Text],
    -- | The operator to apply to the @Attribute@ with each of the @Values@.
    -- Valid values vary by @Attribute@.
    SearchFilter -> Maybe Text
operator :: Prelude.Maybe Prelude.Text
  }
  deriving (SearchFilter -> SearchFilter -> Bool
(SearchFilter -> SearchFilter -> Bool)
-> (SearchFilter -> SearchFilter -> Bool) -> Eq SearchFilter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: SearchFilter -> SearchFilter -> Bool
$c/= :: SearchFilter -> SearchFilter -> Bool
== :: SearchFilter -> SearchFilter -> Bool
$c== :: SearchFilter -> SearchFilter -> Bool
Prelude.Eq, ReadPrec [SearchFilter]
ReadPrec SearchFilter
Int -> ReadS SearchFilter
ReadS [SearchFilter]
(Int -> ReadS SearchFilter)
-> ReadS [SearchFilter]
-> ReadPrec SearchFilter
-> ReadPrec [SearchFilter]
-> Read SearchFilter
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [SearchFilter]
$creadListPrec :: ReadPrec [SearchFilter]
readPrec :: ReadPrec SearchFilter
$creadPrec :: ReadPrec SearchFilter
readList :: ReadS [SearchFilter]
$creadList :: ReadS [SearchFilter]
readsPrec :: Int -> ReadS SearchFilter
$creadsPrec :: Int -> ReadS SearchFilter
Prelude.Read, Int -> SearchFilter -> ShowS
[SearchFilter] -> ShowS
SearchFilter -> String
(Int -> SearchFilter -> ShowS)
-> (SearchFilter -> String)
-> ([SearchFilter] -> ShowS)
-> Show SearchFilter
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [SearchFilter] -> ShowS
$cshowList :: [SearchFilter] -> ShowS
show :: SearchFilter -> String
$cshow :: SearchFilter -> String
showsPrec :: Int -> SearchFilter -> ShowS
$cshowsPrec :: Int -> SearchFilter -> ShowS
Prelude.Show, (forall x. SearchFilter -> Rep SearchFilter x)
-> (forall x. Rep SearchFilter x -> SearchFilter)
-> Generic SearchFilter
forall x. Rep SearchFilter x -> SearchFilter
forall x. SearchFilter -> Rep SearchFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep SearchFilter x -> SearchFilter
$cfrom :: forall x. SearchFilter -> Rep SearchFilter x
Prelude.Generic)

-- |
-- Create a value of 'SearchFilter' 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:
--
-- 'attribute', 'searchFilter_attribute' - The result attribute to which the filter values are applied. Valid
-- values vary by API action.
--
-- 'values', 'searchFilter_values' - The list of values applied to the @Attribute@ and @Operator@ attributes.
-- Number of values and valid values vary by @Attribute@.
--
-- 'operator', 'searchFilter_operator' - The operator to apply to the @Attribute@ with each of the @Values@.
-- Valid values vary by @Attribute@.
newSearchFilter ::
  SearchFilter
newSearchFilter :: SearchFilter
newSearchFilter =
  SearchFilter' :: Maybe Text -> Maybe [Text] -> Maybe Text -> SearchFilter
SearchFilter'
    { $sel:attribute:SearchFilter' :: Maybe Text
attribute = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:values:SearchFilter' :: Maybe [Text]
values = Maybe [Text]
forall a. Maybe a
Prelude.Nothing,
      $sel:operator:SearchFilter' :: Maybe Text
operator = Maybe Text
forall a. Maybe a
Prelude.Nothing
    }

-- | The result attribute to which the filter values are applied. Valid
-- values vary by API action.
searchFilter_attribute :: Lens.Lens' SearchFilter (Prelude.Maybe Prelude.Text)
searchFilter_attribute :: (Maybe Text -> f (Maybe Text)) -> SearchFilter -> f SearchFilter
searchFilter_attribute = (SearchFilter -> Maybe Text)
-> (SearchFilter -> Maybe Text -> SearchFilter)
-> Lens SearchFilter SearchFilter (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SearchFilter' {Maybe Text
attribute :: Maybe Text
$sel:attribute:SearchFilter' :: SearchFilter -> Maybe Text
attribute} -> Maybe Text
attribute) (\s :: SearchFilter
s@SearchFilter' {} Maybe Text
a -> SearchFilter
s {$sel:attribute:SearchFilter' :: Maybe Text
attribute = Maybe Text
a} :: SearchFilter)

-- | The list of values applied to the @Attribute@ and @Operator@ attributes.
-- Number of values and valid values vary by @Attribute@.
searchFilter_values :: Lens.Lens' SearchFilter (Prelude.Maybe [Prelude.Text])
searchFilter_values :: (Maybe [Text] -> f (Maybe [Text]))
-> SearchFilter -> f SearchFilter
searchFilter_values = (SearchFilter -> Maybe [Text])
-> (SearchFilter -> Maybe [Text] -> SearchFilter)
-> Lens SearchFilter SearchFilter (Maybe [Text]) (Maybe [Text])
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SearchFilter' {Maybe [Text]
values :: Maybe [Text]
$sel:values:SearchFilter' :: SearchFilter -> Maybe [Text]
values} -> Maybe [Text]
values) (\s :: SearchFilter
s@SearchFilter' {} Maybe [Text]
a -> SearchFilter
s {$sel:values:SearchFilter' :: Maybe [Text]
values = Maybe [Text]
a} :: SearchFilter) ((Maybe [Text] -> f (Maybe [Text]))
 -> SearchFilter -> f SearchFilter)
-> ((Maybe [Text] -> f (Maybe [Text]))
    -> Maybe [Text] -> f (Maybe [Text]))
-> (Maybe [Text] -> f (Maybe [Text]))
-> SearchFilter
-> f SearchFilter
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 operator to apply to the @Attribute@ with each of the @Values@.
-- Valid values vary by @Attribute@.
searchFilter_operator :: Lens.Lens' SearchFilter (Prelude.Maybe Prelude.Text)
searchFilter_operator :: (Maybe Text -> f (Maybe Text)) -> SearchFilter -> f SearchFilter
searchFilter_operator = (SearchFilter -> Maybe Text)
-> (SearchFilter -> Maybe Text -> SearchFilter)
-> Lens SearchFilter SearchFilter (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SearchFilter' {Maybe Text
operator :: Maybe Text
$sel:operator:SearchFilter' :: SearchFilter -> Maybe Text
operator} -> Maybe Text
operator) (\s :: SearchFilter
s@SearchFilter' {} Maybe Text
a -> SearchFilter
s {$sel:operator:SearchFilter' :: Maybe Text
operator = Maybe Text
a} :: SearchFilter)

instance Prelude.Hashable SearchFilter

instance Prelude.NFData SearchFilter

instance Core.ToQuery SearchFilter where
  toQuery :: SearchFilter -> QueryString
toQuery SearchFilter' {Maybe [Text]
Maybe Text
operator :: Maybe Text
values :: Maybe [Text]
attribute :: Maybe Text
$sel:operator:SearchFilter' :: SearchFilter -> Maybe Text
$sel:values:SearchFilter' :: SearchFilter -> Maybe [Text]
$sel:attribute:SearchFilter' :: SearchFilter -> Maybe Text
..} =
    [QueryString] -> QueryString
forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"Attribute" ByteString -> Maybe Text -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: Maybe Text
attribute,
        ByteString
"Values"
          ByteString -> QueryString -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: Maybe QueryString -> QueryString
forall a. ToQuery a => a -> QueryString
Core.toQuery
            (ByteString -> [Text] -> QueryString
forall a.
(IsList a, ToQuery (Item a)) =>
ByteString -> a -> QueryString
Core.toQueryList ByteString
"member" ([Text] -> QueryString) -> Maybe [Text] -> Maybe QueryString
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe [Text]
values),
        ByteString
"Operator" ByteString -> Maybe Text -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: Maybe Text
operator
      ]