{-# 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.QueryStage
-- 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.QueryStage where

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

-- | Stage statistics such as input and output rows and bytes, execution time
-- and stage state. This information also includes substages and the query
-- stage plan.
--
-- /See:/ 'newQueryStage' smart constructor.
data QueryStage = QueryStage'
  { -- | Time taken to execute this stage.
    QueryStage -> Maybe Integer
executionTime :: Prelude.Maybe Prelude.Integer,
    -- | The number of bytes input into the stage for execution.
    QueryStage -> Maybe Integer
inputBytes :: Prelude.Maybe Prelude.Integer,
    -- | The number of rows input into the stage for execution.
    QueryStage -> Maybe Integer
inputRows :: Prelude.Maybe Prelude.Integer,
    -- | The number of bytes output from the stage after execution.
    QueryStage -> Maybe Integer
outputBytes :: Prelude.Maybe Prelude.Integer,
    -- | The number of rows output from the stage after execution.
    QueryStage -> Maybe Integer
outputRows :: Prelude.Maybe Prelude.Integer,
    -- | Stage plan information such as name, identifier, sub plans, and source
    -- stages.
    QueryStage -> Maybe QueryStagePlanNode
queryStagePlan :: Prelude.Maybe QueryStagePlanNode,
    -- | The identifier for a stage.
    QueryStage -> Maybe Integer
stageId :: Prelude.Maybe Prelude.Integer,
    -- | State of the stage after query execution.
    QueryStage -> Maybe Text
state :: Prelude.Maybe Prelude.Text,
    -- | List of sub query stages that form this stage execution plan.
    QueryStage -> Maybe [QueryStage]
subStages :: Prelude.Maybe [QueryStage]
  }
  deriving (QueryStage -> QueryStage -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: QueryStage -> QueryStage -> Bool
$c/= :: QueryStage -> QueryStage -> Bool
== :: QueryStage -> QueryStage -> Bool
$c== :: QueryStage -> QueryStage -> Bool
Prelude.Eq, ReadPrec [QueryStage]
ReadPrec QueryStage
Int -> ReadS QueryStage
ReadS [QueryStage]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [QueryStage]
$creadListPrec :: ReadPrec [QueryStage]
readPrec :: ReadPrec QueryStage
$creadPrec :: ReadPrec QueryStage
readList :: ReadS [QueryStage]
$creadList :: ReadS [QueryStage]
readsPrec :: Int -> ReadS QueryStage
$creadsPrec :: Int -> ReadS QueryStage
Prelude.Read, Int -> QueryStage -> ShowS
[QueryStage] -> ShowS
QueryStage -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [QueryStage] -> ShowS
$cshowList :: [QueryStage] -> ShowS
show :: QueryStage -> String
$cshow :: QueryStage -> String
showsPrec :: Int -> QueryStage -> ShowS
$cshowsPrec :: Int -> QueryStage -> ShowS
Prelude.Show, forall x. Rep QueryStage x -> QueryStage
forall x. QueryStage -> Rep QueryStage x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep QueryStage x -> QueryStage
$cfrom :: forall x. QueryStage -> Rep QueryStage x
Prelude.Generic)

-- |
-- Create a value of 'QueryStage' 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:
--
-- 'executionTime', 'queryStage_executionTime' - Time taken to execute this stage.
--
-- 'inputBytes', 'queryStage_inputBytes' - The number of bytes input into the stage for execution.
--
-- 'inputRows', 'queryStage_inputRows' - The number of rows input into the stage for execution.
--
-- 'outputBytes', 'queryStage_outputBytes' - The number of bytes output from the stage after execution.
--
-- 'outputRows', 'queryStage_outputRows' - The number of rows output from the stage after execution.
--
-- 'queryStagePlan', 'queryStage_queryStagePlan' - Stage plan information such as name, identifier, sub plans, and source
-- stages.
--
-- 'stageId', 'queryStage_stageId' - The identifier for a stage.
--
-- 'state', 'queryStage_state' - State of the stage after query execution.
--
-- 'subStages', 'queryStage_subStages' - List of sub query stages that form this stage execution plan.
newQueryStage ::
  QueryStage
newQueryStage :: QueryStage
newQueryStage =
  QueryStage'
    { $sel:executionTime:QueryStage' :: Maybe Integer
executionTime = forall a. Maybe a
Prelude.Nothing,
      $sel:inputBytes:QueryStage' :: Maybe Integer
inputBytes = forall a. Maybe a
Prelude.Nothing,
      $sel:inputRows:QueryStage' :: Maybe Integer
inputRows = forall a. Maybe a
Prelude.Nothing,
      $sel:outputBytes:QueryStage' :: Maybe Integer
outputBytes = forall a. Maybe a
Prelude.Nothing,
      $sel:outputRows:QueryStage' :: Maybe Integer
outputRows = forall a. Maybe a
Prelude.Nothing,
      $sel:queryStagePlan:QueryStage' :: Maybe QueryStagePlanNode
queryStagePlan = forall a. Maybe a
Prelude.Nothing,
      $sel:stageId:QueryStage' :: Maybe Integer
stageId = forall a. Maybe a
Prelude.Nothing,
      $sel:state:QueryStage' :: Maybe Text
state = forall a. Maybe a
Prelude.Nothing,
      $sel:subStages:QueryStage' :: Maybe [QueryStage]
subStages = forall a. Maybe a
Prelude.Nothing
    }

-- | Time taken to execute this stage.
queryStage_executionTime :: Lens.Lens' QueryStage (Prelude.Maybe Prelude.Integer)
queryStage_executionTime :: Lens' QueryStage (Maybe Integer)
queryStage_executionTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryStage' {Maybe Integer
executionTime :: Maybe Integer
$sel:executionTime:QueryStage' :: QueryStage -> Maybe Integer
executionTime} -> Maybe Integer
executionTime) (\s :: QueryStage
s@QueryStage' {} Maybe Integer
a -> QueryStage
s {$sel:executionTime:QueryStage' :: Maybe Integer
executionTime = Maybe Integer
a} :: QueryStage)

