{-# 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.Athena.Types.CalculationStatus
-- 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.Athena.Types.CalculationStatus where

import Amazonka.Athena.Types.CalculationExecutionState
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

-- | Contains information about the status of a notebook calculation.
--
-- /See:/ 'newCalculationStatus' smart constructor.
data CalculationStatus = CalculationStatus'
  { -- | The date and time the calculation completed processing.
    CalculationStatus -> Maybe POSIX
completionDateTime :: Prelude.Maybe Data.POSIX,
    -- | The state of the calculation execution. A description of each state
    -- follows.
    --
    -- @CREATING@ - The calculation is in the process of being created.
    --
    -- @CREATED@ - The calculation has been created and is ready to run.
    --
    -- @QUEUED@ - The calculation has been queued for processing.
    --
    -- @RUNNING@ - The calculation is running.
    --
    -- @CANCELING@ - A request to cancel the calculation has been received and
    -- the system is working to stop it.
    --
    -- @CANCELED@ - The calculation is no longer running as the result of a
    -- cancel request.
    --
    -- @COMPLETED@ - The calculation has completed without error.
    --
    -- @FAILED@ - The calculation failed and is no longer running.
    CalculationStatus -> Maybe CalculationExecutionState
state :: Prelude.Maybe CalculationExecutionState,
    -- | The reason for the calculation state change (for example, the
    -- calculation was canceled because the session was terminated).
    CalculationStatus -> Maybe Text
stateChangeReason :: Prelude.Maybe Prelude.Text,
    -- | The date and time the calculation was submitted for processing.
    CalculationStatus -> Maybe POSIX
submissionDateTime :: Prelude.Maybe Data.POSIX
  }
  deriving (CalculationStatus -> CalculationStatus -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: CalculationStatus -> CalculationStatus -> Bool
$c/= :: CalculationStatus -> CalculationStatus -> Bool
== :: CalculationStatus -> CalculationStatus -> Bool
$c== :: CalculationStatus -> CalculationStatus -> Bool
Prelude.Eq, ReadPrec [CalculationStatus]
ReadPrec CalculationStatus
Int -> ReadS CalculationStatus
ReadS [CalculationStatus]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [CalculationStatus]
$creadListPrec :: ReadPrec [CalculationStatus]
readPrec :: ReadPrec CalculationStatus
$creadPrec :: ReadPrec CalculationStatus
readList :: ReadS [CalculationStatus]
$creadList :: ReadS [CalculationStatus]
readsPrec :: Int -> ReadS CalculationStatus
$creadsPrec :: Int -> ReadS CalculationStatus
Prelude.Read, Int -> CalculationStatus -> ShowS
[CalculationStatus] -> ShowS
CalculationStatus -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [CalculationStatus] -> ShowS
$cshowList :: [CalculationStatus] -> ShowS
show :: CalculationStatus -> String
$cshow :: CalculationStatus -> String
showsPrec :: Int -> CalculationStatus -> ShowS
$cshowsPrec :: Int -> CalculationStatus -> ShowS
Prelude.Show, forall x. Rep CalculationStatus x -> CalculationStatus
forall x. CalculationStatus -> Rep CalculationStatus x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep CalculationStatus x -> CalculationStatus
$cfrom :: forall x. CalculationStatus -> Rep CalculationStatus x
Prelude.Generic)

-- |
-- Create a value of 'CalculationStatus' 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:
--
-- 'completionDateTime', 'calculationStatus_completionDateTime' - The date and time the calculation completed processing.
--
-- 'state', 'calculationStatus_state' - The state of the calculation execution. A description of each state
-- follows.
--
-- @CREATING@ - The calculation is in the process of being created.
--
-- @CREATED@ - The calculation has been created and is ready to run.
--
-- @QUEUED@ - The calculation has been queued for processing.
--
-- @RUNNING@ - The calculation is running.
--
-- @CANCELING@ - A request to cancel the calculation has been received and
-- the system is working to stop it.
--
-- @CANCELED@ - The calculation is no longer running as the result of a
-- cancel request.
--
-- @COMPLETED@ - The calculation has completed without error.
--
-- @FAILED@ - The calculation failed and is no longer running.
--
-- 'stateChangeReason', 'calculationStatus_stateChangeReason' - The reason for the calculation state change (for example, the
-- calculation was canceled because the session was terminated).
--
-- 'submissionDateTime', 'calculationStatus_submissionDateTime' - The date and time the calculation was submitted for processing.
newCalculationStatus ::
  CalculationStatus
newCalculationStatus :: CalculationStatus
newCalculationStatus =
  CalculationStatus'
    { $sel:completionDateTime:CalculationStatus' :: Maybe POSIX
completionDateTime =
        forall a. Maybe a
Prelude.Nothing,
      $sel:state:CalculationStatus' :: Maybe CalculationExecutionState
state = forall a. Maybe a
Prelude.Nothing,
      $sel:stateChangeReason:CalculationStatus' :: Maybe Text
stateChangeReason = forall a. Maybe a
Prelude.Nothing,
      $sel:submissionDateTime:CalculationStatus' :: Maybe POSIX
submissionDateTime = forall a. Maybe a
Prelude.Nothing
    }

-- | The date and time the calculation completed processing.
calculationStatus_completionDateTime :: Lens.Lens' CalculationStatus (Prelude.Maybe Prelude.UTCTime)
calculationStatus_completionDateTime :: Lens' CalculationStatus (Maybe UTCTime)
calculationStatus_completionDateTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CalculationStatus' {Maybe POSIX
completionDateTime :: Maybe POSIX
$sel:completionDateTime:CalculationStatus' :: CalculationStatus -> Maybe POSIX
completionDateTime} -> Maybe POSIX
completionDateTime) (\s :: CalculationStatus
s@CalculationStatus' {} Maybe POSIX
a -> CalculationStatus
s {$sel:completionDateTime:CalculationStatus' :: Maybe POSIX
completionDateTime = Maybe POSIX
a} :: CalculationStatus) 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 state of the calculation execution. A description of each state
-- follows.
--
-- @CREATING@ - The calculation is in the process of being created.
--
-- @CREATED@ - The calculation has been created and is ready to run.
--
-- @QUEUED@ - The calculation has been queued for processing.
--
-- @RUNNING@ - The calculation is running.
--
-- @CANCELING@ - A request to cancel the calculation has been received and
-- the system is working to stop it.
--
-- @CANCELED@ - The calculation is no longer running as the result of a
-- cancel request.
--
-- @COMPLETED@ - The calculation has completed without error.
--
-- @FAILED@ - The calculation failed and is no longer running.
calculationStatus_state :: Lens.Lens' CalculationStatus (Prelude.Maybe CalculationExecutionState)
calculationStatus_state :: Lens' CalculationStatus (Maybe CalculationExecutionState)
calculationStatus_state = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CalculationStatus' {Maybe CalculationExecutionState
state :: Maybe CalculationExecutionState
$sel:state:CalculationStatus' :: CalculationStatus -> Maybe CalculationExecutionState
state} -> Maybe CalculationExecutionState
state) (\s :: CalculationStatus
s@CalculationStatus' {} Maybe CalculationExecutionState
a -> CalculationStatus
s {$sel:state:CalculationStatus' :: Maybe CalculationExecutionState
state = Maybe CalculationExecutionState
a} :: CalculationStatus)

