{-# 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.DocumentClassificationJobFilter
-- 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.DocumentClassificationJobFilter where

import Amazonka.Comprehend.Types.JobStatus
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 document classification
-- jobs. For more information, see the operation. You can provide only one
-- filter parameter in each request.
--
-- /See:/ 'newDocumentClassificationJobFilter' smart constructor.
data DocumentClassificationJobFilter = DocumentClassificationJobFilter'
  { -- | Filters the list of jobs based on the time that the job was submitted
    -- for processing. Returns only jobs submitted after the specified time.
    -- Jobs are returned in descending order, newest to oldest.
    DocumentClassificationJobFilter -> Maybe POSIX
submitTimeAfter :: Prelude.Maybe Core.POSIX,
    -- | Filters the list of jobs based on the time that the job was submitted
    -- for processing. Returns only jobs submitted before the specified time.
    -- Jobs are returned in ascending order, oldest to newest.
    DocumentClassificationJobFilter -> Maybe POSIX
submitTimeBefore :: Prelude.Maybe Core.POSIX,
    -- | Filters on the name of the job.
    DocumentClassificationJobFilter -> Maybe Text
jobName :: Prelude.Maybe Prelude.Text,
    -- | Filters the list based on job status. Returns only jobs with the
    -- specified status.
    DocumentClassificationJobFilter -> Maybe JobStatus
jobStatus :: Prelude.Maybe JobStatus
  }
  deriving (DocumentClassificationJobFilter
-> DocumentClassificationJobFilter -> Bool
(DocumentClassificationJobFilter
 -> DocumentClassificationJobFilter -> Bool)
-> (DocumentClassificationJobFilter
    -> DocumentClassificationJobFilter -> Bool)
-> Eq DocumentClassificationJobFilter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DocumentClassificationJobFilter
-> DocumentClassificationJobFilter -> Bool
$c/= :: DocumentClassificationJobFilter
-> DocumentClassificationJobFilter -> Bool
== :: DocumentClassificationJobFilter
-> DocumentClassificationJobFilter -> Bool
$c== :: DocumentClassificationJobFilter
-> DocumentClassificationJobFilter -> Bool
Prelude.Eq, ReadPrec [DocumentClassificationJobFilter]
ReadPrec DocumentClassificationJobFilter
Int -> ReadS DocumentClassificationJobFilter
ReadS [DocumentClassificationJobFilter]
(Int -> ReadS DocumentClassificationJobFilter)
-> ReadS [DocumentClassificationJobFilter]
-> ReadPrec DocumentClassificationJobFilter
-> ReadPrec [DocumentClassificationJobFilter]
-> Read DocumentClassificationJobFilter
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DocumentClassificationJobFilter]
$creadListPrec :: ReadPrec [DocumentClassificationJobFilter]
readPrec :: ReadPrec DocumentClassificationJobFilter
$creadPrec :: ReadPrec DocumentClassificationJobFilter
readList :: ReadS [DocumentClassificationJobFilter]
$creadList :: ReadS [DocumentClassificationJobFilter]
readsPrec :: Int -> ReadS DocumentClassificationJobFilter
$creadsPrec :: Int -> ReadS DocumentClassificationJobFilter
Prelude.Read, Int -> DocumentClassificationJobFilter -> ShowS
[DocumentClassificationJobFilter] -> ShowS
DocumentClassificationJobFilter -> String
(Int -> DocumentClassificationJobFilter -> ShowS)
-> (DocumentClassificationJobFilter -> String)
-> ([DocumentClassificationJobFilter] -> ShowS)
-> Show DocumentClassificationJobFilter
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DocumentClassificationJobFilter] -> ShowS
$cshowList :: [DocumentClassificationJobFilter] -> ShowS
show :: DocumentClassificationJobFilter -> String
$cshow :: DocumentClassificationJobFilter -> String
showsPrec :: Int -> DocumentClassificationJobFilter -> ShowS
$cshowsPrec :: Int -> DocumentClassificationJobFilter -> ShowS
Prelude.Show, (forall x.
 DocumentClassificationJobFilter
 -> Rep DocumentClassificationJobFilter x)
-> (forall x.
    Rep DocumentClassificationJobFilter x
    -> DocumentClassificationJobFilter)
-> Generic DocumentClassificationJobFilter
forall x.
Rep DocumentClassificationJobFilter x
-> DocumentClassificationJobFilter
forall x.
DocumentClassificationJobFilter
-> Rep DocumentClassificationJobFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DocumentClassificationJobFilter x
-> DocumentClassificationJobFilter
$cfrom :: forall x.
DocumentClassificationJobFilter
-> Rep DocumentClassificationJobFilter x
Prelude.Generic)

