{-# 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.IoTDeviceAdvisor.Types.SuiteDefinitionInformation
-- 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.IoTDeviceAdvisor.Types.SuiteDefinitionInformation where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.IoTDeviceAdvisor.Types.DeviceUnderTest
import Amazonka.IoTDeviceAdvisor.Types.Protocol
import qualified Amazonka.Prelude as Prelude

-- | Information about the suite definition.
--
-- /See:/ 'newSuiteDefinitionInformation' smart constructor.
data SuiteDefinitionInformation = SuiteDefinitionInformation'
  { -- | Date (in Unix epoch time) when the test suite was created.
    SuiteDefinitionInformation -> Maybe POSIX
createdAt :: Prelude.Maybe Data.POSIX,
    -- | Specifies the devices that are under test for the test suite.
    SuiteDefinitionInformation -> Maybe [DeviceUnderTest]
defaultDevices :: Prelude.Maybe [DeviceUnderTest],
    -- | Specifies if the test suite is intended for qualification.
    SuiteDefinitionInformation -> Maybe Bool
intendedForQualification :: Prelude.Maybe Prelude.Bool,
    -- | Verifies if the test suite is a long duration test.
    SuiteDefinitionInformation -> Maybe Bool
isLongDurationTest :: Prelude.Maybe Prelude.Bool,
    -- | Gets the MQTT protocol that is configured in the suite definition.
    SuiteDefinitionInformation -> Maybe Protocol
protocol :: Prelude.Maybe Protocol,
    -- | Suite definition ID of the test suite.
    SuiteDefinitionInformation -> Maybe Text
suiteDefinitionId :: Prelude.Maybe Prelude.Text,
    -- | Suite name of the test suite.
    SuiteDefinitionInformation -> Maybe Text
suiteDefinitionName :: Prelude.Maybe Prelude.Text
  }
  deriving (SuiteDefinitionInformation -> SuiteDefinitionInformation -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: SuiteDefinitionInformation -> SuiteDefinitionInformation -> Bool
$c/= :: SuiteDefinitionInformation -> SuiteDefinitionInformation -> Bool
== :: SuiteDefinitionInformation -> SuiteDefinitionInformation -> Bool
$c== :: SuiteDefinitionInformation -> SuiteDefinitionInformation -> Bool
Prelude.Eq, ReadPrec [SuiteDefinitionInformation]
ReadPrec SuiteDefinitionInformation
Int -> ReadS SuiteDefinitionInformation
ReadS [SuiteDefinitionInformation]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [SuiteDefinitionInformation]
$creadListPrec :: ReadPrec [SuiteDefinitionInformation]
readPrec :: ReadPrec SuiteDefinitionInformation
$creadPrec :: ReadPrec SuiteDefinitionInformation
readList :: ReadS [SuiteDefinitionInformation]
$creadList :: ReadS [SuiteDefinitionInformation]
readsPrec :: Int -> ReadS SuiteDefinitionInformation
$creadsPrec :: Int -> ReadS SuiteDefinitionInformation
Prelude.Read, Int -> SuiteDefinitionInformation -> ShowS
[SuiteDefinitionInformation] -> ShowS
SuiteDefinitionInformation -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [SuiteDefinitionInformation] -> ShowS
$cshowList :: [SuiteDefinitionInformation] -> ShowS
show :: SuiteDefinitionInformation -> String
$cshow :: SuiteDefinitionInformation -> String
showsPrec :: Int -> SuiteDefinitionInformation -> ShowS
$cshowsPrec :: Int -> SuiteDefinitionInformation -> ShowS
Prelude.Show, forall x.
Rep SuiteDefinitionInformation x -> SuiteDefinitionInformation
forall x.
SuiteDefinitionInformation -> Rep SuiteDefinitionInformation x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep SuiteDefinitionInformation x -> SuiteDefinitionInformation
$cfrom :: forall x.
SuiteDefinitionInformation -> Rep SuiteDefinitionInformation x
Prelude.Generic)

-- |
-- Create a value of 'SuiteDefinitionInformation' 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:
--
-- 'createdAt', 'suiteDefinitionInformation_createdAt' - Date (in Unix epoch time) when the test suite was created.
--
-- 'defaultDevices', 'suiteDefinitionInformation_defaultDevices' - Specifies the devices that are under test for the test suite.
--
-- 'intendedForQualification', 'suiteDefinitionInformation_intendedForQualification' - Specifies if the test suite is intended for qualification.
--
-- 'isLongDurationTest', 'suiteDefinitionInformation_isLongDurationTest' - Verifies if the test suite is a long duration test.
--
-- 'protocol', 'suiteDefinitionInformation_protocol' - Gets the MQTT protocol that is configured in the suite definition.
--
-- 'suiteDefinitionId', 'suiteDefinitionInformation_suiteDefinitionId' - Suite definition ID of the test suite.
--
-- 'suiteDefinitionName', 'suiteDefinitionInformation_suiteDefinitionName' - Suite name of the test suite.
newSuiteDefinitionInformation ::
  SuiteDefinitionInformation
newSuiteDefinitionInformation :: SuiteDefinitionInformation
newSuiteDefinitionInformation =
  SuiteDefinitionInformation'
    { $sel:createdAt:SuiteDefinitionInformation' :: Maybe POSIX
createdAt =
        forall a. Maybe a
Prelude.Nothing,
      $sel:defaultDevices:SuiteDefinitionInformation' :: Maybe [DeviceUnderTest]
defaultDevices = forall a. Maybe a
Prelude.Nothing,
      $sel:intendedForQualification:SuiteDefinitionInformation' :: Maybe Bool
intendedForQualification = forall a. Maybe a
Prelude.Nothing,
      $sel:isLongDurationTest:SuiteDefinitionInformation' :: Maybe Bool
isLongDurationTest = forall a. Maybe a
Prelude.Nothing,
      $sel:protocol:SuiteDefinitionInformation' :: Maybe Protocol
protocol = forall a. Maybe a
Prelude.Nothing,
      $sel:suiteDefinitionId:SuiteDefinitionInformation' :: Maybe Text
suiteDefinitionId = forall a. Maybe a
Prelude.Nothing,
      $sel:suiteDefinitionName:SuiteDefinitionInformation' :: Maybe Text
suiteDefinitionName = forall a. Maybe a
Prelude.Nothing
    }

-- | Date (in Unix epoch time) when the test suite was created.
suiteDefinitionInformation_createdAt :: Lens.Lens' SuiteDefinitionInformation (Prelude.Maybe Prelude.UTCTime)
suiteDefinitionInformation_createdAt :: Lens' SuiteDefinitionInformation (Maybe UTCTime)
suiteDefinitionInformation_createdAt = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SuiteDefinitionInformation' {Maybe POSIX
createdAt :: Maybe POSIX
$sel:createdAt:SuiteDefinitionInformation' :: SuiteDefinitionInformation -> Maybe POSIX
createdAt} -> Maybe POSIX
createdAt) (\s :: SuiteDefinitionInformation
s@SuiteDefinitionInformation' {} Maybe POSIX
a -> SuiteDefinitionInformation
s {$sel:createdAt:SuiteDefinitionInformation' :: Maybe POSIX
createdAt = Maybe POSIX
a} :: SuiteDefinitionInformation) 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

