{-# 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.IoT.Types.ThingGroupIndexingConfiguration
-- 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.IoT.Types.ThingGroupIndexingConfiguration where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.IoT.Types.Field
import Amazonka.IoT.Types.ThingGroupIndexingMode
import qualified Amazonka.Prelude as Prelude

-- | Thing group indexing configuration.
--
-- /See:/ 'newThingGroupIndexingConfiguration' smart constructor.
data ThingGroupIndexingConfiguration = ThingGroupIndexingConfiguration'
  { -- | A list of thing group fields to index. This list cannot contain any
    -- managed fields. Use the GetIndexingConfiguration API to get a list of
    -- managed fields.
    --
    -- Contains custom field names and their data type.
    ThingGroupIndexingConfiguration -> Maybe [Field]
customFields :: Prelude.Maybe [Field],
    -- | Contains fields that are indexed and whose types are already known by
    -- the Fleet Indexing service. This is an optional field. For more
    -- information, see
    -- <https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html#managed-field Managed fields>
    -- in the /Amazon Web Services IoT Core Developer Guide/.
    ThingGroupIndexingConfiguration -> Maybe [Field]
managedFields :: Prelude.Maybe [Field],
    -- | Thing group indexing mode.
    ThingGroupIndexingConfiguration -> ThingGroupIndexingMode
thingGroupIndexingMode :: ThingGroupIndexingMode
  }
  deriving (ThingGroupIndexingConfiguration
-> ThingGroupIndexingConfiguration -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ThingGroupIndexingConfiguration
-> ThingGroupIndexingConfiguration -> Bool
$c/= :: ThingGroupIndexingConfiguration
-> ThingGroupIndexingConfiguration -> Bool
== :: ThingGroupIndexingConfiguration
-> ThingGroupIndexingConfiguration -> Bool
$c== :: ThingGroupIndexingConfiguration
-> ThingGroupIndexingConfiguration -> Bool
Prelude.Eq, ReadPrec [ThingGroupIndexingConfiguration]
ReadPrec ThingGroupIndexingConfiguration
Int -> ReadS ThingGroupIndexingConfiguration
ReadS [ThingGroupIndexingConfiguration]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ThingGroupIndexingConfiguration]
$creadListPrec :: ReadPrec [ThingGroupIndexingConfiguration]
readPrec :: ReadPrec ThingGroupIndexingConfiguration
$creadPrec :: ReadPrec ThingGroupIndexingConfiguration
readList :: ReadS [ThingGroupIndexingConfiguration]
$creadList :: ReadS [ThingGroupIndexingConfiguration]
readsPrec :: Int -> ReadS ThingGroupIndexingConfiguration
$creadsPrec :: Int -> ReadS ThingGroupIndexingConfiguration
Prelude.Read, Int -> ThingGroupIndexingConfiguration -> ShowS
[ThingGroupIndexingConfiguration] -> ShowS
ThingGroupIndexingConfiguration -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ThingGroupIndexingConfiguration] -> ShowS
$cshowList :: [ThingGroupIndexingConfiguration] -> ShowS
show :: ThingGroupIndexingConfiguration -> String
$cshow :: ThingGroupIndexingConfiguration -> String
showsPrec :: Int -> ThingGroupIndexingConfiguration -> ShowS
$cshowsPrec :: Int -> ThingGroupIndexingConfiguration -> ShowS
Prelude.Show, forall x.
Rep ThingGroupIndexingConfiguration x
-> ThingGroupIndexingConfiguration
forall x.
ThingGroupIndexingConfiguration
-> Rep ThingGroupIndexingConfiguration x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep ThingGroupIndexingConfiguration x
-> ThingGroupIndexingConfiguration
$cfrom :: forall x.
ThingGroupIndexingConfiguration
-> Rep ThingGroupIndexingConfiguration x
Prelude.Generic)

