{-# 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.CloudFormation.Types.TypeFilters
-- 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.CloudFormation.Types.TypeFilters where

import Amazonka.CloudFormation.Types.Category
import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude

-- | Filter criteria to use in determining which extensions to return.
--
-- /See:/ 'newTypeFilters' smart constructor.
data TypeFilters = TypeFilters'
  { -- | A prefix to use as a filter for results.
    TypeFilters -> Maybe Text
typeNamePrefix :: Prelude.Maybe Prelude.Text,
    -- | The category of extensions to return.
    --
    -- -   @REGISTERED@: Private extensions that have been registered for this
    --     account and region.
    --
    -- -   @ACTIVATED@: Public extensions that have been activated for this
    --     account and region.
    --
    -- -   @THIRD-PARTY@: Extensions available for use from publishers other
    --     than Amazon. This includes:
    --
    --     -   Private extensions registered in the account.
    --
    --     -   Public extensions from publishers other than Amazon, whether
    --         activated or not.
    --
    -- -   @AWS-TYPES@: Extensions available for use from Amazon.
    TypeFilters -> Maybe Category
category :: Prelude.Maybe Category,
    -- | The id of the publisher of the extension.
    --
    -- Extensions published by Amazon are not assigned a publisher ID. Use the
    -- @AWS-TYPES@ category to specify a list of types published by Amazon.
    TypeFilters -> Maybe Text
publisherId :: Prelude.Maybe Prelude.Text
  }
  deriving (TypeFilters -> TypeFilters -> Bool
(TypeFilters -> TypeFilters -> Bool)
-> (TypeFilters -> TypeFilters -> Bool) -> Eq TypeFilters
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: TypeFilters -> TypeFilters -> Bool
$c/= :: TypeFilters -> TypeFilters -> Bool
== :: TypeFilters -> TypeFilters -> Bool
$c== :: TypeFilters -> TypeFilters -> Bool
Prelude.Eq, ReadPrec [TypeFilters]
ReadPrec TypeFilters
Int -> ReadS TypeFilters
ReadS [TypeFilters]
(Int -> ReadS TypeFilters)
-> ReadS [TypeFilters]
-> ReadPrec TypeFilters
-> ReadPrec [TypeFilters]
-> Read TypeFilters
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [TypeFilters]
$creadListPrec :: ReadPrec [TypeFilters]
readPrec :: ReadPrec TypeFilters
$creadPrec :: ReadPrec TypeFilters
readList :: ReadS [TypeFilters]
$creadList :: ReadS [TypeFilters]
readsPrec :: Int -> ReadS TypeFilters
$creadsPrec :: Int -> ReadS TypeFilters
Prelude.Read, Int -> TypeFilters -> ShowS
[TypeFilters] -> ShowS
TypeFilters -> String
(Int -> TypeFilters -> ShowS)
-> (TypeFilters -> String)
-> ([TypeFilters] -> ShowS)
-> Show TypeFilters
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [TypeFilters] -> ShowS
$cshowList :: [TypeFilters] -> ShowS
show :: TypeFilters -> String
$cshow :: TypeFilters -> String
showsPrec :: Int -> TypeFilters -> ShowS
$cshowsPrec :: Int -> TypeFilters -> ShowS
Prelude.Show, (forall x. TypeFilters -> Rep TypeFilters x)
-> (forall x. Rep TypeFilters x -> TypeFilters)
-> Generic TypeFilters
forall x. Rep TypeFilters x -> TypeFilters
forall x. TypeFilters -> Rep TypeFilters x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep TypeFilters x -> TypeFilters
$cfrom :: forall x. TypeFilters -> Rep TypeFilters x
Prelude.Generic)

-- |
-- Create a value of 'TypeFilters' 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:
--
-- 'typeNamePrefix', 'typeFilters_typeNamePrefix' - A prefix to use as a filter for results.
--
-- 'category', 'typeFilters_category' - The category of extensions to return.
--
-- -   @REGISTERED@: Private extensions that have been registered for this
--     account and region.
--
-- -   @ACTIVATED@: Public extensions that have been activated for this
--     account and region.
--
-- -   @THIRD-PARTY@: Extensions available for use from publishers other
--     than Amazon. This includes:
--
--     -   Private extensions registered in the account.
--
--     -   Public extensions from publishers other than Amazon, whether
--         activated or not.
--
-- -   @AWS-TYPES@: Extensions available for use from Amazon.
--
-- 'publisherId', 'typeFilters_publisherId' - The id of the publisher of the extension.
--
-- Extensions published by Amazon are not assigned a publisher ID. Use the
-- @AWS-TYPES@ category to specify a list of types published by Amazon.
newTypeFilters ::
  TypeFilters
newTypeFilters :: TypeFilters
newTypeFilters =
  TypeFilters' :: Maybe Text -> Maybe Category -> Maybe Text -> TypeFilters
TypeFilters'
    { $sel:typeNamePrefix:TypeFilters' :: Maybe Text
typeNamePrefix = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:category:TypeFilters' :: Maybe Category
category = Maybe Category
forall a. Maybe a
Prelude.Nothing,
      $sel:publisherId:TypeFilters' :: Maybe Text
publisherId = Maybe Text
forall a. Maybe a
Prelude.Nothing
    }

-- | A prefix to use as a filter for results.
typeFilters_typeNamePrefix :: Lens.Lens' TypeFilters (Prelude.Maybe Prelude.Text)
typeFilters_typeNamePrefix :: (Maybe Text -> f (Maybe Text)) -> TypeFilters -> f TypeFilters
typeFilters_typeNamePrefix = (TypeFilters -> Maybe Text)
-> (TypeFilters -> Maybe Text -> TypeFilters)
-> Lens TypeFilters TypeFilters (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TypeFilters' {Maybe Text
typeNamePrefix :: Maybe Text
$sel:typeNamePrefix:TypeFilters' :: TypeFilters -> Maybe Text
typeNamePrefix} -> Maybe Text
typeNamePrefix) (\s :: TypeFilters
s@TypeFilters' {} Maybe Text
a -> TypeFilters
s {$sel:typeNamePrefix:TypeFilters' :: Maybe Text
typeNamePrefix = Maybe Text
a} :: TypeFilters)

