{-# 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.Rekognition.Types.GeneralLabelsSettings
-- 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.Rekognition.Types.GeneralLabelsSettings where

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

-- | Contains filters for the object labels returned by DetectLabels. Filters
-- can be inclusive, exclusive, or a combination of both and can be applied
-- to individual l abels or entire label categories.
--
-- /See:/ 'newGeneralLabelsSettings' smart constructor.
data GeneralLabelsSettings = GeneralLabelsSettings'
  { -- | The label categories that should be excluded from the return from
    -- DetectLabels.
    GeneralLabelsSettings -> Maybe [Text]
labelCategoryExclusionFilters :: Prelude.Maybe [Prelude.Text],
    -- | The label categories that should be included in the return from
    -- DetectLabels.
    GeneralLabelsSettings -> Maybe [Text]
labelCategoryInclusionFilters :: Prelude.Maybe [Prelude.Text],
    -- | The labels that should be excluded from the return from DetectLabels.
    GeneralLabelsSettings -> Maybe [Text]
labelExclusionFilters :: Prelude.Maybe [Prelude.Text],
    -- | The labels that should be included in the return from DetectLabels.
    GeneralLabelsSettings -> Maybe [Text]
labelInclusionFilters :: Prelude.Maybe [Prelude.Text]
  }
  deriving (GeneralLabelsSettings -> GeneralLabelsSettings -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GeneralLabelsSettings -> GeneralLabelsSettings -> Bool
$c/= :: GeneralLabelsSettings -> GeneralLabelsSettings -> Bool
== :: GeneralLabelsSettings -> GeneralLabelsSettings -> Bool
$c== :: GeneralLabelsSettings -> GeneralLabelsSettings -> Bool
Prelude.Eq, ReadPrec [GeneralLabelsSettings]
ReadPrec GeneralLabelsSettings
Int -> ReadS GeneralLabelsSettings
ReadS [GeneralLabelsSettings]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GeneralLabelsSettings]
$creadListPrec :: ReadPrec [GeneralLabelsSettings]
readPrec :: ReadPrec GeneralLabelsSettings
$creadPrec :: ReadPrec GeneralLabelsSettings
readList :: ReadS [GeneralLabelsSettings]
$creadList :: ReadS [GeneralLabelsSettings]
readsPrec :: Int -> ReadS GeneralLabelsSettings
$creadsPrec :: Int -> ReadS GeneralLabelsSettings
Prelude.Read, Int -> GeneralLabelsSettings -> ShowS
[GeneralLabelsSettings] -> ShowS
GeneralLabelsSettings -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GeneralLabelsSettings] -> ShowS
$cshowList :: [GeneralLabelsSettings] -> ShowS
show :: GeneralLabelsSettings -> String
$cshow :: GeneralLabelsSettings -> String
showsPrec :: Int -> GeneralLabelsSettings -> ShowS
$cshowsPrec :: Int -> GeneralLabelsSettings -> ShowS
Prelude.Show, forall x. Rep GeneralLabelsSettings x -> GeneralLabelsSettings
forall x. GeneralLabelsSettings -> Rep GeneralLabelsSettings x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GeneralLabelsSettings x -> GeneralLabelsSettings
$cfrom :: forall x. GeneralLabelsSettings -> Rep GeneralLabelsSettings x
Prelude.Generic)

-- |
-- Create a value of 'GeneralLabelsSettings' 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:
--
-- 'labelCategoryExclusionFilters', 'generalLabelsSettings_labelCategoryExclusionFilters' - The label categories that should be excluded from the return from
-- DetectLabels.
--
-- 'labelCategoryInclusionFilters', 'generalLabelsSettings_labelCategoryInclusionFilters' - The label categories that should be included in the return from
-- DetectLabels.
--
-- 'labelExclusionFilters', 'generalLabelsSettings_labelExclusionFilters' - The labels that should be excluded from the return from DetectLabels.
--
-- 'labelInclusionFilters', 'generalLabelsSettings_labelInclusionFilters' - The labels that should be included in the return from DetectLabels.
newGeneralLabelsSettings ::
  GeneralLabelsSettings
