{-# 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.FeatureDefinition
-- 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.FeatureDefinition 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
import Amazonka.SageMaker.Types.FeatureType

-- | A list of features. You must include @FeatureName@ and @FeatureType@.
-- Valid feature @FeatureType@s are @Integral@, @Fractional@ and @String@.
--
-- /See:/ 'newFeatureDefinition' smart constructor.
data FeatureDefinition = FeatureDefinition'
  { -- | The name of a feature. The type must be a string. @FeatureName@ cannot
    -- be any of the following: @is_deleted@, @write_time@,
    -- @api_invocation_time@.
    FeatureDefinition -> Maybe Text
featureName :: Prelude.Maybe Prelude.Text,
    -- | The value type of a feature. Valid values are Integral, Fractional, or
    -- String.
    FeatureDefinition -> Maybe FeatureType
featureType :: Prelude.Maybe FeatureType
  }
  deriving (FeatureDefinition -> FeatureDefinition -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: FeatureDefinition -> FeatureDefinition -> Bool
$c/= :: FeatureDefinition -> FeatureDefinition -> Bool
== :: FeatureDefinition -> FeatureDefinition -> Bool
$c== :: FeatureDefinition -> FeatureDefinition -> Bool
Prelude.Eq, ReadPrec [FeatureDefinition]
ReadPrec FeatureDefinition
Int -> ReadS FeatureDefinition
ReadS [FeatureDefinition]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [FeatureDefinition]
$creadListPrec :: ReadPrec [FeatureDefinition]
readPrec :: ReadPrec FeatureDefinition
$creadPrec :: ReadPrec FeatureDefinition
readList :: ReadS [FeatureDefinition]
$creadList :: ReadS [FeatureDefinition]
readsPrec :: Int -> ReadS FeatureDefinition
$creadsPrec :: Int -> ReadS FeatureDefinition
Prelude.Read, Int -> FeatureDefinition -> ShowS
[FeatureDefinition] -> ShowS
FeatureDefinition -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [FeatureDefinition] -> ShowS
$cshowList :: [FeatureDefinition] -> ShowS
show :: FeatureDefinition -> String
$cshow :: FeatureDefinition -> String
showsPrec :: Int -> FeatureDefinition -> ShowS
$cshowsPrec :: Int -> FeatureDefinition -> ShowS
Prelude.Show, forall x. Rep FeatureDefinition x -> FeatureDefinition
forall x. FeatureDefinition -> Rep FeatureDefinition x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep FeatureDefinition x -> FeatureDefinition
$cfrom :: forall x. FeatureDefinition -> Rep FeatureDefinition x
Prelude.Generic)

-- |
-- Create a value of 'FeatureDefinition' 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:
--
-- 'featureName', 'featureDefinition_featureName' - The name of a feature. The type must be a string. @FeatureName@ cannot
-- be any of the following: @is_deleted@, @write_time@,
-- @api_invocation_time@.
--
-- 'featureType', 'featureDefinition_featureType' - The value type of a feature. Valid values are Integral, Fractional, or
-- String.
newFeatureDefinition ::
  FeatureDefinition
newFeatureDefinition :: FeatureDefinition
newFeatureDefinition =
  FeatureDefinition'
    { $sel:featureName:FeatureDefinition' :: Maybe Text
featureName = forall a. Maybe a
Prelude.Nothing,
      $sel:featureType:FeatureDefinition' :: Maybe FeatureType
featureType = forall a. Maybe a
Prelude.Nothing
    }

-- | The name of a feature. The type must be a string. @FeatureName@ cannot
-- be any of the following: @is_deleted@, @write_time@,
-- @api_invocation_time@.
featureDefinition_featureName :: Lens.Lens' FeatureDefinition (Prelude.Maybe Prelude.Text)
featureDefinition_featureName :: Lens' FeatureDefinition (Maybe Text)
featureDefinition_featureName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FeatureDefinition' {Maybe Text
featureName :: Maybe Text
$sel:featureName:FeatureDefinition' :: FeatureDefinition -> Maybe Text
featureName} -> Maybe Text
featureName) (\s :: FeatureDefinition
s@FeatureDefinition' {} Maybe Text
a -> FeatureDefinition
s {$sel:featureName:FeatureDefinition' :: Maybe Text
featureName = Maybe Text
a} :: FeatureDefinition)

-- | The value type of a feature. Valid values are Integral, Fractional, or
-- String.
featureDefinition_featureType :: Lens.Lens' FeatureDefinition (Prelude.Maybe FeatureType)
featureDefinition_featureType :: Lens' FeatureDefinition (Maybe FeatureType)
featureDefinition_featureType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FeatureDefinition' {Maybe FeatureType
featureType :: Maybe FeatureType
$sel:featureType:FeatureDefinition' :: FeatureDefinition -> Maybe FeatureType
featureType} -> Maybe FeatureType
featureType) (\s :: FeatureDefinition
s@FeatureDefinition' {} Maybe FeatureType
a -> FeatureDefinition
s {$sel:featureType:FeatureDefinition' :: Maybe FeatureType
featureType = Maybe FeatureType
a} :: FeatureDefinition)

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

instance Prelude.Hashable FeatureDefinition where
  hashWithSalt :: Int -> FeatureDefinition -> Int
hashWithSalt Int
_salt FeatureDefinition' {Maybe Text
Maybe FeatureType
featureType :: Maybe FeatureType
featureName :: Maybe Text
$sel:featureType:FeatureDefinition' :: FeatureDefinition -> Maybe FeatureType
$sel:featureName:FeatureDefinition' :: FeatureDefinition -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
featureName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe FeatureType
featureType

instance Prelude.NFData FeatureDefinition where
  rnf :: FeatureDefinition -> ()
rnf FeatureDefinition' {Maybe Text
Maybe FeatureType
featureType :: Maybe FeatureType
featureName :: Maybe Text
$sel:featureType:FeatureDefinition' :: FeatureDefinition -> Maybe FeatureType
$sel:featureName:FeatureDefinition' :: FeatureDefinition -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
featureName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe FeatureType
featureType

instance Data.ToJSON FeatureDefinition where
  toJSON :: FeatureDefinition -> Value
toJSON FeatureDefinition' {Maybe Text
Maybe FeatureType
featureType :: Maybe FeatureType
featureName :: Maybe Text
$sel:featureType:FeatureDefinition' :: FeatureDefinition -> Maybe FeatureType
$sel:featureName:FeatureDefinition' :: FeatureDefinition -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"FeatureName" 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
featureName,
            (Key
"FeatureType" 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 FeatureType
featureType
          ]
      )