-- |
-- Create a value of 'ThingGroupIndexingConfiguration' 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:
--
-- 'customFields', 'thingGroupIndexingConfiguration_customFields' - A list of thing group fields to index. This list cannot contain any
-- managed fields. Use the GetIndexingConfiguration API to get a list of
-- managed fields.
--
-- Contains custom field names and their data type.
--
-- 'managedFields', 'thingGroupIndexingConfiguration_managedFields' - Contains fields that are indexed and whose types are already known by
-- the Fleet Indexing service. This is an optional field. For more
-- information, see
-- <https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html#managed-field Managed fields>
-- in the /Amazon Web Services IoT Core Developer Guide/.
--
-- 'thingGroupIndexingMode', 'thingGroupIndexingConfiguration_thingGroupIndexingMode' - Thing group indexing mode.
newThingGroupIndexingConfiguration ::
  -- | 'thingGroupIndexingMode'
  ThingGroupIndexingMode ->
  ThingGroupIndexingConfiguration
newThingGroupIndexingConfiguration :: ThingGroupIndexingMode -> ThingGroupIndexingConfiguration
newThingGroupIndexingConfiguration
  ThingGroupIndexingMode
pThingGroupIndexingMode_ =
    ThingGroupIndexingConfiguration'
      { $sel:customFields:ThingGroupIndexingConfiguration' :: Maybe [Field]
customFields =
          forall a. Maybe a
Prelude.Nothing,
        $sel:managedFields:ThingGroupIndexingConfiguration' :: Maybe [Field]
managedFields = forall a. Maybe a
Prelude.Nothing,
        $sel:thingGroupIndexingMode:ThingGroupIndexingConfiguration' :: ThingGroupIndexingMode
thingGroupIndexingMode =
          ThingGroupIndexingMode
pThingGroupIndexingMode_
      }

-- | A list of thing group fields to index. This list cannot contain any
-- managed fields. Use the GetIndexingConfiguration API to get a list of
-- managed fields.
--
-- Contains custom field names and their data type.
thingGroupIndexingConfiguration_customFields :: Lens.Lens' ThingGroupIndexingConfiguration (Prelude.Maybe [Field])
thingGroupIndexingConfiguration_customFields :: Lens' ThingGroupIndexingConfiguration (Maybe [Field])
thingGroupIndexingConfiguration_customFields = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ThingGroupIndexingConfiguration' {Maybe [Field]
customFields :: Maybe [Field]
$sel:customFields:ThingGroupIndexingConfiguration' :: ThingGroupIndexingConfiguration -> Maybe [Field]
customFields} -> Maybe [Field]
customFields) (\s :: ThingGroupIndexingConfiguration
s@ThingGroupIndexingConfiguration' {} Maybe [Field]
a -> ThingGroupIndexingConfiguration
s {$sel:customFields:ThingGroupIndexingConfiguration' :: Maybe [Field]
customFields = Maybe [Field]
a} :: ThingGroupIndexingConfiguration) 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

-- | Contains fields that are indexed and whose types are already known by
-- the Fleet Indexing service. This is an optional field. For more
-- information, see
-- <https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html#managed-field Managed fields>
-- in the /Amazon Web Services IoT Core Developer Guide/.
thingGroupIndexingConfiguration_managedFields :: Lens.Lens' ThingGroupIndexingConfiguration (Prelude.Maybe [Field])
thingGroupIndexingConfiguration_managedFields :: Lens' ThingGroupIndexingConfiguration (Maybe [Field])
thingGroupIndexingConfiguration_managedFields = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ThingGroupIndexingConfiguration' {Maybe [Field]
managedFields :: Maybe [Field]
$sel:managedFields:ThingGroupIndexingConfiguration' :: ThingGroupIndexingConfiguration -> Maybe [Field]
managedFields} -> Maybe [Field]
managedFields) (\s :: ThingGroupIndexingConfiguration
s@ThingGroupIndexingConfiguration' {} Maybe [Field]
a -> ThingGroupIndexingConfiguration
s {$sel:managedFields:ThingGroupIndexingConfiguration' :: Maybe [Field]
managedFields = Maybe [Field]
a} :: ThingGroupIndexingConfiguration) 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

