{-# 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.EntitiesDetectionJobFilter
-- 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.EntitiesDetectionJobFilter 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 dominant language detection
-- jobs. For more information, see the operation.
--
-- /See:/ 'newEntitiesDetectionJobFilter' smart constructor.
data EntitiesDetectionJobFilter = EntitiesDetectionJobFilter'
  { -- | 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.
    EntitiesDetectionJobFilter -> 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.
    EntitiesDetectionJobFilter -> Maybe POSIX
submitTimeBefore :: Prelude.Maybe Core.POSIX,
    -- | Filters on the name of the job.
    EntitiesDetectionJobFilter -> Maybe Text
jobName :: Prelude.Maybe Prelude.Text,
    -- | Filters the list of jobs based on job status. Returns only jobs with the
    -- specified status.
    EntitiesDetectionJobFilter -> Maybe JobStatus
jobStatus :: Prelude.Maybe JobStatus
  }
  deriving (EntitiesDetectionJobFilter -> EntitiesDetectionJobFilter -> Bool
(EntitiesDetectionJobFilter -> EntitiesDetectionJobFilter -> Bool)
-> (EntitiesDetectionJobFilter
    -> EntitiesDetectionJobFilter -> Bool)
-> Eq EntitiesDetectionJobFilter
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: EntitiesDetectionJobFilter -> EntitiesDetectionJobFilter -> Bool
$c/= :: EntitiesDetectionJobFilter -> EntitiesDetectionJobFilter -> Bool
== :: EntitiesDetectionJobFilter -> EntitiesDetectionJobFilter -> Bool
$c== :: EntitiesDetectionJobFilter -> EntitiesDetectionJobFilter -> Bool
Prelude.Eq, ReadPrec [EntitiesDetectionJobFilter]
ReadPrec EntitiesDetectionJobFilter
Int -> ReadS EntitiesDetectionJobFilter
ReadS [EntitiesDetectionJobFilter]
(Int -> ReadS EntitiesDetectionJobFilter)
-> ReadS [EntitiesDetectionJobFilter]
-> ReadPrec EntitiesDetectionJobFilter
-> ReadPrec [EntitiesDetectionJobFilter]
-> Read EntitiesDetectionJobFilter
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [EntitiesDetectionJobFilter]
$creadListPrec :: ReadPrec [EntitiesDetectionJobFilter]
readPrec :: ReadPrec EntitiesDetectionJobFilter
$creadPrec :: ReadPrec EntitiesDetectionJobFilter
readList :: ReadS [EntitiesDetectionJobFilter]
$creadList :: ReadS [EntitiesDetectionJobFilter]
readsPrec :: Int -> ReadS EntitiesDetectionJobFilter
$creadsPrec :: Int -> ReadS EntitiesDetectionJobFilter
Prelude.Read, Int -> EntitiesDetectionJobFilter -> ShowS
[EntitiesDetectionJobFilter] -> ShowS
EntitiesDetectionJobFilter -> String
(Int -> EntitiesDetectionJobFilter -> ShowS)
-> (EntitiesDetectionJobFilter -> String)
-> ([EntitiesDetectionJobFilter] -> ShowS)
-> Show EntitiesDetectionJobFilter
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [EntitiesDetectionJobFilter] -> ShowS
$cshowList :: [EntitiesDetectionJobFilter] -> ShowS
show :: EntitiesDetectionJobFilter -> String
$cshow :: EntitiesDetectionJobFilter -> String
showsPrec :: Int -> EntitiesDetectionJobFilter -> ShowS
$cshowsPrec :: Int -> EntitiesDetectionJobFilter -> ShowS
Prelude.Show, (forall x.
 EntitiesDetectionJobFilter -> Rep EntitiesDetectionJobFilter x)
-> (forall x.
    Rep EntitiesDetectionJobFilter x -> EntitiesDetectionJobFilter)
-> Generic EntitiesDetectionJobFilter
forall x.
Rep EntitiesDetectionJobFilter x -> EntitiesDetectionJobFilter
forall x.
EntitiesDetectionJobFilter -> Rep EntitiesDetectionJobFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep EntitiesDetectionJobFilter x -> EntitiesDetectionJobFilter
$cfrom :: forall x.
EntitiesDetectionJobFilter -> Rep EntitiesDetectionJobFilter x
Prelude.Generic)

-- |
-- Create a value of 'EntitiesDetectionJobFilter' 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', 'entitiesDetectionJobFilter_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', 'entitiesDetectionJobFilter_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', 'entitiesDetectionJobFilter_jobName' - Filters on the name of the job.
--
-- 'jobStatus', 'entitiesDetectionJobFilter_jobStatus' - Filters the list of jobs based on job status. Returns only jobs with the
-- specified status.
newEntitiesDetectionJobFilter ::
  EntitiesDetectionJobFilter
newEntitiesDetectionJobFilter :: EntitiesDetectionJobFilter
newEntitiesDetectionJobFilter =
  EntitiesDetectionJobFilter' :: Maybe POSIX
-> Maybe POSIX
-> Maybe Text
-> Maybe JobStatus
-> EntitiesDetectionJobFilter
EntitiesDetectionJobFilter'
    { $sel:submitTimeAfter:EntitiesDetectionJobFilter' :: Maybe POSIX
submitTimeAfter =
        Maybe POSIX
forall a. Maybe a
Prelude.Nothing,
      $sel:submitTimeBefore:EntitiesDetectionJobFilter' :: Maybe POSIX
submitTimeBefore = Maybe POSIX
forall a. Maybe a
Prelude.Nothing,
      $sel:jobName:EntitiesDetectionJobFilter' :: Maybe Text
jobName = Maybe Text
forall a. Maybe a
Prelude.Nothing,
      $sel:jobStatus:EntitiesDetectionJobFilter' :: 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.
entitiesDetectionJobFilter_submitTimeAfter :: Lens.Lens' EntitiesDetectionJobFilter (Prelude.Maybe Prelude.UTCTime)
entitiesDetectionJobFilter_submitTimeAfter :: (Maybe UTCTime -> f (Maybe UTCTime))
-> EntitiesDetectionJobFilter -> f EntitiesDetectionJobFilter
entitiesDetectionJobFilter_submitTimeAfter = (EntitiesDetectionJobFilter -> Maybe POSIX)
-> (EntitiesDetectionJobFilter
    -> Maybe POSIX -> EntitiesDetectionJobFilter)
-> Lens
     EntitiesDetectionJobFilter
     EntitiesDetectionJobFilter
     (Maybe POSIX)
     (Maybe POSIX)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EntitiesDetectionJobFilter' {Maybe POSIX
submitTimeAfter :: Maybe POSIX
$sel:submitTimeAfter:EntitiesDetectionJobFilter' :: EntitiesDetectionJobFilter -> Maybe POSIX
submitTimeAfter} -> Maybe POSIX
submitTimeAfter) (\s :: EntitiesDetectionJobFilter
s@EntitiesDetectionJobFilter' {} Maybe POSIX
a -> EntitiesDetectionJobFilter
s {$sel:submitTimeAfter:EntitiesDetectionJobFilter' :: Maybe POSIX
submitTimeAfter = Maybe POSIX
a} :: EntitiesDetectionJobFilter) ((Maybe POSIX -> f (Maybe POSIX))
 -> EntitiesDetectionJobFilter -> f EntitiesDetectionJobFilter)