-- | The category of extensions to return.
--
-- -   @REGISTERED@: Private extensions that have been registered for this
--     account and region.
--
-- -   @ACTIVATED@: Public extensions that have been activated for this
--     account and region.
--
-- -   @THIRD-PARTY@: Extensions available for use from publishers other
--     than Amazon. This includes:
--
--     -   Private extensions registered in the account.
--
--     -   Public extensions from publishers other than Amazon, whether
--         activated or not.
--
-- -   @AWS-TYPES@: Extensions available for use from Amazon.
typeFilters_category :: Lens.Lens' TypeFilters (Prelude.Maybe Category)
typeFilters_category :: (Maybe Category -> f (Maybe Category))
-> TypeFilters -> f TypeFilters
typeFilters_category = (TypeFilters -> Maybe Category)
-> (TypeFilters -> Maybe Category -> TypeFilters)
-> Lens TypeFilters TypeFilters (Maybe Category) (Maybe Category)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TypeFilters' {Maybe Category
category :: Maybe Category
$sel:category:TypeFilters' :: TypeFilters -> Maybe Category
category} -> Maybe Category
category) (\s :: TypeFilters
s@TypeFilters' {} Maybe Category
a -> TypeFilters
s {$sel:category:TypeFilters' :: Maybe Category
category = Maybe Category
a} :: TypeFilters)

-- | The id of the publisher of the extension.
--
-- Extensions published by Amazon are not assigned a publisher ID. Use the
-- @AWS-TYPES@ category to specify a list of types published by Amazon.
typeFilters_publisherId :: Lens.Lens' TypeFilters (Prelude.Maybe Prelude.Text)
typeFilters_publisherId :: (Maybe Text -> f (Maybe Text)) -> TypeFilters -> f TypeFilters
typeFilters_publisherId = (TypeFilters -> Maybe Text)
-> (TypeFilters -> Maybe Text -> TypeFilters)
-> Lens TypeFilters TypeFilters (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TypeFilters' {Maybe Text
publisherId :: Maybe Text
$sel:publisherId:TypeFilters' :: TypeFilters -> Maybe Text
publisherId} -> Maybe Text
publisherId) (\s :: TypeFilters
s@TypeFilters' {} Maybe Text
a -> TypeFilters
s {$sel:publisherId:TypeFilters' :: Maybe Text
publisherId = Maybe Text
a} :: TypeFilters)

instance Prelude.Hashable TypeFilters

instance Prelude.NFData TypeFilters

instance Core.ToQuery TypeFilters where
  toQuery :: TypeFilters -> QueryString
toQuery TypeFilters' {Maybe Text
Maybe Category
publisherId :: Maybe Text
category :: Maybe Category
typeNamePrefix :: Maybe Text
$sel:publisherId:TypeFilters' :: TypeFilters -> Maybe Text
$sel:category:TypeFilters' :: TypeFilters -> Maybe Category
$sel:typeNamePrefix:TypeFilters' :: TypeFilters -> Maybe Text
..} =
    [QueryString] -> QueryString
forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"TypeNamePrefix" ByteString -> Maybe Text -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: Maybe Text
typeNamePrefix,
        ByteString
"Category" ByteString -> Maybe Category -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: Maybe Category
category,
        ByteString
"PublisherId" ByteString -> Maybe Text -> QueryString
forall a. ToQuery a => ByteString -> a -> QueryString
Core.=: Maybe Text
publisherId
      ]