-- | Thing group indexing mode.
thingGroupIndexingConfiguration_thingGroupIndexingMode :: Lens.Lens' ThingGroupIndexingConfiguration ThingGroupIndexingMode
thingGroupIndexingConfiguration_thingGroupIndexingMode :: Lens' ThingGroupIndexingConfiguration ThingGroupIndexingMode
thingGroupIndexingConfiguration_thingGroupIndexingMode = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ThingGroupIndexingConfiguration' {ThingGroupIndexingMode
thingGroupIndexingMode :: ThingGroupIndexingMode
$sel:thingGroupIndexingMode:ThingGroupIndexingConfiguration' :: ThingGroupIndexingConfiguration -> ThingGroupIndexingMode
thingGroupIndexingMode} -> ThingGroupIndexingMode
thingGroupIndexingMode) (\s :: ThingGroupIndexingConfiguration
s@ThingGroupIndexingConfiguration' {} ThingGroupIndexingMode
a -> ThingGroupIndexingConfiguration
s {$sel:thingGroupIndexingMode:ThingGroupIndexingConfiguration' :: ThingGroupIndexingMode
thingGroupIndexingMode = ThingGroupIndexingMode
a} :: ThingGroupIndexingConfiguration)

instance
  Data.FromJSON
    ThingGroupIndexingConfiguration
  where
  parseJSON :: Value -> Parser ThingGroupIndexingConfiguration
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ThingGroupIndexingConfiguration"
      ( \Object
x ->
          Maybe [Field]
-> Maybe [Field]
-> ThingGroupIndexingMode
-> ThingGroupIndexingConfiguration
ThingGroupIndexingConfiguration'
            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
"customFields" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            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
"managedFields" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"thingGroupIndexingMode")
      )

instance
  Prelude.Hashable
    ThingGroupIndexingConfiguration
  where
  hashWithSalt :: Int -> ThingGroupIndexingConfiguration -> Int
hashWithSalt
    Int
_salt
    ThingGroupIndexingConfiguration' {Maybe [Field]
ThingGroupIndexingMode
thingGroupIndexingMode :: ThingGroupIndexingMode
managedFields :: Maybe [Field]
customFields :: Maybe [Field]
$sel:thingGroupIndexingMode:ThingGroupIndexingConfiguration' :: ThingGroupIndexingConfiguration -> ThingGroupIndexingMode
$sel:managedFields:ThingGroupIndexingConfiguration' :: ThingGroupIndexingConfiguration -> Maybe [Field]
$sel:customFields:ThingGroupIndexingConfiguration' :: ThingGroupIndexingConfiguration -> Maybe [Field]
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Field]
customFields
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Field]
managedFields
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` ThingGroupIndexingMode
thingGroupIndexingMode

instance
  Prelude.NFData
    ThingGroupIndexingConfiguration
  where
  rnf :: ThingGroupIndexingConfiguration -> ()
rnf ThingGroupIndexingConfiguration' {Maybe [Field]
ThingGroupIndexingMode
thingGroupIndexingMode :: ThingGroupIndexingMode
managedFields :: Maybe [Field]
customFields :: Maybe [Field]
$sel:thingGroupIndexingMode:ThingGroupIndexingConfiguration' :: ThingGroupIndexingConfiguration -> ThingGroupIndexingMode
$sel:managedFields:ThingGroupIndexingConfiguration' :: ThingGroupIndexingConfiguration -> Maybe [Field]
$sel:customFields:ThingGroupIndexingConfiguration' :: ThingGroupIndexingConfiguration -> Maybe [Field]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [Field]
customFields
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Field]
managedFields
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf ThingGroupIndexingMode
thingGroupIndexingMode

instance Data.ToJSON ThingGroupIndexingConfiguration where
  toJSON :: ThingGroupIndexingConfiguration -> Value
toJSON ThingGroupIndexingConfiguration' {Maybe [Field]
ThingGroupIndexingMode
thingGroupIndexingMode :: ThingGroupIndexingMode
managedFields :: Maybe [Field]
customFields :: Maybe [Field]
$sel:thingGroupIndexingMode:ThingGroupIndexingConfiguration' :: ThingGroupIndexingConfiguration -> ThingGroupIndexingMode
$sel:managedFields:ThingGroupIndexingConfiguration' :: ThingGroupIndexingConfiguration -> Maybe [Field]
$sel:customFields:ThingGroupIndexingConfiguration' :: ThingGroupIndexingConfiguration -> Maybe [Field]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"customFields" 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 [Field]
customFields,
            (Key
"managedFields" 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 [Field]
managedFields,
            forall a. a -> Maybe a
Prelude.Just
              ( Key
"thingGroupIndexingMode"
                  forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= ThingGroupIndexingMode
thingGroupIndexingMode
              )
          ]
      )