newGeneralLabelsSettings :: GeneralLabelsSettings
newGeneralLabelsSettings =
  GeneralLabelsSettings'
    { $sel:labelCategoryExclusionFilters:GeneralLabelsSettings' :: Maybe [Text]
labelCategoryExclusionFilters =
        forall a. Maybe a
Prelude.Nothing,
      $sel:labelCategoryInclusionFilters:GeneralLabelsSettings' :: Maybe [Text]
labelCategoryInclusionFilters = forall a. Maybe a
Prelude.Nothing,
      $sel:labelExclusionFilters:GeneralLabelsSettings' :: Maybe [Text]
labelExclusionFilters = forall a. Maybe a
Prelude.Nothing,
      $sel:labelInclusionFilters:GeneralLabelsSettings' :: Maybe [Text]
labelInclusionFilters = forall a. Maybe a
Prelude.Nothing
    }

-- | The label categories that should be excluded from the return from
-- DetectLabels.
generalLabelsSettings_labelCategoryExclusionFilters :: Lens.Lens' GeneralLabelsSettings (Prelude.Maybe [Prelude.Text])
generalLabelsSettings_labelCategoryExclusionFilters :: Lens' GeneralLabelsSettings (Maybe [Text])
generalLabelsSettings_labelCategoryExclusionFilters = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GeneralLabelsSettings' {Maybe [Text]
labelCategoryExclusionFilters :: Maybe [Text]
$sel:labelCategoryExclusionFilters:GeneralLabelsSettings' :: GeneralLabelsSettings -> Maybe [Text]
labelCategoryExclusionFilters} -> Maybe [Text]
labelCategoryExclusionFilters) (\s :: GeneralLabelsSettings
s@GeneralLabelsSettings' {} Maybe [Text]
a -> GeneralLabelsSettings
s {$sel:labelCategoryExclusionFilters:GeneralLabelsSettings' :: Maybe [Text]
labelCategoryExclusionFilters = Maybe [Text]
a} :: GeneralLabelsSettings) 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 s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The label categories that should be included in the return from
-- DetectLabels.
generalLabelsSettings_labelCategoryInclusionFilters :: Lens.Lens' GeneralLabelsSettings (Prelude.Maybe [Prelude.Text])
generalLabelsSettings_labelCategoryInclusionFilters :: Lens' GeneralLabelsSettings (Maybe [Text])
generalLabelsSettings_labelCategoryInclusionFilters = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GeneralLabelsSettings' {Maybe [Text]
labelCategoryInclusionFilters :: Maybe [Text]
$sel:labelCategoryInclusionFilters:GeneralLabelsSettings' :: GeneralLabelsSettings -> Maybe [Text]
labelCategoryInclusionFilters} -> Maybe [Text]
labelCategoryInclusionFilters) (\s :: GeneralLabelsSettings
s@GeneralLabelsSettings' {} Maybe [Text]
a -> GeneralLabelsSettings
s {$sel:labelCategoryInclusionFilters:GeneralLabelsSettings' :: Maybe [Text]
labelCategoryInclusionFilters = Maybe [Text]
a} :: GeneralLabelsSettings) 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 s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The labels that should be excluded from the return from DetectLabels.
generalLabelsSettings_labelExclusionFilters :: Lens.Lens' GeneralLabelsSettings (Prelude.Maybe [Prelude.Text])
generalLabelsSettings_labelExclusionFilters :: Lens' GeneralLabelsSettings (Maybe [Text])
generalLabelsSettings_labelExclusionFilters = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GeneralLabelsSettings' {Maybe [Text]
labelExclusionFilters :: Maybe [Text]
$sel:labelExclusionFilters:GeneralLabelsSettings' :: GeneralLabelsSettings -> Maybe [Text]
labelExclusionFilters} -> Maybe [Text]
labelExclusionFilters) (\s :: GeneralLabelsSettings
s@GeneralLabelsSettings' {} Maybe [Text]
a -> GeneralLabelsSettings
s {$sel:labelExclusionFilters:GeneralLabelsSettings' :: Maybe [Text]
labelExclusionFilters = Maybe [Text]
a} :: GeneralLabelsSettings) 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 s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The labels that should be included in the return from DetectLabels.
generalLabelsSettings_labelInclusionFilters :: Lens.Lens' GeneralLabelsSettings (Prelude.Maybe [Prelude.Text])
generalLabelsSettings_labelInclusionFilters :: Lens' GeneralLabelsSettings (Maybe [Text])
generalLabelsSettings_labelInclusionFilters = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GeneralLabelsSettings' {Maybe [Text]
labelInclusionFilters :: Maybe [Text]
$sel:labelInclusionFilters:GeneralLabelsSettings' :: GeneralLabelsSettings -> Maybe [Text]
labelInclusionFilters} -> Maybe [Text]
labelInclusionFilters) (\s :: GeneralLabelsSettings
s@GeneralLabelsSettings' {} Maybe [Text]
a -> GeneralLabelsSettings
s {$sel:labelInclusionFilters:GeneralLabelsSettings' :: Maybe [Text]
labelInclusionFilters = Maybe [Text]
a} :: GeneralLabelsSettings) 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 s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Prelude.Hashable GeneralLabelsSettings where
  hashWithSalt :: Int -> GeneralLabelsSettings -> Int
