{-# 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.ExperimentSummary
-- 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.ExperimentSummary 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.ExperimentSource

-- | A summary of the properties of an experiment. To get the complete set of
-- properties, call the DescribeExperiment API and provide the
-- @ExperimentName@.
--
-- /See:/ 'newExperimentSummary' smart constructor.
data ExperimentSummary = ExperimentSummary'
  { -- | When the experiment was created.
    ExperimentSummary -> Maybe POSIX
creationTime :: Prelude.Maybe Data.POSIX,
    -- | The name of the experiment as displayed. If @DisplayName@ isn\'t
    -- specified, @ExperimentName@ is displayed.
    ExperimentSummary -> Maybe Text
displayName :: Prelude.Maybe Prelude.Text,
    -- | The Amazon Resource Name (ARN) of the experiment.
    ExperimentSummary -> Maybe Text
experimentArn :: Prelude.Maybe Prelude.Text,
    -- | The name of the experiment.
    ExperimentSummary -> Maybe Text
experimentName :: Prelude.Maybe Prelude.Text,
    ExperimentSummary -> Maybe ExperimentSource
experimentSource :: Prelude.Maybe ExperimentSource,
    -- | When the experiment was last modified.
    ExperimentSummary -> Maybe POSIX
lastModifiedTime :: Prelude.Maybe Data.POSIX
  }
  deriving (ExperimentSummary -> ExperimentSummary -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ExperimentSummary -> ExperimentSummary -> Bool
$c/= :: ExperimentSummary -> ExperimentSummary -> Bool
== :: ExperimentSummary -> ExperimentSummary -> Bool
$c== :: ExperimentSummary -> ExperimentSummary -> Bool
Prelude.Eq, ReadPrec [ExperimentSummary]
ReadPrec ExperimentSummary
Int -> ReadS ExperimentSummary
ReadS [ExperimentSummary]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ExperimentSummary]
$creadListPrec :: ReadPrec [ExperimentSummary]
readPrec :: ReadPrec ExperimentSummary
$creadPrec :: ReadPrec ExperimentSummary
readList :: ReadS [ExperimentSummary]
$creadList :: ReadS [ExperimentSummary]
readsPrec :: Int -> ReadS ExperimentSummary
$creadsPrec :: Int -> ReadS ExperimentSummary
Prelude.Read, Int -> ExperimentSummary -> ShowS
[ExperimentSummary] -> ShowS
ExperimentSummary -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ExperimentSummary] -> ShowS
$cshowList :: [ExperimentSummary] -> ShowS
show :: ExperimentSummary -> String
$cshow :: ExperimentSummary -> String
showsPrec :: Int -> ExperimentSummary -> ShowS
$cshowsPrec :: Int -> ExperimentSummary -> ShowS
Prelude.Show, forall x. Rep ExperimentSummary x -> ExperimentSummary
forall x. ExperimentSummary -> Rep ExperimentSummary x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ExperimentSummary x -> ExperimentSummary
$cfrom :: forall x. ExperimentSummary -> Rep ExperimentSummary x
Prelude.Generic)

-- |
-- Create a value of 'ExperimentSummary' 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', 'experimentSummary_creationTime' - When the experiment was created.
--
-- 'displayName', 'experimentSummary_displayName' - The name of the experiment as displayed. If @DisplayName@ isn\'t
-- specified, @ExperimentName@ is displayed.
--
-- 'experimentArn', 'experimentSummary_experimentArn' - The Amazon Resource Name (ARN) of the experiment.
--
-- 'experimentName', 'experimentSummary_experimentName' - The name of the experiment.
--
-- 'experimentSource', 'experimentSummary_experimentSource' - Undocumented member.
--
-- 'lastModifiedTime', 'experimentSummary_lastModifiedTime' - When the experiment was last modified.
newExperimentSummary ::
  ExperimentSummary