-- | Specifies the devices that are under test for the test suite.
suiteDefinitionInformation_defaultDevices :: Lens.Lens' SuiteDefinitionInformation (Prelude.Maybe [DeviceUnderTest])
suiteDefinitionInformation_defaultDevices :: Lens' SuiteDefinitionInformation (Maybe [DeviceUnderTest])
suiteDefinitionInformation_defaultDevices = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SuiteDefinitionInformation' {Maybe [DeviceUnderTest]
defaultDevices :: Maybe [DeviceUnderTest]
$sel:defaultDevices:SuiteDefinitionInformation' :: SuiteDefinitionInformation -> Maybe [DeviceUnderTest]
defaultDevices} -> Maybe [DeviceUnderTest]
defaultDevices) (\s :: SuiteDefinitionInformation
s@SuiteDefinitionInformation' {} Maybe [DeviceUnderTest]
a -> SuiteDefinitionInformation
s {$sel:defaultDevices:SuiteDefinitionInformation' :: Maybe [DeviceUnderTest]
defaultDevices = Maybe [DeviceUnderTest]
a} :: SuiteDefinitionInformation) 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

-- | Specifies if the test suite is intended for qualification.
suiteDefinitionInformation_intendedForQualification :: Lens.Lens' SuiteDefinitionInformation (Prelude.Maybe Prelude.Bool)
suiteDefinitionInformation_intendedForQualification :: Lens' SuiteDefinitionInformation (Maybe Bool)
suiteDefinitionInformation_intendedForQualification = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SuiteDefinitionInformation' {Maybe Bool
intendedForQualification :: Maybe Bool
$sel:intendedForQualification:SuiteDefinitionInformation' :: SuiteDefinitionInformation -> Maybe Bool
intendedForQualification} -> Maybe Bool
intendedForQualification) (\s :: SuiteDefinitionInformation
s@SuiteDefinitionInformation' {} Maybe Bool
a -> SuiteDefinitionInformation
s {$sel:intendedForQualification:SuiteDefinitionInformation' :: Maybe Bool
intendedForQualification = Maybe Bool
a} :: SuiteDefinitionInformation)