-- | The number of bytes input into the stage for execution.
queryStage_inputBytes :: Lens.Lens' QueryStage (Prelude.Maybe Prelude.Integer)
queryStage_inputBytes :: Lens' QueryStage (Maybe Integer)
queryStage_inputBytes = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryStage' {Maybe Integer
inputBytes :: Maybe Integer
$sel:inputBytes:QueryStage' :: QueryStage -> Maybe Integer
inputBytes} -> Maybe Integer
inputBytes) (\s :: QueryStage
s@QueryStage' {} Maybe Integer
a -> QueryStage
s {$sel:inputBytes:QueryStage' :: Maybe Integer
inputBytes = Maybe Integer
a} :: QueryStage)

-- | The number of rows input into the stage for execution.
queryStage_inputRows :: Lens.Lens' QueryStage (Prelude.Maybe Prelude.Integer)
queryStage_inputRows :: Lens' QueryStage (Maybe Integer)
queryStage_inputRows = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryStage' {Maybe Integer
inputRows :: Maybe Integer
$sel:inputRows:QueryStage' :: QueryStage -> Maybe Integer
inputRows} -> Maybe Integer
inputRows) (\s :: QueryStage
s@QueryStage' {} Maybe Integer
a -> QueryStage
s {$sel:inputRows:QueryStage' :: Maybe Integer
inputRows = Maybe Integer
a} :: QueryStage)

