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

-- | The metadata for a feature. It can either be metadata that you specify,
-- or metadata that is updated automatically.
--
-- /See:/ 'newFeatureMetadata' smart constructor.
data FeatureMetadata = FeatureMetadata'
  { -- | A timestamp indicating when the feature was created.
    FeatureMetadata -> Maybe POSIX
creationTime :: Prelude.Maybe Data.POSIX,
    -- | An optional description that you specify to better describe the feature.
    FeatureMetadata -> Maybe Text
description :: Prelude.Maybe Prelude.Text,
    -- | The Amazon Resource Number (ARN) of the feature group.
    FeatureMetadata -> Maybe Text
featureGroupArn :: Prelude.Maybe Prelude.Text,
    -- | The name of the feature group containing the feature.
    FeatureMetadata -> Maybe Text
featureGroupName :: Prelude.Maybe Prelude.Text,
    -- | The name of feature.
    FeatureMetadata -> Maybe Text
featureName :: Prelude.Maybe Prelude.Text,
    -- | The data type of the feature.
    FeatureMetadata -> Maybe FeatureType
featureType :: Prelude.Maybe FeatureType,
    -- | A timestamp indicating when the feature was last modified.
    FeatureMetadata -> Maybe POSIX
lastModifiedTime :: Prelude.Maybe Data.POSIX,
    -- | Optional key-value pairs that you specify to better describe the
    -- feature.
    FeatureMetadata -> Maybe [FeatureParameter]
parameters :: Prelude.Maybe [FeatureParameter]
  }
  deriving (FeatureMetadata -> FeatureMetadata -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: FeatureMetadata -> FeatureMetadata -> Bool
$c/= :: FeatureMetadata -> FeatureMetadata -> Bool
== :: FeatureMetadata -> FeatureMetadata -> Bool
$c== :: FeatureMetadata -> FeatureMetadata -> Bool
Prelude.Eq, ReadPrec [FeatureMetadata]
ReadPrec FeatureMetadata
Int -> ReadS FeatureMetadata
ReadS [FeatureMetadata]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [FeatureMetadata]
$creadListPrec :: ReadPrec [FeatureMetadata]
readPrec :: ReadPrec FeatureMetadata
$creadPrec :: ReadPrec FeatureMetadata
readList :: ReadS [FeatureMetadata]
$creadList :: ReadS [FeatureMetadata]
readsPrec :: Int -> ReadS FeatureMetadata
$creadsPrec :: Int -> ReadS FeatureMetadata
Prelude.Read, Int -> FeatureMetadata -> ShowS
[FeatureMetadata] -> ShowS
FeatureMetadata -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [FeatureMetadata] -> ShowS
$cshowList :: [FeatureMetadata] -> ShowS
show :: FeatureMetadata -> String
$cshow :: FeatureMetadata -> String
showsPrec :: Int -> FeatureMetadata -> ShowS
$cshowsPrec :: Int -> FeatureMetadata -> ShowS
Prelude.Show, forall x. Rep FeatureMetadata x -> FeatureMetadata
forall x. FeatureMetadata -> Rep FeatureMetadata x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep FeatureMetadata x -> FeatureMetadata
$cfrom :: forall x. FeatureMetadata -> Rep FeatureMetadata x
Prelude.Generic)

-- |
-- Create a value of 'FeatureMetadata' 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:
--
-- 'creationTime', 'featureMetadata_creationTime' - A timestamp indicating when the feature was created.
--
-- 'description', 'featureMetadata_description' - An optional description that you specify to better describe the feature.
--
-- 'featureGroupArn', 'featureMetadata_featureGroupArn' - The Amazon Resource Number (ARN) of the feature group.
--
-- 'featureGroupName', 'featureMetadata_featureGroupName' - The name of the feature group containing the feature.
--
-- 'featureName', 'featureMetadata_featureName' - The name of feature.
--
-- 'featureType', 'featureMetadata_featureType' - The data type of the feature.
--
-- 'lastModifiedTime', 'featureMetadata_lastModifiedTime' - A timestamp indicating when the feature was last modified.
--
-- 'parameters', 'featureMetadata_parameters' - Optional key-value pairs that you specify to better describe the
-- feature.
newFeatureMetadata ::
  FeatureMetadata
