{-# 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.CloudTrail.Types.QueryStatisticsForDescribeQuery
-- 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.CloudTrail.Types.QueryStatisticsForDescribeQuery 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

-- | Gets metadata about a query, including the number of events that were
-- matched, the total number of events scanned, the query run time in
-- milliseconds, and the query\'s creation time.
--
-- /See:/ 'newQueryStatisticsForDescribeQuery' smart constructor.
data QueryStatisticsForDescribeQuery = QueryStatisticsForDescribeQuery'
  { -- | The total bytes that the query scanned in the event data store. This
    -- value matches the number of bytes for which your account is billed for
    -- the query, unless the query is still running.
    QueryStatisticsForDescribeQuery -> Maybe Integer
bytesScanned :: Prelude.Maybe Prelude.Integer,
    -- | The creation time of the query.
    QueryStatisticsForDescribeQuery -> Maybe POSIX
creationTime :: Prelude.Maybe Data.POSIX,
    -- | The number of events that matched a query.
    QueryStatisticsForDescribeQuery -> Maybe Integer
eventsMatched :: Prelude.Maybe Prelude.Integer,
    -- | The number of events that the query scanned in the event data store.
    QueryStatisticsForDescribeQuery -> Maybe Integer
eventsScanned :: Prelude.Maybe Prelude.Integer,
    -- | The query\'s run time, in milliseconds.
    QueryStatisticsForDescribeQuery -> Maybe Int
executionTimeInMillis :: Prelude.Maybe Prelude.Int
  }
  deriving (QueryStatisticsForDescribeQuery
-> QueryStatisticsForDescribeQuery -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: QueryStatisticsForDescribeQuery
-> QueryStatisticsForDescribeQuery -> Bool
$c/= :: QueryStatisticsForDescribeQuery
-> QueryStatisticsForDescribeQuery -> Bool
== :: QueryStatisticsForDescribeQuery
-> QueryStatisticsForDescribeQuery -> Bool
$c== :: QueryStatisticsForDescribeQuery
-> QueryStatisticsForDescribeQuery -> Bool
Prelude.Eq, ReadPrec [QueryStatisticsForDescribeQuery]
ReadPrec QueryStatisticsForDescribeQuery
Int -> ReadS QueryStatisticsForDescribeQuery
ReadS [QueryStatisticsForDescribeQuery]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [QueryStatisticsForDescribeQuery]
$creadListPrec :: ReadPrec [QueryStatisticsForDescribeQuery]
readPrec :: ReadPrec QueryStatisticsForDescribeQuery
$creadPrec :: ReadPrec QueryStatisticsForDescribeQuery
readList :: ReadS [QueryStatisticsForDescribeQuery]
$creadList :: ReadS [QueryStatisticsForDescribeQuery]
readsPrec :: Int -> ReadS QueryStatisticsForDescribeQuery
$creadsPrec :: Int -> ReadS QueryStatisticsForDescribeQuery
Prelude.Read, Int -> QueryStatisticsForDescribeQuery -> ShowS
[QueryStatisticsForDescribeQuery] -> ShowS
QueryStatisticsForDescribeQuery -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [QueryStatisticsForDescribeQuery] -> ShowS
$cshowList :: [QueryStatisticsForDescribeQuery] -> ShowS
show :: QueryStatisticsForDescribeQuery -> String
$cshow :: QueryStatisticsForDescribeQuery -> String
showsPrec :: Int -> QueryStatisticsForDescribeQuery -> ShowS
$cshowsPrec :: Int -> QueryStatisticsForDescribeQuery -> ShowS
Prelude.Show, forall x.
Rep QueryStatisticsForDescribeQuery x
-> QueryStatisticsForDescribeQuery
forall x.
QueryStatisticsForDescribeQuery
-> Rep QueryStatisticsForDescribeQuery x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep QueryStatisticsForDescribeQuery x
-> QueryStatisticsForDescribeQuery
$cfrom :: forall x.
QueryStatisticsForDescribeQuery
-> Rep QueryStatisticsForDescribeQuery x
Prelude.Generic)

-- |
-- Create a value of 'QueryStatisticsForDescribeQuery' 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:
--
-- 'bytesScanned', 'queryStatisticsForDescribeQuery_bytesScanned' - The total bytes that the query scanned in the event data store. This
-- value matches the number of bytes for which your account is billed for
-- the query, unless the query is still running.
--
-- 'creationTime', 'queryStatisticsForDescribeQuery_creationTime' - The creation time of the query.
--
-- 'eventsMatched', 'queryStatisticsForDescribeQuery_eventsMatched' - The number of events that matched a query.
--
-- 'eventsScanned', 'queryStatisticsForDescribeQuery_eventsScanned' - The number of events that the query scanned in the event data store.
--
-- 'executionTimeInMillis', 'queryStatisticsForDescribeQuery_executionTimeInMillis' - The query\'s run time, in milliseconds.
newQueryStatisticsForDescribeQuery ::
  QueryStatisticsForDescribeQuery
newQueryStatisticsForDescribeQuery :: QueryStatisticsForDescribeQuery
newQueryStatisticsForDescribeQuery =
  QueryStatisticsForDescribeQuery'
    { $sel:bytesScanned:QueryStatisticsForDescribeQuery' :: Maybe Integer
bytesScanned =
        forall a. Maybe a
Prelude.Nothing,
      $sel:creationTime:QueryStatisticsForDescribeQuery' :: Maybe POSIX
creationTime = forall a. Maybe a
Prelude.Nothing,
      $sel:eventsMatched:QueryStatisticsForDescribeQuery' :: Maybe Integer
eventsMatched = forall a. Maybe a
Prelude.Nothing,
      $sel:eventsScanned:QueryStatisticsForDescribeQuery' :: Maybe Integer
eventsScanned = forall a. Maybe a
Prelude.Nothing,
      $sel:executionTimeInMillis:QueryStatisticsForDescribeQuery' :: Maybe Int
executionTimeInMillis = forall a. Maybe a
Prelude.Nothing
    }

-- | The total bytes that the query scanned in the event data store. This
-- value matches the number of bytes for which your account is billed for
-- the query, unless the query is still running.
queryStatisticsForDescribeQuery_bytesScanned :: Lens.Lens' QueryStatisticsForDescribeQuery (Prelude.Maybe Prelude.Integer)
queryStatisticsForDescribeQuery_bytesScanned :: Lens' QueryStatisticsForDescribeQuery (Maybe Integer)
queryStatisticsForDescribeQuery_bytesScanned = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryStatisticsForDescribeQuery' {Maybe Integer
bytesScanned :: Maybe Integer
$sel:bytesScanned:QueryStatisticsForDescribeQuery' :: QueryStatisticsForDescribeQuery -> Maybe Integer
bytesScanned} -> Maybe Integer
bytesScanned) (\s :: QueryStatisticsForDescribeQuery
s@QueryStatisticsForDescribeQuery' {} Maybe Integer
a -> QueryStatisticsForDescribeQuery
s {$sel:bytesScanned:QueryStatisticsForDescribeQuery' :: Maybe Integer
bytesScanned = Maybe Integer
a} :: QueryStatisticsForDescribeQuery)