-- | Verifies if the test suite is a long duration test.
suiteDefinitionInformation_isLongDurationTest :: Lens.Lens' SuiteDefinitionInformation (Prelude.Maybe Prelude.Bool)
suiteDefinitionInformation_isLongDurationTest :: Lens' SuiteDefinitionInformation (Maybe Bool)
suiteDefinitionInformation_isLongDurationTest = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SuiteDefinitionInformation' {Maybe Bool
isLongDurationTest :: Maybe Bool
$sel:isLongDurationTest:SuiteDefinitionInformation' :: SuiteDefinitionInformation -> Maybe Bool
isLongDurationTest} -> Maybe Bool
isLongDurationTest) (\s :: SuiteDefinitionInformation
s@SuiteDefinitionInformation' {} Maybe Bool
a -> SuiteDefinitionInformation
s {$sel:isLongDurationTest:SuiteDefinitionInformation' :: Maybe Bool
isLongDurationTest = Maybe Bool
a} :: SuiteDefinitionInformation)

-- | Gets the MQTT protocol that is configured in the suite definition.
suiteDefinitionInformation_protocol :: Lens.Lens' SuiteDefinitionInformation (Prelude.Maybe Protocol)
suiteDefinitionInformation_protocol :: Lens' SuiteDefinitionInformation (Maybe Protocol)
suiteDefinitionInformation_protocol = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SuiteDefinitionInformation' {Maybe Protocol
protocol :: Maybe Protocol
$sel:protocol:SuiteDefinitionInformation' :: SuiteDefinitionInformation -> Maybe Protocol
protocol} -> Maybe Protocol
protocol) (\s :: SuiteDefinitionInformation
s@SuiteDefinitionInformation' {} Maybe Protocol
a -> SuiteDefinitionInformation
s {$sel:protocol:SuiteDefinitionInformation' :: Maybe Protocol
protocol = Maybe Protocol
a} :: SuiteDefinitionInformation)

-- | Suite definition ID of the test suite.
suiteDefinitionInformation_suiteDefinitionId :: Lens.Lens' SuiteDefinitionInformation (Prelude.Maybe Prelude.Text)
suiteDefinitionInformation_suiteDefinitionId :: Lens' SuiteDefinitionInformation (Maybe Text)
suiteDefinitionInformation_suiteDefinitionId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SuiteDefinitionInformation' {Maybe Text
suiteDefinitionId :: Maybe Text
$sel:suiteDefinitionId:SuiteDefinitionInformation' :: SuiteDefinitionInformation -> Maybe Text
suiteDefinitionId} -> Maybe Text
suiteDefinitionId) (\s :: SuiteDefinitionInformation
s@SuiteDefinitionInformation' {} Maybe Text
a -> SuiteDefinitionInformation
s {$sel:suiteDefinitionId:SuiteDefinitionInformation' :: Maybe Text
suiteDefinitionId = Maybe Text
a} :: SuiteDefinitionInformation)

-- | Suite name of the test suite.
suiteDefinitionInformation_suiteDefinitionName :: Lens.Lens' SuiteDefinitionInformation (Prelude.Maybe Prelude.Text)
suiteDefinitionInformation_suiteDefinitionName :: Lens' SuiteDefinitionInformation (Maybe Text)
suiteDefinitionInformation_suiteDefinitionName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SuiteDefinitionInformation' {Maybe Text
suiteDefinitionName :: Maybe Text
$sel:suiteDefinitionName:SuiteDefinitionInformation' :: SuiteDefinitionInformation -> Maybe Text
suiteDefinitionName} -> Maybe Text
suiteDefinitionName) (\s :: SuiteDefinitionInformation
s@SuiteDefinitionInformation' {} Maybe Text
a -> SuiteDefinitionInformation
s {$sel:suiteDefinitionName:SuiteDefinitionInformation' :: Maybe Text
suiteDefinitionName = Maybe Text
a} :: SuiteDefinitionInformation)