newFeatureMetadata :: FeatureMetadata
newFeatureMetadata =
  FeatureMetadata'
    { $sel:creationTime:FeatureMetadata' :: Maybe POSIX
creationTime = forall a. Maybe a
Prelude.Nothing,
      $sel:description:FeatureMetadata' :: Maybe Text
description = forall a. Maybe a
Prelude.Nothing,
      $sel:featureGroupArn:FeatureMetadata' :: Maybe Text
featureGroupArn = forall a. Maybe a
Prelude.Nothing,
      $sel:featureGroupName:FeatureMetadata' :: Maybe Text
featureGroupName = forall a. Maybe a
Prelude.Nothing,
      $sel:featureName:FeatureMetadata' :: Maybe Text
featureName = forall a. Maybe a
Prelude.Nothing,
      $sel:featureType:FeatureMetadata' :: Maybe FeatureType
featureType = forall a. Maybe a
Prelude.Nothing,
      $sel:lastModifiedTime:FeatureMetadata' :: Maybe POSIX
lastModifiedTime = forall a. Maybe a
Prelude.Nothing,
      $sel:parameters:FeatureMetadata' :: Maybe [FeatureParameter]
parameters = forall a. Maybe a
Prelude.Nothing
    }

-- | A timestamp indicating when the feature was created.
featureMetadata_creationTime :: Lens.Lens' FeatureMetadata (Prelude.Maybe Prelude.UTCTime)
featureMetadata_creationTime :: Lens' FeatureMetadata (Maybe UTCTime)
featureMetadata_creationTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FeatureMetadata' {Maybe POSIX
creationTime :: Maybe POSIX
$sel:creationTime:FeatureMetadata' :: FeatureMetadata -> Maybe POSIX
creationTime} -> Maybe POSIX
creationTime) (\s :: FeatureMetadata
s@FeatureMetadata' {} Maybe POSIX
a -> FeatureMetadata
s {$sel:creationTime:FeatureMetadata' :: Maybe POSIX
creationTime = Maybe POSIX
a} :: FeatureMetadata) 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

-- | An optional description that you specify to better describe the feature.
featureMetadata_description :: Lens.Lens' FeatureMetadata (Prelude.Maybe Prelude.Text)
featureMetadata_description :: Lens' FeatureMetadata (Maybe Text)
featureMetadata_description = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FeatureMetadata' {Maybe Text
description :: Maybe Text
$sel:description:FeatureMetadata' :: FeatureMetadata -> Maybe Text
description} -> Maybe Text
description) (\s :: FeatureMetadata
s@FeatureMetadata' {} Maybe Text
a -> FeatureMetadata
s {$sel:description:FeatureMetadata' :: Maybe Text
description = Maybe Text
a} :: FeatureMetadata)

-- | The Amazon Resource Number (ARN) of the feature group.
featureMetadata_featureGroupArn :: Lens.Lens' FeatureMetadata (Prelude.Maybe Prelude.Text)
featureMetadata_featureGroupArn :: Lens' FeatureMetadata (Maybe Text)
featureMetadata_featureGroupArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FeatureMetadata' {Maybe Text
featureGroupArn :: Maybe Text
$sel:featureGroupArn:FeatureMetadata' :: FeatureMetadata -> Maybe Text
featureGroupArn} -> Maybe Text
featureGroupArn) (\s :: FeatureMetadata
s@FeatureMetadata' {} Maybe Text
a -> FeatureMetadata
s {$sel:featureGroupArn:FeatureMetadata' :: Maybe Text
featureGroupArn = Maybe Text
a} :: FeatureMetadata)