-- | The reason for the calculation state change (for example, the
-- calculation was canceled because the session was terminated).
calculationStatus_stateChangeReason :: Lens.Lens' CalculationStatus (Prelude.Maybe Prelude.Text)
calculationStatus_stateChangeReason :: Lens' CalculationStatus (Maybe Text)
calculationStatus_stateChangeReason = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CalculationStatus' {Maybe Text
stateChangeReason :: Maybe Text
$sel:stateChangeReason:CalculationStatus' :: CalculationStatus -> Maybe Text
stateChangeReason} -> Maybe Text
stateChangeReason) (\s :: CalculationStatus
s@CalculationStatus' {} Maybe Text
a -> CalculationStatus
s {$sel:stateChangeReason:CalculationStatus' :: Maybe Text
stateChangeReason = Maybe Text
a} :: CalculationStatus)

-- | The date and time the calculation was submitted for processing.
calculationStatus_submissionDateTime :: Lens.Lens' CalculationStatus (Prelude.Maybe Prelude.UTCTime)
calculationStatus_submissionDateTime :: Lens' CalculationStatus (Maybe UTCTime)
calculationStatus_submissionDateTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\CalculationStatus' {Maybe POSIX
submissionDateTime :: Maybe POSIX
$sel:submissionDateTime:CalculationStatus' :: CalculationStatus -> Maybe POSIX
submissionDateTime} -> Maybe POSIX
submissionDateTime) (\s :: CalculationStatus
s@CalculationStatus' {} Maybe POSIX
a -> CalculationStatus
s {$sel:submissionDateTime:CalculationStatus' :: Maybe POSIX
submissionDateTime = Maybe POSIX
a} :: CalculationStatus) 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 CalculationStatus where
  parseJSON :: Value -> Parser CalculationStatus
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"CalculationStatus"
      ( \Object
x ->
          Maybe POSIX
-> Maybe CalculationExecutionState
-> Maybe Text
-> Maybe POSIX
-> CalculationStatus
CalculationStatus'
            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
"CompletionDateTime")
            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
"State")
            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
"StateChangeReason")
            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
"SubmissionDateTime")
      )

instance Prelude.Hashable CalculationStatus where
  hashWithSalt :: Int -> CalculationStatus -> Int
hashWithSalt Int
_salt CalculationStatus' {Maybe Text
Maybe POSIX
Maybe CalculationExecutionState
submissionDateTime :: Maybe POSIX
stateChangeReason :: Maybe Text
state :: Maybe CalculationExecutionState
completionDateTime :: Maybe POSIX
$sel:submissionDateTime:CalculationStatus' :: CalculationStatus -> Maybe POSIX
$sel:stateChangeReason:CalculationStatus' :: CalculationStatus -> Maybe Text
$sel:state:CalculationStatus' :: CalculationStatus -> Maybe CalculationExecutionState
$sel:completionDateTime:CalculationStatus' :: CalculationStatus -> Maybe POSIX
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
completionDateTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe CalculationExecutionState
state
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
stateChangeReason
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
submissionDateTime

instance Prelude.NFData CalculationStatus where
  rnf :: CalculationStatus -> ()
rnf CalculationStatus' {Maybe Text
Maybe POSIX
Maybe CalculationExecutionState
submissionDateTime :: Maybe POSIX
stateChangeReason :: Maybe Text
state :: Maybe CalculationExecutionState
completionDateTime :: Maybe POSIX
$sel:submissionDateTime:CalculationStatus' :: CalculationStatus -> Maybe POSIX
$sel:stateChangeReason:CalculationStatus' :: CalculationStatus -> Maybe Text
$sel:state:CalculationStatus' :: CalculationStatus -> Maybe CalculationExecutionState
$sel:completionDateTime:CalculationStatus' :: CalculationStatus -> Maybe POSIX
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
completionDateTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe CalculationExecutionState
state
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
stateChangeReason
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
submissionDateTime