-- | The number of bytes output from the stage after execution.
queryStage_outputBytes :: Lens.Lens' QueryStage (Prelude.Maybe Prelude.Integer)
queryStage_outputBytes :: Lens' QueryStage (Maybe Integer)
queryStage_outputBytes = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryStage' {Maybe Integer
outputBytes :: Maybe Integer
$sel:outputBytes:QueryStage' :: QueryStage -> Maybe Integer
outputBytes} -> Maybe Integer
outputBytes) (\s :: QueryStage
s@QueryStage' {} Maybe Integer
a -> QueryStage
s {$sel:outputBytes:QueryStage' :: Maybe Integer
outputBytes = Maybe Integer
a} :: QueryStage)

-- | The number of rows output from the stage after execution.
queryStage_outputRows :: Lens.Lens' QueryStage (Prelude.Maybe Prelude.Integer)
queryStage_outputRows :: Lens' QueryStage (Maybe Integer)
queryStage_outputRows = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryStage' {Maybe Integer
outputRows :: Maybe Integer
$sel:outputRows:QueryStage' :: QueryStage -> Maybe Integer
outputRows} -> Maybe Integer
outputRows) (\s :: QueryStage
s@QueryStage' {} Maybe Integer
a -> QueryStage
s {$sel:outputRows:QueryStage' :: Maybe Integer
outputRows = Maybe Integer
a} :: QueryStage)

-- | Stage plan information such as name, identifier, sub plans, and source
-- stages.
queryStage_queryStagePlan :: Lens.Lens' QueryStage (Prelude.Maybe QueryStagePlanNode)
queryStage_queryStagePlan :: Lens' QueryStage (Maybe QueryStagePlanNode)
queryStage_queryStagePlan = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryStage' {Maybe QueryStagePlanNode
queryStagePlan :: Maybe QueryStagePlanNode
$sel:queryStagePlan:QueryStage' :: QueryStage -> Maybe QueryStagePlanNode
queryStagePlan} -> Maybe QueryStagePlanNode
queryStagePlan) (\s :: QueryStage
s@QueryStage' {} Maybe QueryStagePlanNode
a -> QueryStage
s {$sel:queryStagePlan:QueryStage' :: Maybe QueryStagePlanNode
queryStagePlan = Maybe QueryStagePlanNode
a} :: QueryStage)

-- | The identifier for a stage.
queryStage_stageId :: Lens.Lens' QueryStage (Prelude.Maybe Prelude.Integer)
queryStage_stageId :: Lens' QueryStage (Maybe Integer)
queryStage_stageId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryStage' {Maybe Integer
stageId :: Maybe Integer
$sel:stageId:QueryStage' :: QueryStage -> Maybe Integer
stageId} -> Maybe Integer
stageId) (\s :: QueryStage
s@QueryStage' {} Maybe Integer
a -> QueryStage
s {$sel:stageId:QueryStage' :: Maybe Integer
stageId = Maybe Integer
a} :: QueryStage)

-- | State of the stage after query execution.
queryStage_state :: Lens.Lens' QueryStage (Prelude.Maybe Prelude.Text)
queryStage_state :: Lens' QueryStage (Maybe Text)
queryStage_state = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryStage' {Maybe Text
state :: Maybe Text
$sel:state:QueryStage' :: QueryStage -> Maybe Text
state} -> Maybe Text
state) (\s :: QueryStage
s@QueryStage' {} Maybe Text
a -> QueryStage
s {$sel:state:QueryStage' :: Maybe Text
state = Maybe Text
a} :: QueryStage)

-- | List of sub query stages that form this stage execution plan.
queryStage_subStages :: Lens.Lens' QueryStage (Prelude.Maybe [QueryStage])
queryStage_subStages :: Lens' QueryStage (Maybe [QueryStage])
queryStage_subStages = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryStage' {Maybe [QueryStage]
subStages :: Maybe [QueryStage]
$sel:subStages:QueryStage' :: QueryStage -> Maybe [QueryStage]
subStages} -> Maybe [QueryStage]
subStages) (\s :: QueryStage
s@QueryStage' {} Maybe [QueryStage]
a -> QueryStage
s {$sel:subStages:QueryStage' :: Maybe [QueryStage]
subStages = Maybe [QueryStage]
a} :: QueryStage) 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 QueryStage where
  parseJSON :: Value -> Parser QueryStage
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"QueryStage"
      ( \Object
x ->
          Maybe Integer
-> Maybe Integer
-> Maybe Integer
-> Maybe Integer
-> Maybe Integer
-> Maybe QueryStagePlanNode
-> Maybe Integer
-> Maybe Text
-> Maybe [QueryStage]
-> QueryStage
QueryStage'
            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
"ExecutionTime")
            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