-- |
-- Create a value of 'DocumentClassificationJobFilter' 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:
--
-- 'submitTimeAfter', 'documentClassificationJobFilter_submitTimeAfter' - Filters the list of jobs based on the time that the job was submitted
-- for processing. Returns only jobs submitted after the specified time.
-- Jobs are returned in descending order, newest to oldest.
--
-- 'submitTimeBefore', 'documentClassificationJobFilter_submitTimeBefore' - Filters the list of jobs based on the time that the job was submitted
-- for processing. Returns only jobs submitted before the specified time.
-- Jobs are returned in ascending order, oldest to newest.
--
-- 'jobName', 'documentClassificationJobFilter_jobName' - Filters on the name of the job.
--
-- 'jobStatus', 'documentClassificationJobFilter_jobStatus' - Filters the list based on job status. Returns only jobs with the
-- specified status.
newDocumentClassificationJobFilter ::
  DocumentClassificationJobFilter
newDocumentClassificationJobFilter :: DocumentClassificationJobFilter
newDocumentClassificationJobFilter =
  DocumentClassificationJobFilter' :: Maybe POSIX
-> Maybe POSIX
-> Maybe Text
-> Maybe JobStatus
-> DocumentClassificationJobFilter
DocumentClassificationJobFilter'
    { $sel:submitTimeAfter:DocumentClassificationJobFilter' :: Maybe POSIX
submitTimeAfter =
        Maybe POSIX
forall a. Maybe a
Prelude.Nothing,
      $sel:submitTimeBefore:DocumentClassificationJobFilter' :: Maybe POSIX
submitTimeBefore = Maybe POSIX
forall a. Maybe a
Prelude.Nothing,
      $sel:jobName:DocumentClassificationJobFilter' :: Maybe Text
jobName = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:jobStatus:DocumentClassificationJobFilter' :: Maybe JobStatus
jobStatus = Maybe JobStatus
forall a. Maybe a
Prelude.Nothing
    }

-- | Filters the list of jobs based on the time that the job was submitted
-- for processing. Returns only jobs submitted after the specified time.
-- Jobs are returned in descending order, newest to oldest.
documentClassificationJobFilter_submitTimeAfter :: Lens.Lens' DocumentClassificationJobFilter (Prelude.Maybe Prelude.UTCTime)
documentClassificationJobFilter_submitTimeAfter :: (Maybe UTCTime -> f (Maybe UTCTime))
-> DocumentClassificationJobFilter
-> f DocumentClassificationJobFilter
documentClassificationJobFilter_submitTimeAfter = (DocumentClassificationJobFilter -> Maybe POSIX)
-> (DocumentClassificationJobFilter
    -> Maybe POSIX -> DocumentClassificationJobFilter)
-> Lens
     DocumentClassificationJobFilter
     DocumentClassificationJobFilter
     (Maybe POSIX)
     (Maybe POSIX)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentClassificationJobFilter' {Maybe POSIX
submitTimeAfter :: Maybe POSIX
$sel:submitTimeAfter:DocumentClassificationJobFilter' :: DocumentClassificationJobFilter -> Maybe POSIX
submitTimeAfter} -> Maybe POSIX
submitTimeAfter) (\s :: DocumentClassificationJobFilter
s@DocumentClassificationJobFilter' {} Maybe POSIX
a -> DocumentClassificationJobFilter
s {$sel:submitTimeAfter:DocumentClassificationJobFilter' :: Maybe POSIX
submitTimeAfter = Maybe POSIX
a} :: DocumentClassificationJobFilter) ((Maybe POSIX -> f (Maybe POSIX))
 -> DocumentClassificationJobFilter
 -> f DocumentClassificationJobFilter)
-> ((Maybe UTCTime -> f (Maybe UTCTime))
    -> Maybe POSIX -> f (Maybe POSIX))
-> (Maybe UTCTime -> f (Maybe UTCTime))
-> DocumentClassificationJobFilter
-> f DocumentClassificationJobFilter
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 jobs based on the time that the job was submitted
-- for processing. Returns only jobs submitted before the specified time.
-- Jobs are returned in ascending order, oldest to newest.
documentClassificationJobFilter_submitTimeBefore :: Lens.Lens' DocumentClassificationJobFilter (Prelude.Maybe Prelude.UTCTime)
documentClassificationJobFilter_submitTimeBefore :: (Maybe UTCTime -> f (Maybe UTCTime))
-> DocumentClassificationJobFilter
-> f DocumentClassificationJobFilter
documentClassificationJobFilter_submitTimeBefore = (DocumentClassificationJobFilter -> Maybe POSIX)
-> (DocumentClassificationJobFilter
    -> Maybe POSIX -> DocumentClassificationJobFilter)
-> Lens
     DocumentClassificationJobFilter
     DocumentClassificationJobFilter
     (Maybe POSIX)
     (Maybe POSIX)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentClassificationJobFilter' {Maybe POSIX
