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

import Amazonka.Comprehend.Types.PiiEntityType
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 about a PII entity.
--
-- /See:/ 'newPiiEntity' smart constructor.
data PiiEntity = PiiEntity'
  { -- | The zero-based offset from the beginning of the source text to the first
    -- character in the entity.
    PiiEntity -> Maybe Int
beginOffset :: Prelude.Maybe Prelude.Int,
    -- | The zero-based offset from the beginning of the source text to the last
    -- character in the entity.
    PiiEntity -> Maybe Int
endOffset :: Prelude.Maybe Prelude.Int,
    -- | The level of confidence that Amazon Comprehend has in the accuracy of
    -- the detection.
    PiiEntity -> Maybe Double
score :: Prelude.Maybe Prelude.Double,
    -- | The entity\'s type.
    PiiEntity -> Maybe PiiEntityType
type' :: Prelude.Maybe PiiEntityType
  }
  deriving (PiiEntity -> PiiEntity -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PiiEntity -> PiiEntity -> Bool
$c/= :: PiiEntity -> PiiEntity -> Bool
== :: PiiEntity -> PiiEntity -> Bool
$c== :: PiiEntity -> PiiEntity -> Bool
Prelude.Eq, ReadPrec [PiiEntity]
ReadPrec PiiEntity
Int -> ReadS PiiEntity
ReadS [PiiEntity]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [PiiEntity]
$creadListPrec :: ReadPrec [PiiEntity]
readPrec :: ReadPrec PiiEntity
$creadPrec :: ReadPrec PiiEntity
readList :: ReadS [PiiEntity]
$creadList :: ReadS [PiiEntity]
readsPrec :: Int -> ReadS PiiEntity
$creadsPrec :: Int -> ReadS PiiEntity
Prelude.Read, Int -> PiiEntity -> ShowS
[PiiEntity] -> ShowS
PiiEntity -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PiiEntity] -> ShowS
$cshowList :: [PiiEntity] -> ShowS
show :: PiiEntity -> String
$cshow :: PiiEntity -> String
showsPrec :: Int -> PiiEntity -> ShowS
$cshowsPrec :: Int -> PiiEntity -> ShowS
Prelude.Show, forall x. Rep PiiEntity x -> PiiEntity
forall x. PiiEntity -> Rep PiiEntity x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep PiiEntity x -> PiiEntity
$cfrom :: forall x. PiiEntity -> Rep PiiEntity x
Prelude.Generic)

-- |
-- Create a value of 'PiiEntity' 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:
--
-- 'beginOffset', 'piiEntity_beginOffset' - The zero-based offset from the beginning of the source text to the first
-- character in the entity.
--
-- 'endOffset', 'piiEntity_endOffset' - The zero-based offset from the beginning of the source text to the last
-- character in the entity.
--
-- 'score', 'piiEntity_score' - The level of confidence that Amazon Comprehend has in the accuracy of
-- the detection.
--
-- 'type'', 'piiEntity_type' - The entity\'s type.
newPiiEntity ::
  PiiEntity
newPiiEntity :: PiiEntity
newPiiEntity =
  PiiEntity'
    { $sel:beginOffset:PiiEntity' :: Maybe Int
beginOffset = forall a. Maybe a
Prelude.Nothing,
      $sel:endOffset:PiiEntity' :: Maybe Int
endOffset = forall a. Maybe a
Prelude.Nothing,
      $sel:score:PiiEntity' :: Maybe Double
score = forall a. Maybe a
Prelude.Nothing,
      $sel:type':PiiEntity' :: Maybe PiiEntityType
type' = forall a. Maybe a
Prelude.Nothing
    }

-- | The zero-based offset from the beginning of the source text to the first
-- character in the entity.
piiEntity_beginOffset :: Lens.Lens' PiiEntity (Prelude.Maybe Prelude.Int)
piiEntity_beginOffset :: Lens' PiiEntity (Maybe Int)
piiEntity_beginOffset = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PiiEntity' {Maybe Int
beginOffset :: Maybe Int
$sel:beginOffset:PiiEntity' :: PiiEntity -> Maybe Int
beginOffset} -> Maybe Int
beginOffset) (\s :: PiiEntity
s@PiiEntity' {} Maybe Int
a -> PiiEntity
s {$sel:beginOffset:PiiEntity' :: Maybe Int
beginOffset = Maybe Int
a} :: PiiEntity)

