{-# 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.Personalize.Types.Dataset
-- 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.Personalize.Types.Dataset 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

-- | Provides metadata for a dataset.
--
-- /See:/ 'newDataset' smart constructor.
data Dataset = Dataset'
  { -- | The creation date and time (in Unix time) of the dataset.
    Dataset -> Maybe POSIX
creationDateTime :: Prelude.Maybe Data.POSIX,
    -- | The Amazon Resource Name (ARN) of the dataset that you want metadata
    -- for.
    Dataset -> Maybe Text
datasetArn :: Prelude.Maybe Prelude.Text,
    -- | The Amazon Resource Name (ARN) of the dataset group.
    Dataset -> Maybe Text
datasetGroupArn :: Prelude.Maybe Prelude.Text,
    -- | One of the following values:
    --
    -- -   Interactions
    --
    -- -   Items
    --
    -- -   Users
    Dataset -> Maybe Text
datasetType :: Prelude.Maybe Prelude.Text,
    -- | A time stamp that shows when the dataset was updated.
    Dataset -> Maybe POSIX
lastUpdatedDateTime :: Prelude.Maybe Data.POSIX,
    -- | The name of the dataset.
    Dataset -> Maybe Text
name :: Prelude.Maybe Prelude.Text,
    -- | The ARN of the associated schema.
    Dataset -> Maybe Text
schemaArn :: Prelude.Maybe Prelude.Text,
    -- | The status of the dataset.
    --
    -- A dataset can be in one of the following states:
    --
    -- -   CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
    --
    -- -   DELETE PENDING > DELETE IN_PROGRESS
    Dataset -> Maybe Text
status :: Prelude.Maybe Prelude.Text
  }
  deriving (Dataset -> Dataset -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Dataset -> Dataset -> Bool
$c/= :: Dataset -> Dataset -> Bool
== :: Dataset -> Dataset -> Bool
$c== :: Dataset -> Dataset -> Bool
Prelude.Eq, ReadPrec [Dataset]
ReadPrec Dataset
Int -> ReadS Dataset
ReadS [Dataset]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Dataset]
$creadListPrec :: ReadPrec [Dataset]
readPrec :: ReadPrec Dataset
$creadPrec :: ReadPrec Dataset
readList :: ReadS [Dataset]
$creadList :: ReadS [Dataset]
readsPrec :: Int -> ReadS Dataset
$creadsPrec :: Int -> ReadS Dataset
Prelude.Read, Int -> Dataset -> ShowS
[Dataset] -> ShowS
Dataset -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Dataset] -> ShowS
$cshowList :: [Dataset] -> ShowS
show :: Dataset -> String
$cshow :: Dataset -> String
showsPrec :: Int -> Dataset -> ShowS
$cshowsPrec :: Int -> Dataset -> ShowS
Prelude.Show, forall x. Rep Dataset x -> Dataset
forall x. Dataset -> Rep Dataset x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Dataset x -> Dataset
$cfrom :: forall x. Dataset -> Rep Dataset x
Prelude.Generic)

-- |
-- Create a value of 'Dataset' 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:
--
-- 'creationDateTime', 'dataset_creationDateTime' - The creation date and time (in Unix time) of the dataset.
--
-- 'datasetArn', 'dataset_datasetArn' - The Amazon Resource Name (ARN) of the dataset that you want metadata
-- for.
--
-- 'datasetGroupArn', 'dataset_datasetGroupArn' - The Amazon Resource Name (ARN) of the dataset group.
--
-- 'datasetType', 'dataset_datasetType' - One of the following values:
--
-- -   Interactions
--
-- -   Items
--
-- -   Users
--
-- 'lastUpdatedDateTime', 'dataset_lastUpdatedDateTime' - A time stamp that shows when the dataset was updated.
--
-- 'name', 'dataset_name' - The name of the dataset.
--
-- 'schemaArn', 'dataset_schemaArn' - The ARN of the associated schema.
--
-- 'status', 'dataset_status' - The status of the dataset.
--
-- A dataset can be in one of the following states:
--
-- -   CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
--
-- -   DELETE PENDING > DELETE IN_PROGRESS
newDataset ::
  Dataset
