{-# 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.Comprehend.Types.EntityRecognizerFilter
-- 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.Comprehend.Types.EntityRecognizerFilter where

import Amazonka.Comprehend.Types.ModelStatus
import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude

-- | Provides information for filtering a list of entity recognizers. You can
-- only specify one filtering parameter in a request. For more information,
-- see the operation.\/>
--
-- /See:/ 'newEntityRecognizerFilter' smart constructor.
data EntityRecognizerFilter = EntityRecognizerFilter'
  { -- | The status of an entity recognizer.
    EntityRecognizerFilter -> Maybe ModelStatus
status :: Prelude.Maybe ModelStatus,
    -- | Filters the list of entities based on the time that the list was
    -- submitted for processing. Returns only jobs submitted after the
    -- specified time. Jobs are returned in ascending order, oldest to newest.
    EntityRecognizerFilter -> Maybe POSIX
submitTimeAfter :: Prelude.Maybe Core.POSIX,
    -- | Filters the list of entities based on the time that the list was
    -- submitted for processing. Returns only jobs submitted before the
    -- specified time. Jobs are returned in descending order, newest to oldest.
    EntityRecognizerFilter -> Maybe POSIX
submitTimeBefore :: Prelude.Maybe Core.POSIX,
    -- | The name that you assigned the entity recognizer.
    EntityRecognizerFilter -> Maybe Text
recognizerName :: Prelude.Maybe Prelude.Text
  }
  deriving (EntityRecognizerFilter -> EntityRecognizerFilter -> Bool
(EntityRecognizerFilter -> EntityRecognizerFilter -> Bool)
-> (EntityRecognizerFilter -> EntityRecognizerFilter -> Bool)
-> Eq EntityRecognizerFilter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: EntityRecognizerFilter -> EntityRecognizerFilter -> Bool
$c/= :: EntityRecognizerFilter -> EntityRecognizerFilter -> Bool
== :: EntityRecognizerFilter -> EntityRecognizerFilter -> Bool
$c== :: EntityRecognizerFilter -> EntityRecognizerFilter -> Bool
Prelude.Eq, ReadPrec [EntityRecognizerFilter]
ReadPrec EntityRecognizerFilter
Int -> ReadS EntityRecognizerFilter
ReadS [EntityRecognizerFilter]
(Int -> ReadS EntityRecognizerFilter)
-> ReadS [EntityRecognizerFilter]
-> ReadPrec EntityRecognizerFilter
-> ReadPrec [EntityRecognizerFilter]
-> Read EntityRecognizerFilter
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [EntityRecognizerFilter]
$creadListPrec :: ReadPrec [EntityRecognizerFilter]
readPrec :: ReadPrec EntityRecognizerFilter
$creadPrec :: ReadPrec EntityRecognizerFilter
readList :: ReadS [EntityRecognizerFilter]
$creadList :: ReadS [EntityRecognizerFilter]
readsPrec :: Int -> ReadS EntityRecognizerFilter
$creadsPrec :: Int -> ReadS EntityRecognizerFilter
Prelude.Read, Int -> EntityRecognizerFilter -> ShowS
[EntityRecognizerFilter] -> ShowS
EntityRecognizerFilter -> String
(Int -> EntityRecognizerFilter -> ShowS)
-> (EntityRecognizerFilter -> String)
-> ([EntityRecognizerFilter] -> ShowS)
-> Show EntityRecognizerFilter
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [EntityRecognizerFilter] -> ShowS
$cshowList :: [EntityRecognizerFilter] -> ShowS
show :: EntityRecognizerFilter -> String
$cshow :: EntityRecognizerFilter -> String
showsPrec :: Int -> EntityRecognizerFilter -> ShowS
$cshowsPrec :: Int -> EntityRecognizerFilter -> ShowS
Prelude.Show, (forall x. EntityRecognizerFilter -> Rep EntityRecognizerFilter x)
-> (forall x.
    Rep EntityRecognizerFilter x -> EntityRecognizerFilter)
-> Generic EntityRecognizerFilter
forall x. Rep EntityRecognizerFilter x -> EntityRecognizerFilter
forall x. EntityRecognizerFilter -> Rep EntityRecognizerFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep EntityRecognizerFilter x -> EntityRecognizerFilter
$cfrom :: forall x. EntityRecognizerFilter -> Rep EntityRecognizerFilter x
Prelude.Generic)

-- |
-- Create a value of 'EntityRecognizerFilter' 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:
--
-- 'status', 'entityRecognizerFilter_status' - The status of an entity recognizer.
--
-- 'submitTimeAfter', 'entityRecognizerFilter_submitTimeAfter' - Filters the list of entities based on the time that the list was
-- submitted for processing. Returns only jobs submitted after the
-- specified time. Jobs are returned in ascending order, oldest to newest.
--
-- 'submitTimeBefore', 'entityRecognizerFilter_submitTimeBefore' - Filters the list of entities based on the time that the list was
-- submitted for processing. Returns only jobs submitted before the
-- specified time. Jobs are returned in descending order, newest to oldest.
--
-- 'recognizerName', 'entityRecognizerFilter_recognizerName' - The name that you assigned the entity recognizer.
newEntityRecognizerFilter ::
  EntityRecognizerFilter
newEntityRecognizerFilter :: EntityRecognizerFilter
newEntityRecognizerFilter =
  EntityRecognizerFilter' :: Maybe ModelStatus
-> Maybe POSIX
-> Maybe POSIX
-> Maybe Text
-> EntityRecognizerFilter
EntityRecognizerFilter'
    { $sel:status:EntityRecognizerFilter' :: Maybe ModelStatus
status = Maybe ModelStatus
forall a. Maybe a
Prelude.Nothing,
      $sel:submitTimeAfter:EntityRecognizerFilter' :: Maybe POSIX
submitTimeAfter = Maybe POSIX
forall a. Maybe a
Prelude.Nothing,
      $sel:submitTimeBefore:EntityRecognizerFilter' :: Maybe POSIX
submitTimeBefore = Maybe POSIX
forall a. Maybe a
Prelude.Nothing,
      $sel:recognizerName:EntityRecognizerFilter' :: Maybe Text
recognizerName = Maybe Text
forall a. Maybe a
Prelude.Nothing
    }

-- | The status of an entity recognizer.
entityRecognizerFilter_status :: Lens.Lens' EntityRecognizerFilter (Prelude.Maybe ModelStatus)
entityRecognizerFilter_status :: (Maybe ModelStatus -> f (Maybe ModelStatus))
-> EntityRecognizerFilter -> f EntityRecognizerFilter
entityRecognizerFilter_status = (EntityRecognizerFilter -> Maybe ModelStatus)
-> (EntityRecognizerFilter
    -> Maybe ModelStatus -> EntityRecognizerFilter)
-> Lens
     EntityRecognizerFilter
     EntityRecognizerFilter
     (Maybe ModelStatus)
     (Maybe ModelStatus)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EntityRecognizerFilter' {Maybe ModelStatus
status :: Maybe ModelStatus
$sel:status:EntityRecognizerFilter' :: EntityRecognizerFilter -> Maybe ModelStatus
status} -> Maybe ModelStatus
status) (\s :: EntityRecognizerFilter
s@EntityRecognizerFilter' {} Maybe ModelStatus
a -> EntityRecognizerFilter
s {$sel:status:EntityRecognizerFilter' :: Maybe ModelStatus
status = Maybe ModelStatus
a} :: EntityRecognizerFilter)