-- | The name of the feature group containing the feature.
featureMetadata_featureGroupName :: Lens.Lens' FeatureMetadata (Prelude.Maybe Prelude.Text)
featureMetadata_featureGroupName :: Lens' FeatureMetadata (Maybe Text)
featureMetadata_featureGroupName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FeatureMetadata' {Maybe Text
featureGroupName :: Maybe Text
$sel:featureGroupName:FeatureMetadata' :: FeatureMetadata -> Maybe Text
featureGroupName} -> Maybe Text
featureGroupName) (\s :: FeatureMetadata
s@FeatureMetadata' {} Maybe Text
a -> FeatureMetadata
s {$sel:featureGroupName:FeatureMetadata' :: Maybe Text
featureGroupName = Maybe Text
a} :: FeatureMetadata)

-- | The name of feature.
featureMetadata_featureName :: Lens.Lens' FeatureMetadata (Prelude.Maybe Prelude.Text)
featureMetadata_featureName :: Lens' FeatureMetadata (Maybe Text)
featureMetadata_featureName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FeatureMetadata' {Maybe Text
featureName :: Maybe Text
$sel:featureName:FeatureMetadata' :: FeatureMetadata -> Maybe Text
featureName} -> Maybe Text
featureName) (\s :: FeatureMetadata
s@FeatureMetadata' {} Maybe Text
a -> FeatureMetadata
s {$sel:featureName:FeatureMetadata' :: Maybe Text
featureName = Maybe Text
a} :: FeatureMetadata)

-- | The data type of the feature.
featureMetadata_featureType :: Lens.Lens' FeatureMetadata (Prelude.Maybe FeatureType)
featureMetadata_featureType :: Lens' FeatureMetadata (Maybe FeatureType)
featureMetadata_featureType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FeatureMetadata' {Maybe FeatureType
featureType :: Maybe FeatureType
$sel:featureType:FeatureMetadata' :: FeatureMetadata -> Maybe FeatureType
featureType} -> Maybe FeatureType
featureType) (\s :: FeatureMetadata
s@FeatureMetadata' {} Maybe FeatureType
a -> FeatureMetadata
s {$sel:featureType:FeatureMetadata' :: Maybe FeatureType
featureType = Maybe FeatureType
a} :: FeatureMetadata)

-- | A timestamp indicating when the feature was last modified.
featureMetadata_lastModifiedTime :: Lens.Lens' FeatureMetadata (Prelude.Maybe Prelude.UTCTime)
featureMetadata_lastModifiedTime :: Lens' FeatureMetadata (Maybe UTCTime)
featureMetadata_lastModifiedTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FeatureMetadata' {Maybe POSIX
lastModifiedTime :: Maybe POSIX
$sel:lastModifiedTime:FeatureMetadata' :: FeatureMetadata -> Maybe POSIX
lastModifiedTime} -> Maybe POSIX
lastModifiedTime) (\s :: FeatureMetadata
s@FeatureMetadata' {} Maybe POSIX
a -> FeatureMetadata
s {$sel:lastModifiedTime:FeatureMetadata' :: Maybe POSIX
lastModifiedTime = Maybe POSIX
a} :: FeatureMetadata) 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

-- | Optional key-value pairs that you specify to better describe the
-- feature.
featureMetadata_parameters :: Lens.Lens' FeatureMetadata (Prelude.Maybe [FeatureParameter])
featureMetadata_parameters :: Lens' FeatureMetadata (Maybe [FeatureParameter])
featureMetadata_parameters = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FeatureMetadata' {Maybe [FeatureParameter]
parameters :: Maybe [FeatureParameter]
$sel:parameters:FeatureMetadata' :: FeatureMetadata -> Maybe [FeatureParameter]
parameters} -> Maybe [FeatureParameter]
parameters) (\s :: FeatureMetadata
s@FeatureMetadata' {} Maybe [FeatureParameter]
a -> FeatureMetadata
s {$sel:parameters:FeatureMetadata' :: Maybe [FeatureParameter]
parameters = Maybe [FeatureParameter]
a} :: FeatureMetadata) 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