newDataset :: Dataset
newDataset =
  Dataset'
    { $sel:creationDateTime:Dataset' :: Maybe POSIX
creationDateTime = forall a. Maybe a
Prelude.Nothing,
      $sel:datasetArn:Dataset' :: Maybe Text
datasetArn = forall a. Maybe a
Prelude.Nothing,
      $sel:datasetGroupArn:Dataset' :: Maybe Text
datasetGroupArn = forall a. Maybe a
Prelude.Nothing,
      $sel:datasetType:Dataset' :: Maybe Text
datasetType = forall a. Maybe a
Prelude.Nothing,
      $sel:lastUpdatedDateTime:Dataset' :: Maybe POSIX
lastUpdatedDateTime = forall a. Maybe a
Prelude.Nothing,
      $sel:name:Dataset' :: Maybe Text
name = forall a. Maybe a
Prelude.Nothing,
      $sel:schemaArn:Dataset' :: Maybe Text
schemaArn = forall a. Maybe a
Prelude.Nothing,
      $sel:status:Dataset' :: Maybe Text
status = forall a. Maybe a
Prelude.Nothing
    }

-- | The creation date and time (in Unix time) of the dataset.
dataset_creationDateTime :: Lens.Lens' Dataset (Prelude.Maybe Prelude.UTCTime)
dataset_creationDateTime :: Lens' Dataset (Maybe UTCTime)
dataset_creationDateTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Dataset' {Maybe POSIX
creationDateTime :: Maybe POSIX
$sel:creationDateTime:Dataset' :: Dataset -> Maybe POSIX
creationDateTime} -> Maybe POSIX
creationDateTime) (\s :: Dataset
s@Dataset' {} Maybe POSIX
a -> Dataset
s {$sel:creationDateTime:Dataset' :: Maybe POSIX
creationDateTime = Maybe POSIX
a} :: Dataset) 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

-- | The Amazon Resource Name (ARN) of the dataset that you want metadata
-- for.
dataset_datasetArn :: Lens.Lens' Dataset (Prelude.Maybe Prelude.Text)
dataset_datasetArn :: Lens' Dataset (Maybe Text)
dataset_datasetArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Dataset' {Maybe Text
datasetArn :: Maybe Text
$sel:datasetArn:Dataset' :: Dataset -> Maybe Text
datasetArn} -> Maybe Text
datasetArn) (\s :: Dataset
s@Dataset' {} Maybe Text
a -> Dataset
s {$sel:datasetArn:Dataset' :: Maybe Text
datasetArn = Maybe Text
a} :: Dataset)

-- | The Amazon Resource Name (ARN) of the dataset group.
dataset_datasetGroupArn :: Lens.Lens' Dataset (Prelude.Maybe Prelude.Text)
dataset_datasetGroupArn :: Lens' Dataset (Maybe Text)
dataset_datasetGroupArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Dataset' {Maybe Text
datasetGroupArn :: Maybe Text
$sel:datasetGroupArn:Dataset' :: Dataset -> Maybe Text
datasetGroupArn} -> Maybe Text
datasetGroupArn) (\s :: Dataset
s@Dataset' {} Maybe Text
a -> Dataset
s {$sel:datasetGroupArn:Dataset' :: Maybe Text
datasetGroupArn = Maybe Text
a} :: Dataset)

-- | One of the following values:
--
-- -   Interactions
--
-- -   Items
--
-- -   Users
dataset_datasetType :: Lens.Lens' Dataset (Prelude.Maybe Prelude.Text)
dataset_datasetType :: Lens' Dataset (Maybe Text)
dataset_datasetType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Dataset' {Maybe Text
datasetType :: Maybe Text
$sel:datasetType:Dataset' :: Dataset -> Maybe Text
datasetType} -> Maybe Text
datasetType) (\s :: Dataset
s@Dataset' {} Maybe Text
a -> Dataset
s {$sel:datasetType:Dataset' :: Maybe Text
datasetType = Maybe Text
a} :: Dataset)

-- | A time stamp that shows when the dataset was updated.
dataset_lastUpdatedDateTime :: Lens.Lens' Dataset (Prelude.Maybe Prelude.UTCTime)
dataset_lastUpdatedDateTime :: Lens' Dataset (Maybe UTCTime)
dataset_lastUpdatedDateTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Dataset' {Maybe POSIX
lastUpdatedDateTime :: Maybe POSIX
$sel:lastUpdatedDateTime:Dataset' :: Dataset -> Maybe POSIX
lastUpdatedDateTime} -> Maybe POSIX
lastUpdatedDateTime) (\s :: Dataset
s@Dataset' {} Maybe POSIX
a -> Dataset
s {$sel:lastUpdatedDateTime:Dataset' :: Maybe POSIX
lastUpdatedDateTime = Maybe POSIX
a} :: Dataset) 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