-- | Filters the list of entities based on the time that the list was
-- submitted for processing. Returns only jobs submitted after the
-- specified time. Jobs are returned in ascending order, oldest to newest.
entityRecognizerFilter_submitTimeAfter :: Lens.Lens' EntityRecognizerFilter (Prelude.Maybe Prelude.UTCTime)
entityRecognizerFilter_submitTimeAfter :: (Maybe UTCTime -> f (Maybe UTCTime))
-> EntityRecognizerFilter -> f EntityRecognizerFilter
entityRecognizerFilter_submitTimeAfter = (EntityRecognizerFilter -> Maybe POSIX)
-> (EntityRecognizerFilter
    -> Maybe POSIX -> EntityRecognizerFilter)
-> Lens
     EntityRecognizerFilter
     EntityRecognizerFilter
     (Maybe POSIX)
     (Maybe POSIX)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EntityRecognizerFilter' {Maybe POSIX
submitTimeAfter :: Maybe POSIX
$sel:submitTimeAfter:EntityRecognizerFilter' :: EntityRecognizerFilter -> Maybe POSIX
submitTimeAfter} -> Maybe POSIX
submitTimeAfter) (\s :: EntityRecognizerFilter
s@EntityRecognizerFilter' {} Maybe POSIX
a -> EntityRecognizerFilter
s {$sel:submitTimeAfter:EntityRecognizerFilter' :: Maybe POSIX
submitTimeAfter = Maybe POSIX
a} :: EntityRecognizerFilter) ((Maybe POSIX -> f (Maybe POSIX))
 -> EntityRecognizerFilter -> f EntityRecognizerFilter)
-> ((Maybe UTCTime -> f (Maybe UTCTime))
    -> Maybe POSIX -> f (Maybe POSIX))
-> (Maybe UTCTime -> f (Maybe UTCTime))
-> EntityRecognizerFilter
-> f EntityRecognizerFilter
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso POSIX POSIX UTCTime UTCTime
-> Iso (Maybe POSIX) (Maybe POSIX) (Maybe UTCTime) (Maybe UTCTime)
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 POSIX POSIX UTCTime UTCTime
forall (a :: Format). Iso' (Time a) UTCTime
Core._Time