instance Data.FromJSON SuiteDefinitionInformation where
  parseJSON :: Value -> Parser SuiteDefinitionInformation
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"SuiteDefinitionInformation"
      ( \Object
x ->
          Maybe POSIX
-> Maybe [DeviceUnderTest]
-> Maybe Bool
-> Maybe Bool
-> Maybe Protocol
-> Maybe Text
-> Maybe Text
-> SuiteDefinitionInformation
SuiteDefinitionInformation'
            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
"createdAt")
            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
"defaultDevices" 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
"intendedForQualification")
            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
"isLongDurationTest")
            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
"protocol")
            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
"suiteDefinitionId")
            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
"suiteDefinitionName")
      )

instance Prelude.Hashable SuiteDefinitionInformation where
  hashWithSalt :: Int -> SuiteDefinitionInformation -> Int
hashWithSalt Int
_salt SuiteDefinitionInformation' {Maybe Bool
Maybe [DeviceUnderTest]
Maybe Text
Maybe POSIX
Maybe Protocol
suiteDefinitionName :: Maybe Text
suiteDefinitionId :: Maybe Text
protocol :: Maybe Protocol
isLongDurationTest :: Maybe Bool
intendedForQualification :: Maybe Bool
defaultDevices :: Maybe [DeviceUnderTest]
createdAt :: Maybe POSIX
$sel:suiteDefinitionName:SuiteDefinitionInformation' :: SuiteDefinitionInformation -> Maybe Text
$sel:suiteDefinitionId:SuiteDefinitionInformation' :: SuiteDefinitionInformation -> Maybe Text
$sel:protocol:SuiteDefinitionInformation' :: SuiteDefinitionInformation -> Maybe Protocol
$sel:isLongDurationTest:SuiteDefinitionInformation' :: SuiteDefinitionInformation -> Maybe Bool
$sel:intendedForQualification:SuiteDefinitionInformation' :: SuiteDefinitionInformation -> Maybe Bool
$sel:defaultDevices:SuiteDefinitionInformation' :: SuiteDefinitionInformation -> Maybe [DeviceUnderTest]
$sel:createdAt:SuiteDefinitionInformation' :: SuiteDefinitionInformation -> Maybe POSIX
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
createdAt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [DeviceUnderTest]
defaultDevices
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
intendedForQualification
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
isLongDurationTest
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Protocol
protocol
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
suiteDefinitionId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
suiteDefinitionName

instance Prelude.NFData SuiteDefinitionInformation where
  rnf :: SuiteDefinitionInformation -> ()
rnf SuiteDefinitionInformation' {Maybe Bool
Maybe [DeviceUnderTest]
Maybe Text
Maybe POSIX
Maybe Protocol
suiteDefinitionName :: Maybe Text
suiteDefinitionId :: Maybe Text
protocol :: Maybe Protocol
isLongDurationTest :: Maybe Bool
intendedForQualification :: Maybe Bool
defaultDevices :: Maybe [DeviceUnderTest]
createdAt :: Maybe POSIX
$sel:suiteDefinitionName:SuiteDefinitionInformation' :: SuiteDefinitionInformation -> Maybe Text
$sel:suiteDefinitionId:SuiteDefinitionInformation' :: SuiteDefinitionInformation -> Maybe Text
$sel:protocol:SuiteDefinitionInformation' :: SuiteDefinitionInformation -> Maybe Protocol
$sel:isLongDurationTest:SuiteDefinitionInformation' :: SuiteDefinitionInformation -> Maybe Bool
$sel:intendedForQualification:SuiteDefinitionInformation' :: SuiteDefinitionInformation -> Maybe Bool
$sel:defaultDevices:SuiteDefinitionInformation' :: SuiteDefinitionInformation -> Maybe [DeviceUnderTest]
$sel:createdAt:SuiteDefinitionInformation' :: SuiteDefinitionInformation -> Maybe POSIX
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
createdAt
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [DeviceUnderTest]
defaultDevices
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
intendedForQualification
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
isLongDurationTest
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Protocol
protocol
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
suiteDefinitionId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
suiteDefinitionName