hashWithSalt Int
_salt GeneralLabelsSettings' {Maybe [Text]
labelInclusionFilters :: Maybe [Text]
labelExclusionFilters :: Maybe [Text]
labelCategoryInclusionFilters :: Maybe [Text]
labelCategoryExclusionFilters :: Maybe [Text]
$sel:labelInclusionFilters:GeneralLabelsSettings' :: GeneralLabelsSettings -> Maybe [Text]
$sel:labelExclusionFilters:GeneralLabelsSettings' :: GeneralLabelsSettings -> Maybe [Text]
$sel:labelCategoryInclusionFilters:GeneralLabelsSettings' :: GeneralLabelsSettings -> Maybe [Text]
$sel:labelCategoryExclusionFilters:GeneralLabelsSettings' :: GeneralLabelsSettings -> Maybe [Text]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
labelCategoryExclusionFilters
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
labelCategoryInclusionFilters
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
labelExclusionFilters
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
labelInclusionFilters

instance Prelude.NFData GeneralLabelsSettings where
  rnf :: GeneralLabelsSettings -> ()
rnf GeneralLabelsSettings' {Maybe [Text]
labelInclusionFilters :: Maybe [Text]
labelExclusionFilters :: Maybe [Text]
labelCategoryInclusionFilters :: Maybe [Text]
labelCategoryExclusionFilters :: Maybe [Text]
$sel:labelInclusionFilters:GeneralLabelsSettings' :: GeneralLabelsSettings -> Maybe [Text]
$sel:labelExclusionFilters:GeneralLabelsSettings' :: GeneralLabelsSettings -> Maybe [Text]
$sel:labelCategoryInclusionFilters:GeneralLabelsSettings' :: GeneralLabelsSettings -> Maybe [Text]
$sel:labelCategoryExclusionFilters:GeneralLabelsSettings' :: GeneralLabelsSettings -> Maybe [Text]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
labelCategoryExclusionFilters
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
labelCategoryInclusionFilters
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
labelExclusionFilters
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
labelInclusionFilters

instance Data.ToJSON GeneralLabelsSettings where
  toJSON :: GeneralLabelsSettings -> Value
toJSON GeneralLabelsSettings' {Maybe [Text]
labelInclusionFilters :: Maybe [Text]
labelExclusionFilters :: Maybe [Text]
labelCategoryInclusionFilters :: Maybe [Text]
labelCategoryExclusionFilters :: Maybe [Text]
$sel:labelInclusionFilters:GeneralLabelsSettings' :: GeneralLabelsSettings -> Maybe [Text]
$sel:labelExclusionFilters:GeneralLabelsSettings' :: GeneralLabelsSettings -> Maybe [Text]
$sel:labelCategoryInclusionFilters:GeneralLabelsSettings' :: GeneralLabelsSettings -> Maybe [Text]
$sel:labelCategoryExclusionFilters:GeneralLabelsSettings' :: GeneralLabelsSettings -> Maybe [Text]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"LabelCategoryExclusionFilters" 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]
labelCategoryExclusionFilters,
            (Key
"LabelCategoryInclusionFilters" 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]
labelCategoryInclusionFilters,
            (Key
"LabelExclusionFilters" 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]
labelExclusionFilters,
            (Key
"LabelInclusionFilters" 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]
labelInclusionFilters
          ]
      )