-- | Filters the list of entities based on the time that the list was
-- submitted for processing. Returns only jobs submitted before the
-- specified time. Jobs are returned in descending order, newest to oldest.
entityRecognizerFilter_submitTimeBefore :: Lens.Lens' EntityRecognizerFilter (Prelude.Maybe Prelude.UTCTime)
entityRecognizerFilter_submitTimeBefore :: (Maybe UTCTime -> f (Maybe UTCTime))
-> EntityRecognizerFilter -> f EntityRecognizerFilter
entityRecognizerFilter_submitTimeBefore = (EntityRecognizerFilter -> Maybe POSIX)
-> (EntityRecognizerFilter
    -> Maybe POSIX -> EntityRecognizerFilter)
-> Lens
     EntityRecognizerFilter
     EntityRecognizerFilter
     (Maybe POSIX)
     (Maybe POSIX)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EntityRecognizerFilter' {Maybe POSIX
submitTimeBefore :: Maybe POSIX
$sel:submitTimeBefore:EntityRecognizerFilter' :: EntityRecognizerFilter -> Maybe POSIX
submitTimeBefore} -> Maybe POSIX
submitTimeBefore) (\s :: EntityRecognizerFilter
s@EntityRecognizerFilter' {} Maybe POSIX
a -> EntityRecognizerFilter
s {$sel:submitTimeBefore:EntityRecognizerFilter' :: Maybe POSIX
submitTimeBefore = Maybe POSIX
a} :: EntityRecognizerFilter) ((Maybe POSIX -> f (Maybe POSIX))
 -> EntityRecognizerFilter -> f EntityRecognizerFilter)
-> ((Maybe UTCTime -> f (Maybe UTCTime))
    -> Maybe POSIX -> f (Maybe POSIX))
-> (Maybe UTCTime -> f (Maybe UTCTime))
-> EntityRecognizerFilter
-> f EntityRecognizerFilter
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso POSIX POSIX UTCTime UTCTime
-> Iso (Maybe POSIX) (Maybe POSIX) (Maybe UTCTime) (Maybe UTCTime)
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 POSIX POSIX UTCTime UTCTime
forall (a :: Format). Iso' (Time a) UTCTime
Core._Time

-- | The name that you assigned the entity recognizer.
entityRecognizerFilter_recognizerName :: Lens.Lens' EntityRecognizerFilter (Prelude.Maybe Prelude.Text)
entityRecognizerFilter_recognizerName :: (Maybe Text -> f (Maybe Text))
-> EntityRecognizerFilter -> f EntityRecognizerFilter
entityRecognizerFilter_recognizerName = (EntityRecognizerFilter -> Maybe Text)
-> (EntityRecognizerFilter -> Maybe Text -> EntityRecognizerFilter)
-> Lens
     EntityRecognizerFilter
     EntityRecognizerFilter
     (Maybe Text)
     (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EntityRecognizerFilter' {Maybe Text
recognizerName :: Maybe Text
$sel:recognizerName:EntityRecognizerFilter' :: EntityRecognizerFilter -> Maybe Text
recognizerName} -> Maybe Text
recognizerName) (\s :: EntityRecognizerFilter
s@EntityRecognizerFilter' {} Maybe Text
a -> EntityRecognizerFilter
s {$sel:recognizerName:EntityRecognizerFilter' :: Maybe Text
recognizerName = Maybe Text
a} :: EntityRecognizerFilter)

instance Prelude.Hashable EntityRecognizerFilter

instance Prelude.NFData EntityRecognizerFilter

instance Core.ToJSON EntityRecognizerFilter where
  toJSON :: EntityRecognizerFilter -> Value
toJSON EntityRecognizerFilter' {Maybe Text
Maybe POSIX
Maybe ModelStatus
recognizerName :: Maybe Text
submitTimeBefore :: Maybe POSIX
submitTimeAfter :: Maybe POSIX
status :: Maybe ModelStatus
$sel:recognizerName:EntityRecognizerFilter' :: EntityRecognizerFilter -> Maybe Text
$sel:submitTimeBefore:EntityRecognizerFilter' :: EntityRecognizerFilter -> Maybe POSIX
$sel:submitTimeAfter:EntityRecognizerFilter' :: EntityRecognizerFilter -> Maybe POSIX
$sel:status:EntityRecognizerFilter' :: EntityRecognizerFilter -> Maybe ModelStatus
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"Status" Text -> ModelStatus -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (ModelStatus -> Pair) -> Maybe ModelStatus -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe ModelStatus
status,
            (Text
"SubmitTimeAfter" Text -> POSIX -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=)
              (POSIX -> Pair) -> Maybe POSIX -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe POSIX
submitTimeAfter,
            (Text
"SubmitTimeBefore" Text -> POSIX -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=)
              (POSIX -> Pair) -> Maybe POSIX -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe POSIX
submitTimeBefore,
            (Text
"RecognizerName" 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
recognizerName
          ]
      )