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

import Amazonka.Comprehend.Types.ModelStatus
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

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

-- |
-- Create a value of 'DocumentClassifierFilter' 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:
--
-- 'documentClassifierName', 'documentClassifierFilter_documentClassifierName' - The name that you assigned to the document classifier
--
-- 'status', 'documentClassifierFilter_status' - Filters the list of classifiers based on status.
--
-- 'submitTimeAfter', 'documentClassifierFilter_submitTimeAfter' - Filters the list of classifiers based on the time that the classifier
-- was submitted for processing. Returns only classifiers submitted after
-- the specified time. Classifiers are returned in descending order, newest
-- to oldest.
--
-- 'submitTimeBefore', 'documentClassifierFilter_submitTimeBefore' - Filters the list of classifiers based on the time that the classifier
-- was submitted for processing. Returns only classifiers submitted before
-- the specified time. Classifiers are returned in ascending order, oldest
-- to newest.
newDocumentClassifierFilter ::
  DocumentClassifierFilter
newDocumentClassifierFilter :: DocumentClassifierFilter
newDocumentClassifierFilter =
  DocumentClassifierFilter'
    { $sel:documentClassifierName:DocumentClassifierFilter' :: Maybe Text
documentClassifierName =
        forall a. Maybe a
Prelude.Nothing,
      $sel:status:DocumentClassifierFilter' :: Maybe ModelStatus
status = forall a. Maybe a
Prelude.Nothing,
      $sel:submitTimeAfter:DocumentClassifierFilter' :: Maybe POSIX
submitTimeAfter = forall a. Maybe a
Prelude.Nothing,
      $sel:submitTimeBefore:DocumentClassifierFilter' :: Maybe POSIX
submitTimeBefore = forall a. Maybe a
Prelude.Nothing
    }

-- | The name that you assigned to the document classifier
documentClassifierFilter_documentClassifierName :: Lens.Lens' DocumentClassifierFilter (Prelude.Maybe Prelude.Text)
documentClassifierFilter_documentClassifierName :: Lens' DocumentClassifierFilter (Maybe Text)
documentClassifierFilter_documentClassifierName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentClassifierFilter' {Maybe Text
documentClassifierName :: Maybe Text
$sel:documentClassifierName:DocumentClassifierFilter' :: DocumentClassifierFilter -> Maybe Text
documentClassifierName} -> Maybe Text
documentClassifierName) (\s :: DocumentClassifierFilter
s@DocumentClassifierFilter' {} Maybe Text
a -> DocumentClassifierFilter
s {$sel:documentClassifierName:DocumentClassifierFilter' :: Maybe Text
documentClassifierName = Maybe Text
a} :: DocumentClassifierFilter)

-- | Filters the list of classifiers based on status.
documentClassifierFilter_status :: Lens.Lens' DocumentClassifierFilter (Prelude.Maybe ModelStatus)
documentClassifierFilter_status :: Lens' DocumentClassifierFilter (Maybe ModelStatus)
documentClassifierFilter_status = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentClassifierFilter' {Maybe ModelStatus
status :: Maybe ModelStatus
$sel:status:DocumentClassifierFilter' :: DocumentClassifierFilter -> Maybe ModelStatus
status} -> Maybe ModelStatus
status) (\s :: DocumentClassifierFilter
s@DocumentClassifierFilter' {} Maybe ModelStatus
a -> DocumentClassifierFilter
s {$sel:status:DocumentClassifierFilter' :: Maybe ModelStatus
status = Maybe ModelStatus
a} :: DocumentClassifierFilter)

-- | Filters the list of classifiers based on the time that the classifier
-- was submitted for processing. Returns only classifiers submitted after
-- the specified time. Classifiers are returned in descending order, newest
-- to oldest.
documentClassifierFilter_submitTimeAfter :: Lens.Lens' DocumentClassifierFilter (Prelude.Maybe Prelude.UTCTime)
documentClassifierFilter_submitTimeAfter :: Lens' DocumentClassifierFilter (Maybe UTCTime)
documentClassifierFilter_submitTimeAfter = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentClassifierFilter' {Maybe POSIX
submitTimeAfter :: Maybe POSIX
$sel:submitTimeAfter:DocumentClassifierFilter' :: DocumentClassifierFilter -> Maybe POSIX
submitTimeAfter} -> Maybe POSIX
submitTimeAfter) (\s :: DocumentClassifierFilter
s@DocumentClassifierFilter' {} Maybe POSIX
a -> DocumentClassifierFilter
s {$sel:submitTimeAfter:DocumentClassifierFilter' :: Maybe POSIX
submitTimeAfter = Maybe POSIX
a} :: DocumentClassifierFilter) 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 (a :: Format). Iso' (Time a) UTCTime
Data._Time