-- | The name of the dataset.
dataset_name :: Lens.Lens' Dataset (Prelude.Maybe Prelude.Text)
dataset_name :: Lens' Dataset (Maybe Text)
dataset_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Dataset' {Maybe Text
name :: Maybe Text
$sel:name:Dataset' :: Dataset -> Maybe Text
name} -> Maybe Text
name) (\s :: Dataset
s@Dataset' {} Maybe Text
a -> Dataset
s {$sel:name:Dataset' :: Maybe Text
name = Maybe Text
a} :: Dataset)

-- | The ARN of the associated schema.
dataset_schemaArn :: Lens.Lens' Dataset (Prelude.Maybe Prelude.Text)
dataset_schemaArn :: Lens' Dataset (Maybe Text)
dataset_schemaArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Dataset' {Maybe Text
schemaArn :: Maybe Text
$sel:schemaArn:Dataset' :: Dataset -> Maybe Text
schemaArn} -> Maybe Text
schemaArn) (\s :: Dataset
s@Dataset' {} Maybe Text
a -> Dataset
s {$sel:schemaArn:Dataset' :: Maybe Text
schemaArn = Maybe Text
a} :: Dataset)

-- | The status of the dataset.
--
-- A dataset can be in one of the following states:
--
-- -   CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
--
-- -   DELETE PENDING > DELETE IN_PROGRESS
dataset_status :: Lens.Lens' Dataset (Prelude.Maybe Prelude.Text)
dataset_status :: Lens' Dataset (Maybe Text)
dataset_status = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Dataset' {Maybe Text
status :: Maybe Text
$sel:status:Dataset' :: Dataset -> Maybe Text
status} -> Maybe Text
status) (\s :: Dataset
s@Dataset' {} Maybe Text
a -> Dataset
s {$sel:status:Dataset' :: Maybe Text
status = Maybe Text
a} :: Dataset)

instance Data.FromJSON Dataset where
  parseJSON :: Value -> Parser Dataset
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"Dataset"
      ( \Object
x ->
          Maybe POSIX
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe POSIX
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Dataset
Dataset'
            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
"creationDateTime")
            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
"datasetArn")
            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
"datasetGroupArn")
            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
"datasetType")
            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
"lastUpdatedDateTime")
            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
"name")
            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
"schemaArn")
            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
"status")
      )

instance Prelude.Hashable Dataset where
  hashWithSalt :: Int -> Dataset -> Int
hashWithSalt Int
_salt Dataset' {Maybe Text
Maybe POSIX
status :: Maybe Text
schemaArn :: Maybe Text
name :: Maybe Text
lastUpdatedDateTime :: Maybe POSIX
datasetType :: Maybe Text
datasetGroupArn :: Maybe Text
datasetArn :: Maybe Text
creationDateTime :: Maybe POSIX
$sel:status:Dataset' :: Dataset -> Maybe Text
$sel:schemaArn:Dataset' :: Dataset -> Maybe Text
$sel:name:Dataset' :: Dataset -> Maybe Text
$sel:lastUpdatedDateTime:Dataset' :: Dataset -> Maybe POSIX
$sel:datasetType:Dataset' :: Dataset -> Maybe Text
$sel:datasetGroupArn:Dataset' :: Dataset -> Maybe Text
$sel:datasetArn:Dataset' :: Dataset -> Maybe Text
$sel:creationDateTime:Dataset' :: Dataset -> Maybe POSIX
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
creationDateTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
datasetArn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
datasetGroupArn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
datasetType
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
lastUpdatedDateTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
schemaArn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
status

instance Prelude.NFData Dataset where
  rnf :: Dataset -> ()
rnf Dataset' {Maybe Text
Maybe POSIX
status :: Maybe Text
schemaArn :: Maybe Text
name :: Maybe Text
lastUpdatedDateTime :: Maybe POSIX
datasetType :: Maybe Text
datasetGroupArn :: Maybe Text
datasetArn :: Maybe Text
creationDateTime :: Maybe POSIX
$sel:status:Dataset' :: Dataset -> Maybe Text
$sel:schemaArn:Dataset' :: Dataset -> Maybe Text
$sel:name:Dataset' :: Dataset -> Maybe Text
$sel:lastUpdatedDateTime:Dataset' :: Dataset -> Maybe POSIX
$sel:datasetType:Dataset' :: Dataset -> Maybe Text
$sel:datasetGroupArn:Dataset' :: Dataset -> Maybe Text
$sel:datasetArn:Dataset' :: Dataset -> Maybe Text
$sel:creationDateTime:Dataset' :: Dataset -> Maybe POSIX
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
creationDateTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
datasetArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
datasetGroupArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
datasetType
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
lastUpdatedDateTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
name
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
schemaArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
status