-> ((Maybe UTCTime -> f (Maybe UTCTime))
    -> Maybe POSIX -> f (Maybe POSIX))
-> (Maybe UTCTime -> f (Maybe UTCTime))
-> EntitiesDetectionJobFilter
-> f EntitiesDetectionJobFilter
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.
entitiesDetectionJobFilter_submitTimeBefore :: Lens.Lens' EntitiesDetectionJobFilter (Prelude.Maybe Prelude.UTCTime)
entitiesDetectionJobFilter_submitTimeBefore :: (Maybe UTCTime -> f (Maybe UTCTime))
-> EntitiesDetectionJobFilter -> f EntitiesDetectionJobFilter
entitiesDetectionJobFilter_submitTimeBefore = (EntitiesDetectionJobFilter -> Maybe POSIX)
-> (EntitiesDetectionJobFilter
    -> Maybe POSIX -> EntitiesDetectionJobFilter)
-> Lens
     EntitiesDetectionJobFilter
     EntitiesDetectionJobFilter
     (Maybe POSIX)
     (Maybe POSIX)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EntitiesDetectionJobFilter' {Maybe POSIX
submitTimeBefore :: Maybe POSIX
$sel:submitTimeBefore:EntitiesDetectionJobFilter' :: EntitiesDetectionJobFilter -> Maybe POSIX
submitTimeBefore} -> Maybe POSIX
submitTimeBefore) (\s :: EntitiesDetectionJobFilter
s@EntitiesDetectionJobFilter' {} Maybe POSIX
a -> EntitiesDetectionJobFilter
s {$sel:submitTimeBefore:EntitiesDetectionJobFilter' :: Maybe POSIX
submitTimeBefore = Maybe POSIX
a} :: EntitiesDetectionJobFilter) ((Maybe POSIX -> f (Maybe POSIX))
 -> EntitiesDetectionJobFilter -> f EntitiesDetectionJobFilter)