submitTimeBefore :: Maybe POSIX
$sel:submitTimeBefore:DocumentClassificationJobFilter' :: DocumentClassificationJobFilter -> Maybe POSIX
submitTimeBefore} -> Maybe POSIX
submitTimeBefore) (\s :: DocumentClassificationJobFilter
s@DocumentClassificationJobFilter' {} Maybe POSIX
a -> DocumentClassificationJobFilter
s {$sel:submitTimeBefore:DocumentClassificationJobFilter' :: Maybe POSIX
submitTimeBefore = Maybe POSIX
a} :: DocumentClassificationJobFilter) ((Maybe POSIX -> f (Maybe POSIX))
 -> DocumentClassificationJobFilter
 -> f DocumentClassificationJobFilter)
-> ((Maybe UTCTime -> f (Maybe UTCTime))
    -> Maybe POSIX -> f (Maybe POSIX))
-> (Maybe UTCTime -> f (Maybe UTCTime))
-> DocumentClassificationJobFilter
-> f DocumentClassificationJobFilter
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 on the name of the job.
documentClassificationJobFilter_jobName :: Lens.Lens' DocumentClassificationJobFilter (Prelude.Maybe Prelude.Text)
documentClassificationJobFilter_jobName :: (Maybe Text -> f (Maybe Text))
-> DocumentClassificationJobFilter
-> f DocumentClassificationJobFilter
documentClassificationJobFilter_jobName = (DocumentClassificationJobFilter -> Maybe Text)
-> (DocumentClassificationJobFilter
    -> Maybe Text -> DocumentClassificationJobFilter)
-> Lens
     DocumentClassificationJobFilter
     DocumentClassificationJobFilter
     (Maybe Text)
     (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentClassificationJobFilter' {Maybe Text
jobName :: Maybe Text
$sel:jobName:DocumentClassificationJobFilter' :: DocumentClassificationJobFilter -> Maybe Text
jobName} -> Maybe Text
jobName) (\s :: DocumentClassificationJobFilter
s@DocumentClassificationJobFilter' {} Maybe Text
a -> DocumentClassificationJobFilter
s {$sel:jobName:DocumentClassificationJobFilter' :: Maybe Text
jobName = Maybe Text
a} :: DocumentClassificationJobFilter)

-- | Filters the list based on job status. Returns only jobs with the
-- specified status.
documentClassificationJobFilter_jobStatus :: Lens.Lens' DocumentClassificationJobFilter (Prelude.Maybe JobStatus)
documentClassificationJobFilter_jobStatus :: (Maybe JobStatus -> f (Maybe JobStatus))
-> DocumentClassificationJobFilter
-> f DocumentClassificationJobFilter
documentClassificationJobFilter_jobStatus = (DocumentClassificationJobFilter -> Maybe JobStatus)
-> (DocumentClassificationJobFilter
    -> Maybe JobStatus -> DocumentClassificationJobFilter)
-> Lens
     DocumentClassificationJobFilter
     DocumentClassificationJobFilter
     (Maybe JobStatus)
     (Maybe JobStatus)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DocumentClassificationJobFilter' {Maybe JobStatus
jobStatus :: Maybe JobStatus
$sel:jobStatus:DocumentClassificationJobFilter' :: DocumentClassificationJobFilter -> Maybe JobStatus
jobStatus} -> Maybe JobStatus
jobStatus) (\s :: DocumentClassificationJobFilter
s@DocumentClassificationJobFilter' {} Maybe JobStatus
a -> DocumentClassificationJobFilter
s {$sel:jobStatus:DocumentClassificationJobFilter' :: Maybe JobStatus
jobStatus = Maybe JobStatus
a} :: DocumentClassificationJobFilter)

instance
  Prelude.Hashable
    DocumentClassificationJobFilter

instance
  Prelude.NFData
    DocumentClassificationJobFilter

instance Core.ToJSON DocumentClassificationJobFilter where
  toJSON :: DocumentClassificationJobFilter -> Value
toJSON DocumentClassificationJobFilter' {Maybe Text
Maybe POSIX
Maybe JobStatus
jobStatus :: Maybe JobStatus
jobName :: Maybe Text
submitTimeBefore :: Maybe POSIX
submitTimeAfter :: Maybe POSIX
$sel:jobStatus:DocumentClassificationJobFilter' :: DocumentClassificationJobFilter -> Maybe JobStatus
$sel:jobName:DocumentClassificationJobFilter' :: DocumentClassificationJobFilter -> Maybe Text
$sel:submitTimeBefore:DocumentClassificationJobFilter' :: DocumentClassificationJobFilter -> Maybe POSIX
$sel:submitTimeAfter:DocumentClassificationJobFilter' :: DocumentClassificationJobFilter -> Maybe POSIX
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (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
"JobName" 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
jobName,
            (Text
"JobStatus" Text -> JobStatus -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (JobStatus -> Pair) -> Maybe JobStatus -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe JobStatus
jobStatus
          ]
      )