-- | The zero-based offset from the beginning of the source text to the last
-- character in the entity.
piiEntity_endOffset :: Lens.Lens' PiiEntity (Prelude.Maybe Prelude.Int)
piiEntity_endOffset :: Lens' PiiEntity (Maybe Int)
piiEntity_endOffset = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PiiEntity' {Maybe Int
endOffset :: Maybe Int
$sel:endOffset:PiiEntity' :: PiiEntity -> Maybe Int
endOffset} -> Maybe Int
endOffset) (\s :: PiiEntity
s@PiiEntity' {} Maybe Int
a -> PiiEntity
s {$sel:endOffset:PiiEntity' :: Maybe Int
endOffset = Maybe Int
a} :: PiiEntity)

-- | The level of confidence that Amazon Comprehend has in the accuracy of
-- the detection.
piiEntity_score :: Lens.Lens' PiiEntity (Prelude.Maybe Prelude.Double)
piiEntity_score :: Lens' PiiEntity (Maybe Double)
piiEntity_score = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PiiEntity' {Maybe Double
score :: Maybe Double
$sel:score:PiiEntity' :: PiiEntity -> Maybe Double
score} -> Maybe Double
score) (\s :: PiiEntity
s@PiiEntity' {} Maybe Double
a -> PiiEntity
s {$sel:score:PiiEntity' :: Maybe Double
score = Maybe Double
a} :: PiiEntity)

-- | The entity\'s type.
piiEntity_type :: Lens.Lens' PiiEntity (Prelude.Maybe PiiEntityType)
piiEntity_type :: Lens' PiiEntity (Maybe PiiEntityType)
piiEntity_type = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PiiEntity' {Maybe PiiEntityType
type' :: Maybe PiiEntityType
$sel:type':PiiEntity' :: PiiEntity -> Maybe PiiEntityType
type'} -> Maybe PiiEntityType
type') (\s :: PiiEntity
s@PiiEntity' {} Maybe PiiEntityType
a -> PiiEntity
s {$sel:type':PiiEntity' :: Maybe PiiEntityType
type' = Maybe PiiEntityType
a} :: PiiEntity)

instance Data.FromJSON PiiEntity where
  parseJSON :: Value -> Parser PiiEntity
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"PiiEntity"
      ( \Object
x ->
          Maybe Int
-> Maybe Int -> Maybe Double -> Maybe PiiEntityType -> PiiEntity
PiiEntity'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"BeginOffset")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"EndOffset")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Score")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Type")
      )

instance Prelude.Hashable PiiEntity where
  hashWithSalt :: Int -> PiiEntity -> Int
hashWithSalt Int
_salt PiiEntity' {Maybe Double
Maybe Int
Maybe PiiEntityType
type' :: Maybe PiiEntityType
score :: Maybe Double
endOffset :: Maybe Int
beginOffset :: Maybe Int
$sel:type':PiiEntity' :: PiiEntity -> Maybe PiiEntityType
$sel:score:PiiEntity' :: PiiEntity -> Maybe Double
$sel:endOffset:PiiEntity' :: PiiEntity -> Maybe Int
$sel:beginOffset:PiiEntity' :: PiiEntity -> Maybe Int
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
beginOffset
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
endOffset
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Double
score
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe PiiEntityType
type'

instance Prelude.NFData PiiEntity where
  rnf :: PiiEntity -> ()
rnf PiiEntity' {Maybe Double
Maybe Int
Maybe PiiEntityType
type' :: Maybe PiiEntityType
score :: Maybe Double
endOffset :: Maybe Int
beginOffset :: Maybe Int
$sel:type':PiiEntity' :: PiiEntity -> Maybe PiiEntityType
$sel:score:PiiEntity' :: PiiEntity -> Maybe Double
$sel:endOffset:PiiEntity' :: PiiEntity -> Maybe Int
$sel:beginOffset:PiiEntity' :: PiiEntity -> Maybe Int
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
beginOffset
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
endOffset
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Double
score
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe PiiEntityType
type'