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

import Amazonka.Comprehend.Types.JobStatus
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 PII entity detection jobs.
--
-- /See:/ 'newPiiEntitiesDetectionJobFilter' smart constructor.
data PiiEntitiesDetectionJobFilter = PiiEntitiesDetectionJobFilter'
  { -- | Filters on the name of the job.
    PiiEntitiesDetectionJobFilter -> Maybe Text
jobName :: Prelude.Maybe Prelude.Text,
    -- | Filters the list of jobs based on job status. Returns only jobs with the
    -- specified status.
    PiiEntitiesDetectionJobFilter -> Maybe JobStatus
jobStatus :: Prelude.Maybe JobStatus,
    -- | 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.
    PiiEntitiesDetectionJobFilter -> Maybe POSIX
submitTimeAfter :: Prelude.Maybe Data.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.
    PiiEntitiesDetectionJobFilter -> Maybe POSIX
submitTimeBefore :: Prelude.Maybe Data.POSIX
  }
  deriving (PiiEntitiesDetectionJobFilter
-> PiiEntitiesDetectionJobFilter -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PiiEntitiesDetectionJobFilter
-> PiiEntitiesDetectionJobFilter -> Bool
$c/= :: PiiEntitiesDetectionJobFilter
-> PiiEntitiesDetectionJobFilter -> Bool
== :: PiiEntitiesDetectionJobFilter
-> PiiEntitiesDetectionJobFilter -> Bool
$c== :: PiiEntitiesDetectionJobFilter
-> PiiEntitiesDetectionJobFilter -> Bool
Prelude.Eq, ReadPrec [PiiEntitiesDetectionJobFilter]
ReadPrec PiiEntitiesDetectionJobFilter
Int -> ReadS PiiEntitiesDetectionJobFilter
ReadS [PiiEntitiesDetectionJobFilter]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [PiiEntitiesDetectionJobFilter]
$creadListPrec :: ReadPrec [PiiEntitiesDetectionJobFilter]
readPrec :: ReadPrec PiiEntitiesDetectionJobFilter
$creadPrec :: ReadPrec PiiEntitiesDetectionJobFilter
readList :: ReadS [PiiEntitiesDetectionJobFilter]
$creadList :: ReadS [PiiEntitiesDetectionJobFilter]
readsPrec :: Int -> ReadS PiiEntitiesDetectionJobFilter
$creadsPrec :: Int -> ReadS PiiEntitiesDetectionJobFilter
Prelude.Read, Int -> PiiEntitiesDetectionJobFilter -> ShowS
[PiiEntitiesDetectionJobFilter] -> ShowS
PiiEntitiesDetectionJobFilter -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PiiEntitiesDetectionJobFilter] -> ShowS
$cshowList :: [PiiEntitiesDetectionJobFilter] -> ShowS
show :: PiiEntitiesDetectionJobFilter -> String
$cshow :: PiiEntitiesDetectionJobFilter -> String
showsPrec :: Int -> PiiEntitiesDetectionJobFilter -> ShowS
$cshowsPrec :: Int -> PiiEntitiesDetectionJobFilter -> ShowS
Prelude.Show, forall x.
Rep PiiEntitiesDetectionJobFilter x
-> PiiEntitiesDetectionJobFilter
forall x.
PiiEntitiesDetectionJobFilter
-> Rep PiiEntitiesDetectionJobFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep PiiEntitiesDetectionJobFilter x
-> PiiEntitiesDetectionJobFilter
$cfrom :: forall x.
PiiEntitiesDetectionJobFilter
-> Rep PiiEntitiesDetectionJobFilter x
Prelude.Generic)

