{-# 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.Braket.Types.AlgorithmSpecification
-- 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.Braket.Types.AlgorithmSpecification where

import Amazonka.Braket.Types.ContainerImage
import Amazonka.Braket.Types.ScriptModeConfig
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

-- | Defines the Amazon Braket job to be created. Specifies the container
-- image the job uses and the paths to the Python scripts used for entry
-- and training.
--
-- /See:/ 'newAlgorithmSpecification' smart constructor.
data AlgorithmSpecification = AlgorithmSpecification'
  { -- | The container image used to create an Amazon Braket job.
    AlgorithmSpecification -> Maybe ContainerImage
containerImage :: Prelude.Maybe ContainerImage,
    -- | Configures the paths to the Python scripts used for entry and training.
    AlgorithmSpecification -> Maybe ScriptModeConfig
scriptModeConfig :: Prelude.Maybe ScriptModeConfig
  }
  deriving (AlgorithmSpecification -> AlgorithmSpecification -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: AlgorithmSpecification -> AlgorithmSpecification -> Bool
$c/= :: AlgorithmSpecification -> AlgorithmSpecification -> Bool
== :: AlgorithmSpecification -> AlgorithmSpecification -> Bool
$c== :: AlgorithmSpecification -> AlgorithmSpecification -> Bool
Prelude.Eq, ReadPrec [AlgorithmSpecification]
ReadPrec AlgorithmSpecification
Int -> ReadS AlgorithmSpecification
ReadS [AlgorithmSpecification]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [AlgorithmSpecification]
$creadListPrec :: ReadPrec [AlgorithmSpecification]
readPrec :: ReadPrec AlgorithmSpecification
$creadPrec :: ReadPrec AlgorithmSpecification
readList :: ReadS [AlgorithmSpecification]
$creadList :: ReadS [AlgorithmSpecification]
readsPrec :: Int -> ReadS AlgorithmSpecification
$creadsPrec :: Int -> ReadS AlgorithmSpecification
Prelude.Read, Int -> AlgorithmSpecification -> ShowS
[AlgorithmSpecification] -> ShowS
AlgorithmSpecification -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [AlgorithmSpecification] -> ShowS
$cshowList :: [AlgorithmSpecification] -> ShowS
show :: AlgorithmSpecification -> String
$cshow :: AlgorithmSpecification -> String
showsPrec :: Int -> AlgorithmSpecification -> ShowS
$cshowsPrec :: Int -> AlgorithmSpecification -> ShowS
Prelude.Show, forall x. Rep AlgorithmSpecification x -> AlgorithmSpecification
forall x. AlgorithmSpecification -> Rep AlgorithmSpecification x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep AlgorithmSpecification x -> AlgorithmSpecification
$cfrom :: forall x. AlgorithmSpecification -> Rep AlgorithmSpecification x
Prelude.Generic)

-- |
-- Create a value of 'AlgorithmSpecification' 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:
--
-- 'containerImage', 'algorithmSpecification_containerImage' - The container image used to create an Amazon Braket job.
--
-- 'scriptModeConfig', 'algorithmSpecification_scriptModeConfig' - Configures the paths to the Python scripts used for entry and training.
newAlgorithmSpecification ::
  AlgorithmSpecification
newAlgorithmSpecification :: AlgorithmSpecification
newAlgorithmSpecification =
  AlgorithmSpecification'
    { $sel:containerImage:AlgorithmSpecification' :: Maybe ContainerImage
containerImage =
        forall a. Maybe a
Prelude.Nothing,
      $sel:scriptModeConfig:AlgorithmSpecification' :: Maybe ScriptModeConfig
scriptModeConfig = forall a. Maybe a
Prelude.Nothing
    }

-- | The container image used to create an Amazon Braket job.
algorithmSpecification_containerImage :: Lens.Lens' AlgorithmSpecification (Prelude.Maybe ContainerImage)
algorithmSpecification_containerImage :: Lens' AlgorithmSpecification (Maybe ContainerImage)
algorithmSpecification_containerImage = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AlgorithmSpecification' {Maybe ContainerImage
containerImage :: Maybe ContainerImage
$sel:containerImage:AlgorithmSpecification' :: AlgorithmSpecification -> Maybe ContainerImage
containerImage} -> Maybe ContainerImage
containerImage) (\s :: AlgorithmSpecification
s@AlgorithmSpecification' {} Maybe ContainerImage
a -> AlgorithmSpecification
s {$sel:containerImage:AlgorithmSpecification' :: Maybe ContainerImage
containerImage = Maybe ContainerImage
a} :: AlgorithmSpecification)