-- | The creation time of the query.
queryStatisticsForDescribeQuery_creationTime :: Lens.Lens' QueryStatisticsForDescribeQuery (Prelude.Maybe Prelude.UTCTime)
queryStatisticsForDescribeQuery_creationTime :: Lens' QueryStatisticsForDescribeQuery (Maybe UTCTime)
queryStatisticsForDescribeQuery_creationTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryStatisticsForDescribeQuery' {Maybe POSIX
creationTime :: Maybe POSIX
$sel:creationTime:QueryStatisticsForDescribeQuery' :: QueryStatisticsForDescribeQuery -> Maybe POSIX
creationTime} -> Maybe POSIX
creationTime) (\s :: QueryStatisticsForDescribeQuery
s@QueryStatisticsForDescribeQuery' {} Maybe POSIX
a -> QueryStatisticsForDescribeQuery
s {$sel:creationTime:QueryStatisticsForDescribeQuery' :: Maybe POSIX
creationTime = Maybe POSIX
a} :: QueryStatisticsForDescribeQuery) 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 number of events that matched a query.
queryStatisticsForDescribeQuery_eventsMatched :: Lens.Lens' QueryStatisticsForDescribeQuery (Prelude.Maybe Prelude.Integer)
queryStatisticsForDescribeQuery_eventsMatched :: Lens' QueryStatisticsForDescribeQuery (Maybe Integer)
queryStatisticsForDescribeQuery_eventsMatched = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryStatisticsForDescribeQuery' {Maybe Integer
eventsMatched :: Maybe Integer
$sel:eventsMatched:QueryStatisticsForDescribeQuery' :: QueryStatisticsForDescribeQuery -> Maybe Integer
eventsMatched} -> Maybe Integer
eventsMatched) (\s :: QueryStatisticsForDescribeQuery
s@QueryStatisticsForDescribeQuery' {} Maybe Integer
a -> QueryStatisticsForDescribeQuery
s {$sel:eventsMatched:QueryStatisticsForDescribeQuery' :: Maybe Integer
eventsMatched = Maybe Integer
a} :: QueryStatisticsForDescribeQuery)

-- | The number of events that the query scanned in the event data store.
queryStatisticsForDescribeQuery_eventsScanned :: Lens.Lens' QueryStatisticsForDescribeQuery (Prelude.Maybe Prelude.Integer)
queryStatisticsForDescribeQuery_eventsScanned :: Lens' QueryStatisticsForDescribeQuery (Maybe Integer)
queryStatisticsForDescribeQuery_eventsScanned = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryStatisticsForDescribeQuery' {Maybe Integer
eventsScanned :: Maybe Integer
$sel:eventsScanned:QueryStatisticsForDescribeQuery' :: QueryStatisticsForDescribeQuery -> Maybe Integer
eventsScanned} -> Maybe Integer
eventsScanned) (\s :: QueryStatisticsForDescribeQuery
s@QueryStatisticsForDescribeQuery' {} Maybe Integer
a -> QueryStatisticsForDescribeQuery
s {$sel:eventsScanned:QueryStatisticsForDescribeQuery' :: Maybe Integer
eventsScanned = Maybe Integer
a} :: QueryStatisticsForDescribeQuery)

