{-# 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.SageMaker.Types.TrialComponentParameterValue
-- 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.SageMaker.Types.TrialComponentParameterValue 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

-- | The value of a hyperparameter. Only one of @NumberValue@ or
-- @StringValue@ can be specified.
--
-- This object is specified in the CreateTrialComponent request.
--
-- /See:/ 'newTrialComponentParameterValue' smart constructor.
data TrialComponentParameterValue = TrialComponentParameterValue'
  { -- | The numeric value of a numeric hyperparameter. If you specify a value
    -- for this parameter, you can\'t specify the @StringValue@ parameter.
    TrialComponentParameterValue -> Maybe Double
numberValue :: Prelude.Maybe Prelude.Double,
    -- | The string value of a categorical hyperparameter. If you specify a value
    -- for this parameter, you can\'t specify the @NumberValue@ parameter.
    TrialComponentParameterValue -> Maybe Text
stringValue :: Prelude.Maybe Prelude.Text
  }
  deriving (TrialComponentParameterValue
-> TrialComponentParameterValue -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: TrialComponentParameterValue
-> TrialComponentParameterValue -> Bool
$c/= :: TrialComponentParameterValue
-> TrialComponentParameterValue -> Bool
== :: TrialComponentParameterValue
-> TrialComponentParameterValue -> Bool
$c== :: TrialComponentParameterValue
-> TrialComponentParameterValue -> Bool
Prelude.Eq, ReadPrec [TrialComponentParameterValue]
ReadPrec TrialComponentParameterValue
Int -> ReadS TrialComponentParameterValue
ReadS [TrialComponentParameterValue]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [TrialComponentParameterValue]
$creadListPrec :: ReadPrec [TrialComponentParameterValue]
readPrec :: ReadPrec TrialComponentParameterValue
$creadPrec :: ReadPrec TrialComponentParameterValue
readList :: ReadS [TrialComponentParameterValue]
$creadList :: ReadS [TrialComponentParameterValue]
readsPrec :: Int -> ReadS TrialComponentParameterValue
$creadsPrec :: Int -> ReadS TrialComponentParameterValue
Prelude.Read, Int -> TrialComponentParameterValue -> ShowS
[TrialComponentParameterValue] -> ShowS
TrialComponentParameterValue -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [TrialComponentParameterValue] -> ShowS
$cshowList :: [TrialComponentParameterValue] -> ShowS
show :: TrialComponentParameterValue -> String
$cshow :: TrialComponentParameterValue -> String
showsPrec :: Int -> TrialComponentParameterValue -> ShowS
$cshowsPrec :: Int -> TrialComponentParameterValue -> ShowS
Prelude.Show, forall x.
Rep TrialComponentParameterValue x -> TrialComponentParameterValue
forall x.
TrialComponentParameterValue -> Rep TrialComponentParameterValue x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep TrialComponentParameterValue x -> TrialComponentParameterValue
$cfrom :: forall x.
TrialComponentParameterValue -> Rep TrialComponentParameterValue x
Prelude.Generic)

-- |
-- Create a value of 'TrialComponentParameterValue' 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:
--
-- 'numberValue', 'trialComponentParameterValue_numberValue' - The numeric value of a numeric hyperparameter. If you specify a value
-- for this parameter, you can\'t specify the @StringValue@ parameter.
--
-- 'stringValue', 'trialComponentParameterValue_stringValue' - The string value of a categorical hyperparameter. If you specify a value
-- for this parameter, you can\'t specify the @NumberValue@ parameter.
newTrialComponentParameterValue ::
  TrialComponentParameterValue
newTrialComponentParameterValue :: TrialComponentParameterValue
newTrialComponentParameterValue =
  TrialComponentParameterValue'
    { $sel:numberValue:TrialComponentParameterValue' :: Maybe Double
numberValue =
        forall a. Maybe a
Prelude.Nothing,
      $sel:stringValue:TrialComponentParameterValue' :: Maybe Text
stringValue = forall a. Maybe a
Prelude.Nothing
    }

-- | The numeric value of a numeric hyperparameter. If you specify a value
-- for this parameter, you can\'t specify the @StringValue@ parameter.
trialComponentParameterValue_numberValue :: Lens.Lens' TrialComponentParameterValue (Prelude.Maybe Prelude.Double)
trialComponentParameterValue_numberValue :: Lens' TrialComponentParameterValue (Maybe Double)
trialComponentParameterValue_numberValue = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TrialComponentParameterValue' {Maybe Double
numberValue :: Maybe Double
$sel:numberValue:TrialComponentParameterValue' :: TrialComponentParameterValue -> Maybe Double
numberValue} -> Maybe Double
numberValue) (\s :: TrialComponentParameterValue
s@TrialComponentParameterValue' {} Maybe Double
a -> TrialComponentParameterValue
s {$sel:numberValue:TrialComponentParameterValue' :: Maybe Double
numberValue = Maybe Double
a} :: TrialComponentParameterValue)

