{-# 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-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.EntitiesDetectionJobFilter 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 dominant language detection
-- jobs. For more information, see the operation.
--
-- /See:/ 'newEntitiesDetectionJobFilter' smart constructor.
data EntitiesDetectionJobFilter = EntitiesDetectionJobFilter'
  { -- | 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,
    -- | 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 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.
    EntitiesDetectionJobFilter -> Maybe POSIX
submitTimeBefore :: Prelude.Maybe Data.POSIX
  }
  deriving (EntitiesDetectionJobFilter -> EntitiesDetectionJobFilter -> Bool
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]
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
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.
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:
--
-- '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.
--
-- '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.
newEntitiesDetectionJobFilter ::
  EntitiesDetectionJobFilter
newEntitiesDetectionJobFilter :: EntitiesDetectionJobFilter
newEntitiesDetectionJobFilter =
  EntitiesDetectionJobFilter'
    { $sel:jobName:EntitiesDetectionJobFilter' :: Maybe Text
jobName =
        forall a. Maybe a
Prelude.Nothing,
      $sel:jobStatus:EntitiesDetectionJobFilter' :: Maybe JobStatus
jobStatus = forall a. Maybe a
Prelude.Nothing,
      $sel:submitTimeAfter:EntitiesDetectionJobFilter' :: Maybe POSIX
submitTimeAfter = forall a. Maybe a
Prelude.Nothing,
      $sel:submitTimeBefore:EntitiesDetectionJobFilter' :: Maybe POSIX
submitTimeBefore = forall a. Maybe a
Prelude.Nothing
    }

-- | Filters on the name of the job.
entitiesDetectionJobFilter_jobName :: Lens.Lens' EntitiesDetectionJobFilter (Prelude.Maybe Prelude.Text)
entitiesDetectionJobFilter_jobName :: Lens' EntitiesDetectionJobFilter (Maybe Text)
entitiesDetectionJobFilter_jobName = 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 :: Lens' EntitiesDetectionJobFilter (Maybe JobStatus)
entitiesDetectionJobFilter_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)

-- | 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 :: Lens' EntitiesDetectionJobFilter (Maybe UTCTime)
entitiesDetectionJobFilter_submitTimeAfter = 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) 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.
entitiesDetectionJobFilter_submitTimeBefore :: Lens.Lens' EntitiesDetectionJobFilter (Prelude.Maybe Prelude.UTCTime)
entitiesDetectionJobFilter_submitTimeBefore :: Lens' EntitiesDetectionJobFilter (Maybe UTCTime)
entitiesDetectionJobFilter_submitTimeBefore = 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) 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 EntitiesDetectionJobFilter where
  hashWithSalt :: Int -> EntitiesDetectionJobFilter -> Int
hashWithSalt Int
_salt EntitiesDetectionJobFilter' {Maybe Text
Maybe POSIX
Maybe JobStatus
submitTimeBefore :: Maybe POSIX
submitTimeAfter :: Maybe POSIX
jobStatus :: Maybe JobStatus
jobName :: Maybe Text
$sel:submitTimeBefore:EntitiesDetectionJobFilter' :: EntitiesDetectionJobFilter -> Maybe POSIX
$sel:submitTimeAfter:EntitiesDetectionJobFilter' :: EntitiesDetectionJobFilter -> Maybe POSIX
$sel:jobStatus:EntitiesDetectionJobFilter' :: EntitiesDetectionJobFilter -> Maybe JobStatus
$sel:jobName:EntitiesDetectionJobFilter' :: EntitiesDetectionJobFilter -> 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 EntitiesDetectionJobFilter where
  rnf :: EntitiesDetectionJobFilter -> ()
rnf EntitiesDetectionJobFilter' {Maybe Text
Maybe POSIX
Maybe JobStatus
submitTimeBefore :: Maybe POSIX
submitTimeAfter :: Maybe POSIX
jobStatus :: Maybe JobStatus
jobName :: Maybe Text
$sel:submitTimeBefore:EntitiesDetectionJobFilter' :: EntitiesDetectionJobFilter -> Maybe POSIX
$sel:submitTimeAfter:EntitiesDetectionJobFilter' :: EntitiesDetectionJobFilter -> Maybe POSIX
$sel:jobStatus:EntitiesDetectionJobFilter' :: EntitiesDetectionJobFilter -> Maybe JobStatus
$sel:jobName:EntitiesDetectionJobFilter' :: EntitiesDetectionJobFilter -> 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 EntitiesDetectionJobFilter where
  toJSON :: EntitiesDetectionJobFilter -> Value
toJSON EntitiesDetectionJobFilter' {Maybe Text
Maybe POSIX
Maybe JobStatus
submitTimeBefore :: Maybe POSIX
submitTimeAfter :: Maybe POSIX
jobStatus :: Maybe JobStatus
jobName :: Maybe Text
$sel:submitTimeBefore:EntitiesDetectionJobFilter' :: EntitiesDetectionJobFilter -> Maybe POSIX
$sel:submitTimeAfter:EntitiesDetectionJobFilter' :: EntitiesDetectionJobFilter -> Maybe POSIX
$sel:jobStatus:EntitiesDetectionJobFilter' :: EntitiesDetectionJobFilter -> Maybe JobStatus
$sel:jobName:EntitiesDetectionJobFilter' :: EntitiesDetectionJobFilter -> 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
          ]
      )