-- |
-- Create a value of 'PiiEntitiesDetectionJobFilter' 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:
--
-- 'jobName', 'piiEntitiesDetectionJobFilter_jobName' - Filters on the name of the job.
--
-- 'jobStatus', 'piiEntitiesDetectionJobFilter_jobStatus' - Filters the list of jobs based on job status. Returns only jobs with the
-- specified status.
--
-- 'submitTimeAfter', 'piiEntitiesDetectionJobFilter_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', 'piiEntitiesDetectionJobFilter_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.
newPiiEntitiesDetectionJobFilter ::
  PiiEntitiesDetectionJobFilter
newPiiEntitiesDetectionJobFilter :: PiiEntitiesDetectionJobFilter
newPiiEntitiesDetectionJobFilter =
  PiiEntitiesDetectionJobFilter'
    { $sel:jobName:PiiEntitiesDetectionJobFilter' :: Maybe Text
jobName =
        forall a. Maybe a
Prelude.Nothing,
      $sel:jobStatus:PiiEntitiesDetectionJobFilter' :: Maybe JobStatus
jobStatus = forall a. Maybe a
Prelude.Nothing,
      $sel:submitTimeAfter:PiiEntitiesDetectionJobFilter' :: Maybe POSIX
submitTimeAfter = forall a. Maybe a
Prelude.Nothing,
      $sel:submitTimeBefore:PiiEntitiesDetectionJobFilter' :: Maybe POSIX
submitTimeBefore = forall a. Maybe a
Prelude.Nothing
    }

-- | Filters on the name of the job.
piiEntitiesDetectionJobFilter_jobName :: Lens.Lens' PiiEntitiesDetectionJobFilter (Prelude.Maybe Prelude.Text)
piiEntitiesDetectionJobFilter_jobName :: Lens' PiiEntitiesDetectionJobFilter (Maybe Text)
piiEntitiesDetectionJobFilter_jobName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PiiEntitiesDetectionJobFilter' {Maybe Text
jobName :: Maybe Text
$sel:jobName:PiiEntitiesDetectionJobFilter' :: PiiEntitiesDetectionJobFilter -> Maybe Text
jobName} -> Maybe Text
jobName) (\s :: PiiEntitiesDetectionJobFilter
s@PiiEntitiesDetectionJobFilter' {} Maybe Text
a -> PiiEntitiesDetectionJobFilter
s {$sel:jobName:PiiEntitiesDetectionJobFilter' :: Maybe Text
jobName = Maybe Text
a} :: PiiEntitiesDetectionJobFilter)

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

-- | 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.
piiEntitiesDetectionJobFilter_submitTimeAfter :: Lens.Lens' PiiEntitiesDetectionJobFilter (Prelude.Maybe Prelude.UTCTime)
piiEntitiesDetectionJobFilter_submitTimeAfter :: Lens' PiiEntitiesDetectionJobFilter (Maybe UTCTime)
piiEntitiesDetectionJobFilter_submitTimeAfter = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PiiEntitiesDetectionJobFilter' {Maybe POSIX
submitTimeAfter :: Maybe POSIX
$sel:submitTimeAfter:PiiEntitiesDetectionJobFilter' :: PiiEntitiesDetectionJobFilter -> Maybe POSIX
submitTimeAfter} -> Maybe POSIX
submitTimeAfter) (\s :: PiiEntitiesDetectionJobFilter
s@PiiEntitiesDetectionJobFilter' {} Maybe POSIX
a -> PiiEntitiesDetectionJobFilter
s {$sel:submitTimeAfter:PiiEntitiesDetectionJobFilter' :: Maybe POSIX
submitTimeAfter = Maybe POSIX
a} :: PiiEntitiesDetectionJobFilter) 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 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.
piiEntitiesDetectionJobFilter_submitTimeBefore :: Lens.Lens' PiiEntitiesDetectionJobFilter (Prelude.Maybe Prelude.UTCTime)
piiEntitiesDetectionJobFilter_submitTimeBefore :: Lens' PiiEntitiesDetectionJobFilter (Maybe UTCTime)
piiEntitiesDetectionJobFilter_submitTimeBefore = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PiiEntitiesDetectionJobFilter' {Maybe POSIX
submitTimeBefore :: Maybe POSIX
$sel:submitTimeBefore:PiiEntitiesDetectionJobFilter' :: PiiEntitiesDetectionJobFilter -> Maybe POSIX
submitTimeBefore} -> Maybe POSIX
submitTimeBefore) (\s :: PiiEntitiesDetectionJobFilter
s@PiiEntitiesDetectionJobFilter' {} Maybe POSIX
a -> PiiEntitiesDetectionJobFilter
s {$sel:submitTimeBefore:PiiEntitiesDetectionJobFilter' :: Maybe POSIX
submitTimeBefore = Maybe POSIX
a} :: PiiEntitiesDetectionJobFilter) 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
    PiiEntitiesDetectionJobFilter
  where
  hashWithSalt :: Int -> PiiEntitiesDetectionJobFilter -> Int