"InputBytes")
            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
"InputRows")
            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
"OutputBytes")
            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
"OutputRows")
            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
"QueryStagePlan")
            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
"StageId")
            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
"SubStages" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
      )

instance Prelude.Hashable QueryStage where
  hashWithSalt :: Int -> QueryStage -> Int
hashWithSalt Int
_salt QueryStage' {Maybe Integer
Maybe [QueryStage]
Maybe Text
Maybe QueryStagePlanNode
subStages :: Maybe [QueryStage]
state :: Maybe Text
stageId :: Maybe Integer
queryStagePlan :: Maybe QueryStagePlanNode
outputRows :: Maybe Integer
outputBytes :: Maybe Integer
inputRows :: Maybe Integer
inputBytes :: Maybe Integer
executionTime :: Maybe Integer
$sel:subStages:QueryStage' :: QueryStage -> Maybe [QueryStage]
$sel:state:QueryStage' :: QueryStage -> Maybe Text
$sel:stageId:QueryStage' :: QueryStage -> Maybe Integer
$sel:queryStagePlan:QueryStage' :: QueryStage -> Maybe QueryStagePlanNode
$sel:outputRows:QueryStage' :: QueryStage -> Maybe Integer
$sel:outputBytes:QueryStage' :: QueryStage -> Maybe Integer
$sel:inputRows:QueryStage' :: QueryStage -> Maybe Integer
$sel:inputBytes:QueryStage' :: QueryStage -> Maybe Integer
$sel:executionTime:QueryStage' :: QueryStage -> Maybe Integer
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Integer
executionTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Integer
inputBytes
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Integer
inputRows
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Integer
outputBytes
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Integer
outputRows
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe QueryStagePlanNode
queryStagePlan
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Integer
stageId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
state
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [QueryStage]
subStages

instance Prelude.NFData QueryStage where
  rnf :: QueryStage -> ()
rnf QueryStage' {Maybe Integer
Maybe [QueryStage]
Maybe Text
Maybe QueryStagePlanNode
subStages :: Maybe [QueryStage]
state :: Maybe Text
stageId :: Maybe Integer
queryStagePlan :: Maybe QueryStagePlanNode
outputRows :: Maybe Integer
outputBytes :: Maybe Integer
inputRows :: Maybe Integer
inputBytes :: Maybe Integer
executionTime :: Maybe Integer
$sel:subStages:QueryStage' :: QueryStage -> Maybe [QueryStage]
$sel:state:QueryStage' :: QueryStage -> Maybe Text
$sel:stageId:QueryStage' :: QueryStage -> Maybe Integer
$sel:queryStagePlan:QueryStage' :: QueryStage -> Maybe QueryStagePlanNode
$sel:outputRows:QueryStage' :: QueryStage -> Maybe Integer
$sel:outputBytes:QueryStage' :: QueryStage -> Maybe Integer
$sel:inputRows:QueryStage' :: QueryStage -> Maybe Integer
$sel:inputBytes:QueryStage' :: QueryStage -> Maybe Integer
$sel:executionTime:QueryStage' :: QueryStage -> Maybe Integer
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Integer
executionTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Integer
inputBytes
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Integer
inputRows
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Integer
outputBytes
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Integer
outputRows
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe QueryStagePlanNode
queryStagePlan
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Integer
stageId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
state
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [QueryStage]
subStages