-- | The string value of a categorical hyperparameter. If you specify a value
-- for this parameter, you can\'t specify the @NumberValue@ parameter.
trialComponentParameterValue_stringValue :: Lens.Lens' TrialComponentParameterValue (Prelude.Maybe Prelude.Text)
trialComponentParameterValue_stringValue :: Lens' TrialComponentParameterValue (Maybe Text)
trialComponentParameterValue_stringValue = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TrialComponentParameterValue' {Maybe Text
stringValue :: Maybe Text
$sel:stringValue:TrialComponentParameterValue' :: TrialComponentParameterValue -> Maybe Text
stringValue} -> Maybe Text
stringValue) (\s :: TrialComponentParameterValue
s@TrialComponentParameterValue' {} Maybe Text
a -> TrialComponentParameterValue
s {$sel:stringValue:TrialComponentParameterValue' :: Maybe Text
stringValue = Maybe Text
a} :: TrialComponentParameterValue)

instance Data.FromJSON TrialComponentParameterValue where
  parseJSON :: Value -> Parser TrialComponentParameterValue
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"TrialComponentParameterValue"
      ( \Object
x ->
          Maybe Double -> Maybe Text -> TrialComponentParameterValue
TrialComponentParameterValue'
            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
"NumberValue")
            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
"StringValue")
      )

instance
  Prelude.Hashable
    TrialComponentParameterValue
  where
  hashWithSalt :: Int -> TrialComponentParameterValue -> Int
hashWithSalt Int
_salt TrialComponentParameterValue' {Maybe Double
Maybe Text
stringValue :: Maybe Text
numberValue :: Maybe Double
$sel:stringValue:TrialComponentParameterValue' :: TrialComponentParameterValue -> Maybe Text
$sel:numberValue:TrialComponentParameterValue' :: TrialComponentParameterValue -> Maybe Double
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Double
numberValue
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
stringValue

instance Prelude.NFData TrialComponentParameterValue where
  rnf :: TrialComponentParameterValue -> ()
rnf TrialComponentParameterValue' {Maybe Double
Maybe Text
stringValue :: Maybe Text
numberValue :: Maybe Double
$sel:stringValue:TrialComponentParameterValue' :: TrialComponentParameterValue -> Maybe Text
$sel:numberValue:TrialComponentParameterValue' :: TrialComponentParameterValue -> Maybe Double
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Double
numberValue
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
stringValue

instance Data.ToJSON TrialComponentParameterValue where
  toJSON :: TrialComponentParameterValue -> Value
toJSON TrialComponentParameterValue' {Maybe Double
Maybe Text
stringValue :: Maybe Text
numberValue :: Maybe Double
$sel:stringValue:TrialComponentParameterValue' :: TrialComponentParameterValue -> Maybe Text
$sel:numberValue:TrialComponentParameterValue' :: TrialComponentParameterValue -> Maybe Double
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"NumberValue" 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 Double
numberValue,
            (Key
"StringValue" 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
stringValue
          ]
      )