-> ((Maybe UTCTime -> f (Maybe UTCTime))
    -> Maybe POSIX -> f (Maybe POSIX))
-> (Maybe UTCTime -> f (Maybe UTCTime))
-> EntitiesDetectionJobFilter
-> f EntitiesDetectionJobFilter
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.
entitiesDetectionJobFilter_jobName :: Lens.Lens' EntitiesDetectionJobFilter (Prelude.Maybe Prelude.Text)
entitiesDetectionJobFilter_jobName :: (Maybe Text -> f (Maybe Text))
-> EntitiesDetectionJobFilter -> f EntitiesDetectionJobFilter
entitiesDetectionJobFilter_jobName = (EntitiesDetectionJobFilter -> Maybe Text)
-> (EntitiesDetectionJobFilter
    -> Maybe Text -> EntitiesDetectionJobFilter)
-> Lens
     EntitiesDetectionJobFilter
     EntitiesDetectionJobFilter
     (Maybe Text)
     (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EntitiesDetectionJobFilter' {Maybe Text
jobName :: Maybe Text
$sel:jobName:EntitiesDetectionJobFilter' :: EntitiesDetectionJobFilter -> Maybe Text
jobName} -> Maybe Text
jobName) (\s :: EntitiesDetectionJobFilter
s@EntitiesDetectionJobFilter' {} Maybe Text
a -> EntitiesDetectionJobFilter
s {$sel:jobName:EntitiesDetectionJobFilter' :: Maybe Text
jobName = Maybe Text
a} :: EntitiesDetectionJobFilter)

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

instance Prelude.Hashable EntitiesDetectionJobFilter

instance Prelude.NFData EntitiesDetectionJobFilter

instance Core.ToJSON EntitiesDetectionJobFilter where
  toJSON :: EntitiesDetectionJobFilter -> Value
toJSON EntitiesDetectionJobFilter' {Maybe Text
Maybe POSIX
Maybe JobStatus
jobStatus :: Maybe JobStatus
jobName :: Maybe Text
submitTimeBefore :: Maybe POSIX
submitTimeAfter :: Maybe POSIX
$sel:jobStatus:EntitiesDetectionJobFilter' :: EntitiesDetectionJobFilter -> Maybe JobStatus
$sel:jobName:EntitiesDetectionJobFilter' :: EntitiesDetectionJobFilter -> Maybe Text
$sel:submitTimeBefore:EntitiesDetectionJobFilter' :: EntitiesDetectionJobFilter -> Maybe POSIX
$sel:submitTimeAfter:EntitiesDetectionJobFilter' :: EntitiesDetectionJobFilter -> 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
          ]
      )