instance Data.FromJSON FeatureMetadata where
  parseJSON :: Value -> Parser FeatureMetadata
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"FeatureMetadata"
      ( \Object
x ->
          Maybe POSIX
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe FeatureType
-> Maybe POSIX
-> Maybe [FeatureParameter]
-> FeatureMetadata
FeatureMetadata'
            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
"CreationTime")
            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
"Description")
            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
"FeatureGroupArn")
            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
"FeatureGroupName")
            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
"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")
            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
"LastModifiedTime")
            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
"Parameters" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
      )

instance Prelude.Hashable FeatureMetadata where
  hashWithSalt :: Int -> FeatureMetadata -> Int
hashWithSalt Int
_salt FeatureMetadata' {Maybe [FeatureParameter]
Maybe Text
Maybe POSIX
Maybe FeatureType
parameters :: Maybe [FeatureParameter]
lastModifiedTime :: Maybe POSIX
featureType :: Maybe FeatureType
featureName :: Maybe Text
featureGroupName :: Maybe Text
featureGroupArn :: Maybe Text
description :: Maybe Text
creationTime :: Maybe POSIX
$sel:parameters:FeatureMetadata' :: FeatureMetadata -> Maybe [FeatureParameter]
$sel:lastModifiedTime:FeatureMetadata' :: FeatureMetadata -> Maybe POSIX
$sel:featureType:FeatureMetadata' :: FeatureMetadata -> Maybe FeatureType
$sel:featureName:FeatureMetadata' :: FeatureMetadata -> Maybe Text
$sel:featureGroupName:FeatureMetadata' :: FeatureMetadata -> Maybe Text
$sel:featureGroupArn:FeatureMetadata' :: FeatureMetadata -> Maybe Text
$sel:description:FeatureMetadata' :: FeatureMetadata -> Maybe Text
$sel:creationTime:FeatureMetadata' :: FeatureMetadata -> Maybe POSIX
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
creationTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
description
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
featureGroupArn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
featureGroupName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
featureName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe FeatureType
featureType
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
lastModifiedTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [FeatureParameter]
parameters

instance Prelude.NFData FeatureMetadata where
  rnf :: FeatureMetadata -> ()
rnf FeatureMetadata' {Maybe [FeatureParameter]
Maybe Text
Maybe POSIX
Maybe FeatureType
parameters :: Maybe [FeatureParameter]
lastModifiedTime :: Maybe POSIX
featureType :: Maybe FeatureType
featureName :: Maybe Text
featureGroupName :: Maybe Text
featureGroupArn :: Maybe Text
description :: Maybe Text
creationTime :: Maybe POSIX
$sel:parameters:FeatureMetadata' :: FeatureMetadata -> Maybe [FeatureParameter]
$sel:lastModifiedTime:FeatureMetadata' :: FeatureMetadata -> Maybe POSIX
$sel:featureType:FeatureMetadata' :: FeatureMetadata -> Maybe FeatureType
$sel:featureName:FeatureMetadata' :: FeatureMetadata -> Maybe Text
$sel:featureGroupName:FeatureMetadata' :: FeatureMetadata -> Maybe Text
$sel:featureGroupArn:FeatureMetadata' :: FeatureMetadata -> Maybe Text
$sel:description:FeatureMetadata' :: FeatureMetadata -> Maybe Text
$sel:creationTime:FeatureMetadata' :: FeatureMetadata -> Maybe POSIX
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
creationTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
description
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
featureGroupArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
featureGroupName
      seq :: forall a b. a -> b -> b
`Prelude.seq` 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
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
lastModifiedTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [FeatureParameter]
parameters