{-# 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.NamedQuery
-- 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.NamedQuery 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

-- | A query, where @QueryString@ contains the SQL statements that make up
-- the query.
--
-- /See:/ 'newNamedQuery' smart constructor.
data NamedQuery = NamedQuery'
  { -- | The query description.
    NamedQuery -> Maybe Text
description :: Prelude.Maybe Prelude.Text,
    -- | The unique identifier of the query.
    NamedQuery -> Maybe Text
namedQueryId :: Prelude.Maybe Prelude.Text,
    -- | The name of the workgroup that contains the named query.
    NamedQuery -> Maybe Text
workGroup :: Prelude.Maybe Prelude.Text,
    -- | The query name.
    NamedQuery -> Text
name :: Prelude.Text,
    -- | The database to which the query belongs.
    NamedQuery -> Text
database :: Prelude.Text,
    -- | The SQL statements that make up the query.
    NamedQuery -> Text
queryString :: Prelude.Text
  }
  deriving (NamedQuery -> NamedQuery -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: NamedQuery -> NamedQuery -> Bool
$c/= :: NamedQuery -> NamedQuery -> Bool
== :: NamedQuery -> NamedQuery -> Bool
$c== :: NamedQuery -> NamedQuery -> Bool
Prelude.Eq, ReadPrec [NamedQuery]
ReadPrec NamedQuery
Int -> ReadS NamedQuery
ReadS [NamedQuery]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [NamedQuery]
$creadListPrec :: ReadPrec [NamedQuery]
readPrec :: ReadPrec NamedQuery
$creadPrec :: ReadPrec NamedQuery
readList :: ReadS [NamedQuery]
$creadList :: ReadS [NamedQuery]
readsPrec :: Int -> ReadS NamedQuery
$creadsPrec :: Int -> ReadS NamedQuery
Prelude.Read, Int -> NamedQuery -> ShowS
[NamedQuery] -> ShowS
NamedQuery -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [NamedQuery] -> ShowS
$cshowList :: [NamedQuery] -> ShowS
show :: NamedQuery -> String
$cshow :: NamedQuery -> String
showsPrec :: Int -> NamedQuery -> ShowS
$cshowsPrec :: Int -> NamedQuery -> ShowS
Prelude.Show, forall x. Rep NamedQuery x -> NamedQuery
forall x. NamedQuery -> Rep NamedQuery x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep NamedQuery x -> NamedQuery
$cfrom :: forall x. NamedQuery -> Rep NamedQuery x
Prelude.Generic)

-- |
-- Create a value of 'NamedQuery' 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:
--
-- 'description', 'namedQuery_description' - The query description.
--
-- 'namedQueryId', 'namedQuery_namedQueryId' - The unique identifier of the query.
--
-- 'workGroup', 'namedQuery_workGroup' - The name of the workgroup that contains the named query.
--
-- 'name', 'namedQuery_name' - The query name.
--
-- 'database', 'namedQuery_database' - The database to which the query belongs.
--
-- 'queryString', 'namedQuery_queryString' - The SQL statements that make up the query.
newNamedQuery ::
  -- | 'name'
  Prelude.Text ->
  -- | 'database'
  Prelude.Text ->
  -- | 'queryString'
  Prelude.Text ->
  NamedQuery
newNamedQuery :: Text -> Text -> Text -> NamedQuery
newNamedQuery Text
pName_ Text
pDatabase_ Text
pQueryString_ =
  NamedQuery'
    { $sel:description:NamedQuery' :: Maybe Text
description = forall a. Maybe a
Prelude.Nothing,
      $sel:namedQueryId:NamedQuery' :: Maybe Text
namedQueryId = forall a. Maybe a
Prelude.Nothing,
      $sel:workGroup:NamedQuery' :: Maybe Text
workGroup = forall a. Maybe a
Prelude.Nothing,
      $sel:name:NamedQuery' :: Text
name = Text
pName_,
      $sel:database:NamedQuery' :: Text
database = Text
pDatabase_,
      $sel:queryString:NamedQuery' :: Text
queryString = Text
pQueryString_
    }

-- | The query description.
namedQuery_description :: Lens.Lens' NamedQuery (Prelude.Maybe Prelude.Text)
namedQuery_description :: Lens' NamedQuery (Maybe Text)
namedQuery_description = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\NamedQuery' {Maybe Text
description :: Maybe Text
$sel:description:NamedQuery' :: NamedQuery -> Maybe Text
description} -> Maybe Text
description) (\s :: NamedQuery
s@NamedQuery' {} Maybe Text
a -> NamedQuery
s {$sel:description:NamedQuery' :: Maybe Text
description = Maybe Text
a} :: NamedQuery)