newExperimentSummary :: ExperimentSummary
newExperimentSummary =
  ExperimentSummary'
    { $sel:creationTime:ExperimentSummary' :: Maybe POSIX
creationTime = forall a. Maybe a
Prelude.Nothing,
      $sel:displayName:ExperimentSummary' :: Maybe Text
displayName = forall a. Maybe a
Prelude.Nothing,
      $sel:experimentArn:ExperimentSummary' :: Maybe Text
experimentArn = forall a. Maybe a
Prelude.Nothing,
      $sel:experimentName:ExperimentSummary' :: Maybe Text
experimentName = forall a. Maybe a
Prelude.Nothing,
      $sel:experimentSource:ExperimentSummary' :: Maybe ExperimentSource
experimentSource = forall a. Maybe a
Prelude.Nothing,
      $sel:lastModifiedTime:ExperimentSummary' :: Maybe POSIX
lastModifiedTime = forall a. Maybe a
Prelude.Nothing
    }

-- | When the experiment was created.
experimentSummary_creationTime :: Lens.Lens' ExperimentSummary (Prelude.Maybe Prelude.UTCTime)
experimentSummary_creationTime :: Lens' ExperimentSummary (Maybe UTCTime)
experimentSummary_creationTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ExperimentSummary' {Maybe POSIX
creationTime :: Maybe POSIX
$sel:creationTime:ExperimentSummary' :: ExperimentSummary -> Maybe POSIX
creationTime} -> Maybe POSIX
creationTime) (\s :: ExperimentSummary
s@ExperimentSummary' {} Maybe POSIX
a -> ExperimentSummary
s {$sel:creationTime:ExperimentSummary' :: Maybe POSIX
creationTime = Maybe POSIX
a} :: ExperimentSummary) 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 experiment as displayed. If @DisplayName@ isn\'t
-- specified, @ExperimentName@ is displayed.
experimentSummary_displayName :: Lens.Lens' ExperimentSummary (Prelude.Maybe Prelude.Text)
experimentSummary_displayName :: Lens' ExperimentSummary (Maybe Text)
experimentSummary_displayName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ExperimentSummary' {Maybe Text
displayName :: Maybe Text
$sel:displayName:ExperimentSummary' :: ExperimentSummary -> Maybe Text
displayName} -> Maybe Text
displayName) (\s :: ExperimentSummary
s@ExperimentSummary' {} Maybe Text
a -> ExperimentSummary
s {$sel:displayName:ExperimentSummary' :: Maybe Text
displayName = Maybe Text
a} :: ExperimentSummary)

-- | The Amazon Resource Name (ARN) of the experiment.
experimentSummary_experimentArn :: Lens.Lens' ExperimentSummary (Prelude.Maybe Prelude.Text)
experimentSummary_experimentArn :: Lens' ExperimentSummary (Maybe Text)
experimentSummary_experimentArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ExperimentSummary' {Maybe Text
experimentArn :: Maybe Text
$sel:experimentArn:ExperimentSummary' :: ExperimentSummary -> Maybe Text
experimentArn} -> Maybe Text
experimentArn) (\s :: ExperimentSummary
s@ExperimentSummary' {} Maybe Text
a -> ExperimentSummary
s {$sel:experimentArn:ExperimentSummary' :: Maybe Text
experimentArn = Maybe Text
a} :: ExperimentSummary)

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

-- | Undocumented member.
experimentSummary_experimentSource :: Lens.Lens' ExperimentSummary (Prelude.Maybe ExperimentSource)
experimentSummary_experimentSource :: Lens' ExperimentSummary (Maybe ExperimentSource)
experimentSummary_experimentSource = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ExperimentSummary' {Maybe ExperimentSource
experimentSource :: Maybe ExperimentSource
$sel:experimentSource:ExperimentSummary' :: ExperimentSummary -> Maybe ExperimentSource
experimentSource} -> Maybe ExperimentSource
experimentSource) (\s :: ExperimentSummary
s@ExperimentSummary' {} Maybe ExperimentSource
a -> ExperimentSummary
s {$sel:experimentSource:ExperimentSummary' :: Maybe ExperimentSource
experimentSource = Maybe ExperimentSource
a} :: ExperimentSummary)