-- | Configures the paths to the Python scripts used for entry and training.
algorithmSpecification_scriptModeConfig :: Lens.Lens' AlgorithmSpecification (Prelude.Maybe ScriptModeConfig)
algorithmSpecification_scriptModeConfig :: Lens' AlgorithmSpecification (Maybe ScriptModeConfig)
algorithmSpecification_scriptModeConfig = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\AlgorithmSpecification' {Maybe ScriptModeConfig
scriptModeConfig :: Maybe ScriptModeConfig
$sel:scriptModeConfig:AlgorithmSpecification' :: AlgorithmSpecification -> Maybe ScriptModeConfig
scriptModeConfig} -> Maybe ScriptModeConfig
scriptModeConfig) (\s :: AlgorithmSpecification
s@AlgorithmSpecification' {} Maybe ScriptModeConfig
a -> AlgorithmSpecification
s {$sel:scriptModeConfig:AlgorithmSpecification' :: Maybe ScriptModeConfig
scriptModeConfig = Maybe ScriptModeConfig
a} :: AlgorithmSpecification)

instance Data.FromJSON AlgorithmSpecification where
  parseJSON :: Value -> Parser AlgorithmSpecification
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"AlgorithmSpecification"
      ( \Object
x ->
          Maybe ContainerImage
-> Maybe ScriptModeConfig -> AlgorithmSpecification
AlgorithmSpecification'
            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
"containerImage")
            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
"scriptModeConfig")
      )

instance Prelude.Hashable AlgorithmSpecification where
  hashWithSalt :: Int -> AlgorithmSpecification -> Int
hashWithSalt Int
_salt AlgorithmSpecification' {Maybe ContainerImage
Maybe ScriptModeConfig
scriptModeConfig :: Maybe ScriptModeConfig
containerImage :: Maybe ContainerImage
$sel:scriptModeConfig:AlgorithmSpecification' :: AlgorithmSpecification -> Maybe ScriptModeConfig
$sel:containerImage:AlgorithmSpecification' :: AlgorithmSpecification -> Maybe ContainerImage
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ContainerImage
containerImage
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ScriptModeConfig
scriptModeConfig

instance Prelude.NFData AlgorithmSpecification where
  rnf :: AlgorithmSpecification -> ()
rnf AlgorithmSpecification' {Maybe ContainerImage
Maybe ScriptModeConfig
scriptModeConfig :: Maybe ScriptModeConfig
containerImage :: Maybe ContainerImage
$sel:scriptModeConfig:AlgorithmSpecification' :: AlgorithmSpecification -> Maybe ScriptModeConfig
$sel:containerImage:AlgorithmSpecification' :: AlgorithmSpecification -> Maybe ContainerImage
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe ContainerImage
containerImage
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ScriptModeConfig
scriptModeConfig

instance Data.ToJSON AlgorithmSpecification where
  toJSON :: AlgorithmSpecification -> Value
toJSON AlgorithmSpecification' {Maybe ContainerImage
Maybe ScriptModeConfig
scriptModeConfig :: Maybe ScriptModeConfig
containerImage :: Maybe ContainerImage
$sel:scriptModeConfig:AlgorithmSpecification' :: AlgorithmSpecification -> Maybe ScriptModeConfig
$sel:containerImage:AlgorithmSpecification' :: AlgorithmSpecification -> Maybe ContainerImage
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"containerImage" 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 ContainerImage
containerImage,
            (Key
"scriptModeConfig" 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 ScriptModeConfig
scriptModeConfig
          ]
      )