-- | The unique identifier of the query.
namedQuery_namedQueryId :: Lens.Lens' NamedQuery (Prelude.Maybe Prelude.Text)
namedQuery_namedQueryId :: Lens' NamedQuery (Maybe Text)
namedQuery_namedQueryId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\NamedQuery' {Maybe Text
namedQueryId :: Maybe Text
$sel:namedQueryId:NamedQuery' :: NamedQuery -> Maybe Text
namedQueryId} -> Maybe Text
namedQueryId) (\s :: NamedQuery
s@NamedQuery' {} Maybe Text
a -> NamedQuery
s {$sel:namedQueryId:NamedQuery' :: Maybe Text
namedQueryId = Maybe Text
a} :: NamedQuery)

-- | The name of the workgroup that contains the named query.
namedQuery_workGroup :: Lens.Lens' NamedQuery (Prelude.Maybe Prelude.Text)
namedQuery_workGroup :: Lens' NamedQuery (Maybe Text)
namedQuery_workGroup = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\NamedQuery' {Maybe Text
workGroup :: Maybe Text
$sel:workGroup:NamedQuery' :: NamedQuery -> Maybe Text
workGroup} -> Maybe Text
workGroup) (\s :: NamedQuery
s@NamedQuery' {} Maybe Text
a -> NamedQuery
s {$sel:workGroup:NamedQuery' :: Maybe Text
workGroup = Maybe Text
a} :: NamedQuery)

-- | The query name.
namedQuery_name :: Lens.Lens' NamedQuery Prelude.Text
namedQuery_name :: Lens' NamedQuery Text
namedQuery_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\NamedQuery' {Text
name :: Text
$sel:name:NamedQuery' :: NamedQuery -> Text
name} -> Text
name) (\s :: NamedQuery
s@NamedQuery' {} Text
a -> NamedQuery
s {$sel:name:NamedQuery' :: Text
name = Text
a} :: NamedQuery)

-- | The database to which the query belongs.
namedQuery_database :: Lens.Lens' NamedQuery Prelude.Text
namedQuery_database :: Lens' NamedQuery Text
namedQuery_database = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\NamedQuery' {Text
database :: Text
$sel:database:NamedQuery' :: NamedQuery -> Text
database} -> Text
database) (\s :: NamedQuery
s@NamedQuery' {} Text
a -> NamedQuery
s {$sel:database:NamedQuery' :: Text
database = Text
a} :: NamedQuery)

-- | The SQL statements that make up the query.
namedQuery_queryString :: Lens.Lens' NamedQuery Prelude.Text
namedQuery_queryString :: Lens' NamedQuery Text
namedQuery_queryString = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\NamedQuery' {Text
queryString :: Text
$sel:queryString:NamedQuery' :: NamedQuery -> Text
queryString} -> Text
queryString) (\s :: NamedQuery
s@NamedQuery' {} Text
a -> NamedQuery
s {$sel:queryString:NamedQuery' :: Text
queryString = Text
a} :: NamedQuery)

instance Data.FromJSON NamedQuery where
  parseJSON :: Value -> Parser NamedQuery
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"NamedQuery"
      ( \Object
x ->
          Maybe Text
-> Maybe Text -> Maybe Text -> Text -> Text -> Text -> NamedQuery
NamedQuery'
            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
"Description")
            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
"NamedQueryId")
            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
"WorkGroup")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser 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 a
Data..: Key
"Database")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"QueryString")
      )

instance Prelude.Hashable NamedQuery where
  hashWithSalt :: Int -> NamedQuery -> Int
hashWithSalt Int
_salt NamedQuery' {Maybe Text
Text
queryString :: Text
database :: Text
name :: Text
workGroup :: Maybe Text
namedQueryId :: Maybe Text
description :: Maybe Text
$sel:queryString:NamedQuery' :: NamedQuery -> Text
$sel:database:NamedQuery' :: NamedQuery -> Text
$sel:name:NamedQuery' :: NamedQuery -> Text
$sel:workGroup:NamedQuery' :: NamedQuery -> Maybe Text
$sel:namedQueryId:NamedQuery' :: NamedQuery -> Maybe Text
$sel:description:NamedQuery' :: NamedQuery -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
description
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
namedQueryId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
workGroup
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
database
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
queryString

instance Prelude.NFData NamedQuery where
  rnf :: NamedQuery -> ()
rnf NamedQuery' {Maybe Text
Text
queryString :: Text
database :: Text
name :: Text
workGroup :: Maybe Text
namedQueryId :: Maybe Text
description :: Maybe Text
$sel:queryString:NamedQuery' :: NamedQuery -> Text
$sel:database:NamedQuery' :: NamedQuery -> Text
$sel:name:NamedQuery' :: NamedQuery -> Text
$sel:workGroup:NamedQuery' :: NamedQuery -> Maybe Text
$sel:namedQueryId:NamedQuery' :: NamedQuery -> Maybe Text
$sel:description:NamedQuery' :: NamedQuery -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
description
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
namedQueryId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
workGroup
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
name
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
database
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
queryString