-- | When the experiment was last modified.
experimentSummary_lastModifiedTime :: Lens.Lens' ExperimentSummary (Prelude.Maybe Prelude.UTCTime)
experimentSummary_lastModifiedTime :: Lens' ExperimentSummary (Maybe UTCTime)
experimentSummary_lastModifiedTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ExperimentSummary' {Maybe POSIX
lastModifiedTime :: Maybe POSIX
$sel:lastModifiedTime:ExperimentSummary' :: ExperimentSummary -> Maybe POSIX
lastModifiedTime} -> Maybe POSIX
lastModifiedTime) (\s :: ExperimentSummary
s@ExperimentSummary' {} Maybe POSIX
a -> ExperimentSummary
s {$sel:lastModifiedTime:ExperimentSummary' :: Maybe POSIX
lastModifiedTime = Maybe POSIX
a} :: ExperimentSummary) 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

instance Data.FromJSON ExperimentSummary where
  parseJSON :: Value -> Parser ExperimentSummary
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ExperimentSummary"
      ( \Object
x ->
          Maybe POSIX
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe ExperimentSource
-> Maybe POSIX
-> ExperimentSummary
ExperimentSummary'
            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
"DisplayName")
            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
"ExperimentArn")
            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
"ExperimentName")
            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
"ExperimentSource")
            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")
      )

instance Prelude.Hashable ExperimentSummary where
  hashWithSalt :: Int -> ExperimentSummary -> Int
hashWithSalt Int
_salt ExperimentSummary' {Maybe Text
Maybe POSIX
Maybe ExperimentSource
lastModifiedTime :: Maybe POSIX
experimentSource :: Maybe ExperimentSource
experimentName :: Maybe Text
experimentArn :: Maybe Text
displayName :: Maybe Text
creationTime :: Maybe POSIX
$sel:lastModifiedTime:ExperimentSummary' :: ExperimentSummary -> Maybe POSIX
$sel:experimentSource:ExperimentSummary' :: ExperimentSummary -> Maybe ExperimentSource
$sel:experimentName:ExperimentSummary' :: ExperimentSummary -> Maybe Text
$sel:experimentArn:ExperimentSummary' :: ExperimentSummary -> Maybe Text
$sel:displayName:ExperimentSummary' :: ExperimentSummary -> Maybe Text
$sel:creationTime:ExperimentSummary' :: ExperimentSummary -> 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
displayName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
experimentArn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
experimentName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ExperimentSource
experimentSource
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
lastModifiedTime

instance Prelude.NFData ExperimentSummary where
  rnf :: ExperimentSummary -> ()
rnf ExperimentSummary' {Maybe Text
Maybe POSIX
Maybe ExperimentSource
lastModifiedTime :: Maybe POSIX
experimentSource :: Maybe ExperimentSource
experimentName :: Maybe Text
experimentArn :: Maybe Text
displayName :: Maybe Text
creationTime :: Maybe POSIX
$sel:lastModifiedTime:ExperimentSummary' :: ExperimentSummary -> Maybe POSIX
$sel:experimentSource:ExperimentSummary' :: ExperimentSummary -> Maybe ExperimentSource
$sel:experimentName:ExperimentSummary' :: ExperimentSummary -> Maybe Text
$sel:experimentArn:ExperimentSummary' :: ExperimentSummary -> Maybe Text
$sel:displayName:ExperimentSummary' :: ExperimentSummary -> Maybe Text
$sel:creationTime:ExperimentSummary' :: ExperimentSummary -> 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
displayName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
experimentArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
experimentName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ExperimentSource
experimentSource
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
lastModifiedTime