-- | Filters the list of classifiers based on the time that the classifier
-- was submitted for processing. Returns only classifiers submitted before
-- the specified time. Classifiers are returned in ascending order, oldest
-- to newest.
documentClassifierFilter_submitTimeBefore :: Lens.Lens' DocumentClassifierFilter (Prelude.Maybe Prelude.UTCTime)
documentClassifierFilter_submitTimeBefore :: Lens' DocumentClassifierFilter (Maybe UTCTime)
documentClassifierFilter_submitTimeBefore = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentClassifierFilter' {Maybe POSIX
submitTimeBefore :: Maybe POSIX
$sel:submitTimeBefore:DocumentClassifierFilter' :: DocumentClassifierFilter -> Maybe POSIX
submitTimeBefore} -> Maybe POSIX
submitTimeBefore) (\s :: DocumentClassifierFilter
s@DocumentClassifierFilter' {} Maybe POSIX
a -> DocumentClassifierFilter
s {$sel:submitTimeBefore:DocumentClassifierFilter' :: Maybe POSIX
submitTimeBefore = Maybe POSIX
a} :: DocumentClassifierFilter) 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 (a :: Format). Iso' (Time a) UTCTime
Data._Time

instance Prelude.Hashable DocumentClassifierFilter where
  hashWithSalt :: Int -> DocumentClassifierFilter -> Int
hashWithSalt Int
_salt DocumentClassifierFilter' {Maybe Text
Maybe POSIX
Maybe ModelStatus
submitTimeBefore :: Maybe POSIX
submitTimeAfter :: Maybe POSIX
status :: Maybe ModelStatus
documentClassifierName :: Maybe Text
$sel:submitTimeBefore:DocumentClassifierFilter' :: DocumentClassifierFilter -> Maybe POSIX
$sel:submitTimeAfter:DocumentClassifierFilter' :: DocumentClassifierFilter -> Maybe POSIX
$sel:status:DocumentClassifierFilter' :: DocumentClassifierFilter -> Maybe ModelStatus
$sel:documentClassifierName:DocumentClassifierFilter' :: DocumentClassifierFilter -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
documentClassifierName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ModelStatus
status
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
submitTimeAfter
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
submitTimeBefore

instance Prelude.NFData DocumentClassifierFilter where
  rnf :: DocumentClassifierFilter -> ()
rnf DocumentClassifierFilter' {Maybe Text
Maybe POSIX
Maybe ModelStatus
submitTimeBefore :: Maybe POSIX
submitTimeAfter :: Maybe POSIX
status :: Maybe ModelStatus
documentClassifierName :: Maybe Text
$sel:submitTimeBefore:DocumentClassifierFilter' :: DocumentClassifierFilter -> Maybe POSIX
$sel:submitTimeAfter:DocumentClassifierFilter' :: DocumentClassifierFilter -> Maybe POSIX
$sel:status:DocumentClassifierFilter' :: DocumentClassifierFilter -> Maybe ModelStatus
$sel:documentClassifierName:DocumentClassifierFilter' :: DocumentClassifierFilter -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
documentClassifierName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ModelStatus
status
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
submitTimeAfter
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
submitTimeBefore

instance Data.ToJSON DocumentClassifierFilter where
  toJSON :: DocumentClassifierFilter -> Value
toJSON DocumentClassifierFilter' {Maybe Text
Maybe POSIX
Maybe ModelStatus
submitTimeBefore :: Maybe POSIX
submitTimeAfter :: Maybe POSIX
status :: Maybe ModelStatus
documentClassifierName :: Maybe Text
$sel:submitTimeBefore:DocumentClassifierFilter' :: DocumentClassifierFilter -> Maybe POSIX
$sel:submitTimeAfter:DocumentClassifierFilter' :: DocumentClassifierFilter -> Maybe POSIX
$sel:status:DocumentClassifierFilter' :: DocumentClassifierFilter -> Maybe ModelStatus
$sel:documentClassifierName:DocumentClassifierFilter' :: DocumentClassifierFilter -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"DocumentClassifierName" 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
documentClassifierName,
            (Key
"Status" 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 ModelStatus
status,
            (Key
"SubmitTimeAfter" 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 POSIX
submitTimeAfter,
            (Key
"SubmitTimeBefore" 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 POSIX
submitTimeBefore
          ]
      )