hashWithSalt Int
_salt PiiEntitiesDetectionJobFilter' {Maybe Text
Maybe POSIX
Maybe JobStatus
submitTimeBefore :: Maybe POSIX
submitTimeAfter :: Maybe POSIX
jobStatus :: Maybe JobStatus
jobName :: Maybe Text
$sel:submitTimeBefore:PiiEntitiesDetectionJobFilter' :: PiiEntitiesDetectionJobFilter -> Maybe POSIX
$sel:submitTimeAfter:PiiEntitiesDetectionJobFilter' :: PiiEntitiesDetectionJobFilter -> Maybe POSIX
$sel:jobStatus:PiiEntitiesDetectionJobFilter' :: PiiEntitiesDetectionJobFilter -> Maybe JobStatus
$sel:jobName:PiiEntitiesDetectionJobFilter' :: PiiEntitiesDetectionJobFilter -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
jobName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe JobStatus
jobStatus
      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 PiiEntitiesDetectionJobFilter where
  rnf :: PiiEntitiesDetectionJobFilter -> ()
rnf PiiEntitiesDetectionJobFilter' {Maybe Text
Maybe POSIX
Maybe JobStatus
submitTimeBefore :: Maybe POSIX
submitTimeAfter :: Maybe POSIX
jobStatus :: Maybe JobStatus
jobName :: Maybe Text
$sel:submitTimeBefore:PiiEntitiesDetectionJobFilter' :: PiiEntitiesDetectionJobFilter -> Maybe POSIX
$sel:submitTimeAfter:PiiEntitiesDetectionJobFilter' :: PiiEntitiesDetectionJobFilter -> Maybe POSIX
$sel:jobStatus:PiiEntitiesDetectionJobFilter' :: PiiEntitiesDetectionJobFilter -> Maybe JobStatus
$sel:jobName:PiiEntitiesDetectionJobFilter' :: PiiEntitiesDetectionJobFilter -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
jobName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe JobStatus
jobStatus
      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 PiiEntitiesDetectionJobFilter where
  toJSON :: PiiEntitiesDetectionJobFilter -> Value
toJSON PiiEntitiesDetectionJobFilter' {Maybe Text
Maybe POSIX
Maybe JobStatus
submitTimeBefore :: Maybe POSIX
submitTimeAfter :: Maybe POSIX
jobStatus :: Maybe JobStatus
jobName :: Maybe Text
$sel:submitTimeBefore:PiiEntitiesDetectionJobFilter' :: PiiEntitiesDetectionJobFilter -> Maybe POSIX
$sel:submitTimeAfter:PiiEntitiesDetectionJobFilter' :: PiiEntitiesDetectionJobFilter -> Maybe POSIX
$sel:jobStatus:PiiEntitiesDetectionJobFilter' :: PiiEntitiesDetectionJobFilter -> Maybe JobStatus
$sel:jobName:PiiEntitiesDetectionJobFilter' :: PiiEntitiesDetectionJobFilter -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"JobName" 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
jobName,
            (Key
"JobStatus" 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 JobStatus
jobStatus,
            (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
          ]
      )