-- | The query\'s run time, in milliseconds.
queryStatisticsForDescribeQuery_executionTimeInMillis :: Lens.Lens' QueryStatisticsForDescribeQuery (Prelude.Maybe Prelude.Int)
queryStatisticsForDescribeQuery_executionTimeInMillis :: Lens' QueryStatisticsForDescribeQuery (Maybe Int)
queryStatisticsForDescribeQuery_executionTimeInMillis = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\QueryStatisticsForDescribeQuery' {Maybe Int
executionTimeInMillis :: Maybe Int
$sel:executionTimeInMillis:QueryStatisticsForDescribeQuery' :: QueryStatisticsForDescribeQuery -> Maybe Int
executionTimeInMillis} -> Maybe Int
executionTimeInMillis) (\s :: QueryStatisticsForDescribeQuery
s@QueryStatisticsForDescribeQuery' {} Maybe Int
a -> QueryStatisticsForDescribeQuery
s {$sel:executionTimeInMillis:QueryStatisticsForDescribeQuery' :: Maybe Int
executionTimeInMillis = Maybe Int
a} :: QueryStatisticsForDescribeQuery)

instance
  Data.FromJSON
    QueryStatisticsForDescribeQuery
  where
  parseJSON :: Value -> Parser QueryStatisticsForDescribeQuery
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"QueryStatisticsForDescribeQuery"
      ( \Object
x ->
          Maybe Integer
-> Maybe POSIX
-> Maybe Integer
-> Maybe Integer
-> Maybe Int
-> QueryStatisticsForDescribeQuery
QueryStatisticsForDescribeQuery'
            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
"BytesScanned")
            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
"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
"EventsMatched")
            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
"EventsScanned")
            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
"ExecutionTimeInMillis")
      )

instance
  Prelude.Hashable
    QueryStatisticsForDescribeQuery
  where
  hashWithSalt :: Int -> QueryStatisticsForDescribeQuery -> Int
hashWithSalt
    Int
_salt
    QueryStatisticsForDescribeQuery' {Maybe Int
Maybe Integer
Maybe POSIX
executionTimeInMillis :: Maybe Int
eventsScanned :: Maybe Integer
eventsMatched :: Maybe Integer
creationTime :: Maybe POSIX
bytesScanned :: Maybe Integer
$sel:executionTimeInMillis:QueryStatisticsForDescribeQuery' :: QueryStatisticsForDescribeQuery -> Maybe Int
$sel:eventsScanned:QueryStatisticsForDescribeQuery' :: QueryStatisticsForDescribeQuery -> Maybe Integer
$sel:eventsMatched:QueryStatisticsForDescribeQuery' :: QueryStatisticsForDescribeQuery -> Maybe Integer
$sel:creationTime:QueryStatisticsForDescribeQuery' :: QueryStatisticsForDescribeQuery -> Maybe POSIX
$sel:bytesScanned:QueryStatisticsForDescribeQuery' :: QueryStatisticsForDescribeQuery -> Maybe Integer
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Integer
bytesScanned
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
creationTime
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Integer
eventsMatched
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Integer
eventsScanned
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
executionTimeInMillis

instance
  Prelude.NFData
    QueryStatisticsForDescribeQuery
  where
  rnf :: QueryStatisticsForDescribeQuery -> ()
rnf QueryStatisticsForDescribeQuery' {Maybe Int
Maybe Integer
Maybe POSIX
executionTimeInMillis :: Maybe Int
eventsScanned :: Maybe Integer
eventsMatched :: Maybe Integer
creationTime :: Maybe POSIX
bytesScanned :: Maybe Integer
$sel:executionTimeInMillis:QueryStatisticsForDescribeQuery' :: QueryStatisticsForDescribeQuery -> Maybe Int
$sel:eventsScanned:QueryStatisticsForDescribeQuery' :: QueryStatisticsForDescribeQuery -> Maybe Integer
$sel:eventsMatched:QueryStatisticsForDescribeQuery' :: QueryStatisticsForDescribeQuery -> Maybe Integer
$sel:creationTime:QueryStatisticsForDescribeQuery' :: QueryStatisticsForDescribeQuery -> Maybe POSIX
$sel:bytesScanned:QueryStatisticsForDescribeQuery' :: QueryStatisticsForDescribeQuery -> Maybe Integer
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Integer
bytesScanned
      seq :: forall a b. a -> b -> b
`Prelude.seq` 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 Integer
eventsMatched
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Integer
eventsScanned
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
executionTimeInMillis