{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.Glue.GetTableVersion
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Retrieves a specified version of a table.
module Amazonka.Glue.GetTableVersion
  ( -- * Creating a Request
    GetTableVersion (..),
    newGetTableVersion,

    -- * Request Lenses
    getTableVersion_catalogId,
    getTableVersion_versionId,
    getTableVersion_databaseName,
    getTableVersion_tableName,

    -- * Destructuring the Response
    GetTableVersionResponse (..),
    newGetTableVersionResponse,

    -- * Response Lenses
    getTableVersionResponse_tableVersion,
    getTableVersionResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Glue.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newGetTableVersion' smart constructor.
data GetTableVersion = GetTableVersion'
  { -- | The ID of the Data Catalog where the tables reside. If none is provided,
    -- the Amazon Web Services account ID is used by default.
    GetTableVersion -> Maybe Text
catalogId :: Prelude.Maybe Prelude.Text,
    -- | The ID value of the table version to be retrieved. A @VersionID@ is a
    -- string representation of an integer. Each version is incremented by 1.
    GetTableVersion -> Maybe Text
versionId :: Prelude.Maybe Prelude.Text,
    -- | The database in the catalog in which the table resides. For Hive
    -- compatibility, this name is entirely lowercase.
    GetTableVersion -> Text
databaseName :: Prelude.Text,
    -- | The name of the table. For Hive compatibility, this name is entirely
    -- lowercase.
    GetTableVersion -> Text
tableName :: Prelude.Text
  }
  deriving (GetTableVersion -> GetTableVersion -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetTableVersion -> GetTableVersion -> Bool
$c/= :: GetTableVersion -> GetTableVersion -> Bool
== :: GetTableVersion -> GetTableVersion -> Bool
$c== :: GetTableVersion -> GetTableVersion -> Bool
Prelude.Eq, ReadPrec [GetTableVersion]
ReadPrec GetTableVersion
Int -> ReadS GetTableVersion
ReadS [GetTableVersion]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetTableVersion]
$creadListPrec :: ReadPrec [GetTableVersion]
readPrec :: ReadPrec GetTableVersion
$creadPrec :: ReadPrec GetTableVersion
readList :: ReadS [GetTableVersion]
$creadList :: ReadS [GetTableVersion]
readsPrec :: Int -> ReadS GetTableVersion
$creadsPrec :: Int -> ReadS GetTableVersion
Prelude.Read, Int -> GetTableVersion -> ShowS
[GetTableVersion] -> ShowS
GetTableVersion -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetTableVersion] -> ShowS
$cshowList :: [GetTableVersion] -> ShowS
show :: GetTableVersion -> String
$cshow :: GetTableVersion -> String
showsPrec :: Int -> GetTableVersion -> ShowS
$cshowsPrec :: Int -> GetTableVersion -> ShowS
Prelude.Show, forall x. Rep GetTableVersion x -> GetTableVersion
forall x. GetTableVersion -> Rep GetTableVersion x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetTableVersion x -> GetTableVersion
$cfrom :: forall x. GetTableVersion -> Rep GetTableVersion x
Prelude.Generic)

-- |
-- Create a value of 'GetTableVersion' 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:
--
-- 'catalogId', 'getTableVersion_catalogId' - The ID of the Data Catalog where the tables reside. If none is provided,
-- the Amazon Web Services account ID is used by default.
--
-- 'versionId', 'getTableVersion_versionId' - The ID value of the table version to be retrieved. A @VersionID@ is a
-- string representation of an integer. Each version is incremented by 1.
--
-- 'databaseName', 'getTableVersion_databaseName' - The database in the catalog in which the table resides. For Hive
-- compatibility, this name is entirely lowercase.
--
-- 'tableName', 'getTableVersion_tableName' - The name of the table. For Hive compatibility, this name is entirely
-- lowercase.
newGetTableVersion ::
  -- | 'databaseName'
  Prelude.Text ->
  -- | 'tableName'
  Prelude.Text ->
  GetTableVersion
newGetTableVersion :: Text -> Text -> GetTableVersion
newGetTableVersion Text
pDatabaseName_ Text
pTableName_ =
  GetTableVersion'
    { $sel:catalogId:GetTableVersion' :: Maybe Text
catalogId = forall a. Maybe a
Prelude.Nothing,
      $sel:versionId:GetTableVersion' :: Maybe Text
versionId = forall a. Maybe a
Prelude.Nothing,
      $sel:databaseName:GetTableVersion' :: Text
databaseName = Text
pDatabaseName_,
      $sel:tableName:GetTableVersion' :: Text
tableName = Text
pTableName_
    }

-- | The ID of the Data Catalog where the tables reside. If none is provided,
-- the Amazon Web Services account ID is used by default.
getTableVersion_catalogId :: Lens.Lens' GetTableVersion (Prelude.Maybe Prelude.Text)
getTableVersion_catalogId :: Lens' GetTableVersion (Maybe Text)
getTableVersion_catalogId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetTableVersion' {Maybe Text
catalogId :: Maybe Text
$sel:catalogId:GetTableVersion' :: GetTableVersion -> Maybe Text
catalogId} -> Maybe Text
catalogId) (\s :: GetTableVersion
s@GetTableVersion' {} Maybe Text
a -> GetTableVersion
s {$sel:catalogId:GetTableVersion' :: Maybe Text
catalogId = Maybe Text
a} :: GetTableVersion)

-- | The ID value of the table version to be retrieved. A @VersionID@ is a
-- string representation of an integer. Each version is incremented by 1.
getTableVersion_versionId :: Lens.Lens' GetTableVersion (Prelude.Maybe Prelude.Text)
getTableVersion_versionId :: Lens' GetTableVersion (Maybe Text)
getTableVersion_versionId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetTableVersion' {Maybe Text
versionId :: Maybe Text
$sel:versionId:GetTableVersion' :: GetTableVersion -> Maybe Text
versionId} -> Maybe Text
versionId) (\s :: GetTableVersion
s@GetTableVersion' {} Maybe Text
a -> GetTableVersion
s {$sel:versionId:GetTableVersion' :: Maybe Text
versionId = Maybe Text
a} :: GetTableVersion)

-- | The database in the catalog in which the table resides. For Hive
-- compatibility, this name is entirely lowercase.
getTableVersion_databaseName :: Lens.Lens' GetTableVersion Prelude.Text
getTableVersion_databaseName :: Lens' GetTableVersion Text
getTableVersion_databaseName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetTableVersion' {Text
databaseName :: Text
$sel:databaseName:GetTableVersion' :: GetTableVersion -> Text
databaseName} -> Text
databaseName) (\s :: GetTableVersion
s@GetTableVersion' {} Text
a -> GetTableVersion
s {$sel:databaseName:GetTableVersion' :: Text
databaseName = Text
a} :: GetTableVersion)

-- | The name of the table. For Hive compatibility, this name is entirely
-- lowercase.
getTableVersion_tableName :: Lens.Lens' GetTableVersion Prelude.Text
getTableVersion_tableName :: Lens' GetTableVersion Text
getTableVersion_tableName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetTableVersion' {Text
tableName :: Text
$sel:tableName:GetTableVersion' :: GetTableVersion -> Text
tableName} -> Text
tableName) (\s :: GetTableVersion
s@GetTableVersion' {} Text
a -> GetTableVersion
s {$sel:tableName:GetTableVersion' :: Text
tableName = Text
a} :: GetTableVersion)

instance Core.AWSRequest GetTableVersion where
  type
    AWSResponse GetTableVersion =
      GetTableVersionResponse
  request :: (Service -> Service) -> GetTableVersion -> Request GetTableVersion
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy GetTableVersion
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse GetTableVersion)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe TableVersion -> Int -> GetTableVersionResponse
GetTableVersionResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"TableVersion")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable GetTableVersion where
  hashWithSalt :: Int -> GetTableVersion -> Int
hashWithSalt Int
_salt GetTableVersion' {Maybe Text
Text
tableName :: Text
databaseName :: Text
versionId :: Maybe Text
catalogId :: Maybe Text
$sel:tableName:GetTableVersion' :: GetTableVersion -> Text
$sel:databaseName:GetTableVersion' :: GetTableVersion -> Text
$sel:versionId:GetTableVersion' :: GetTableVersion -> Maybe Text
$sel:catalogId:GetTableVersion' :: GetTableVersion -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
catalogId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
versionId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
databaseName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
tableName

instance Prelude.NFData GetTableVersion where
  rnf :: GetTableVersion -> ()
rnf GetTableVersion' {Maybe Text
Text
tableName :: Text
databaseName :: Text
versionId :: Maybe Text
catalogId :: Maybe Text
$sel:tableName:GetTableVersion' :: GetTableVersion -> Text
$sel:databaseName:GetTableVersion' :: GetTableVersion -> Text
$sel:versionId:GetTableVersion' :: GetTableVersion -> Maybe Text
$sel:catalogId:GetTableVersion' :: GetTableVersion -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
catalogId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
versionId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
databaseName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
tableName

instance Data.ToHeaders GetTableVersion where
  toHeaders :: GetTableVersion -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# (ByteString
"AWSGlue.GetTableVersion" :: Prelude.ByteString),
            HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON GetTableVersion where
  toJSON :: GetTableVersion -> Value
toJSON GetTableVersion' {Maybe Text
Text
tableName :: Text
databaseName :: Text
versionId :: Maybe Text
catalogId :: Maybe Text
$sel:tableName:GetTableVersion' :: GetTableVersion -> Text
$sel:databaseName:GetTableVersion' :: GetTableVersion -> Text
$sel:versionId:GetTableVersion' :: GetTableVersion -> Maybe Text
$sel:catalogId:GetTableVersion' :: GetTableVersion -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"CatalogId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
catalogId,
            (Key
"VersionId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
versionId,
            forall a. a -> Maybe a
Prelude.Just (Key
"DatabaseName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
databaseName),
            forall a. a -> Maybe a
Prelude.Just (Key
"TableName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
tableName)
          ]
      )

instance Data.ToPath GetTableVersion where
  toPath :: GetTableVersion -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Data.ToQuery GetTableVersion where
  toQuery :: GetTableVersion -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newGetTableVersionResponse' smart constructor.
data GetTableVersionResponse = GetTableVersionResponse'
  { -- | The requested table version.
    GetTableVersionResponse -> Maybe TableVersion
tableVersion :: Prelude.Maybe TableVersion,
    -- | The response's http status code.
    GetTableVersionResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (GetTableVersionResponse -> GetTableVersionResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: GetTableVersionResponse -> GetTableVersionResponse -> Bool
$c/= :: GetTableVersionResponse -> GetTableVersionResponse -> Bool
== :: GetTableVersionResponse -> GetTableVersionResponse -> Bool
$c== :: GetTableVersionResponse -> GetTableVersionResponse -> Bool
Prelude.Eq, ReadPrec [GetTableVersionResponse]
ReadPrec GetTableVersionResponse
Int -> ReadS GetTableVersionResponse
ReadS [GetTableVersionResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [GetTableVersionResponse]
$creadListPrec :: ReadPrec [GetTableVersionResponse]
readPrec :: ReadPrec GetTableVersionResponse
$creadPrec :: ReadPrec GetTableVersionResponse
readList :: ReadS [GetTableVersionResponse]
$creadList :: ReadS [GetTableVersionResponse]
readsPrec :: Int -> ReadS GetTableVersionResponse
$creadsPrec :: Int -> ReadS GetTableVersionResponse
Prelude.Read, Int -> GetTableVersionResponse -> ShowS
[GetTableVersionResponse] -> ShowS
GetTableVersionResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [GetTableVersionResponse] -> ShowS
$cshowList :: [GetTableVersionResponse] -> ShowS
show :: GetTableVersionResponse -> String
$cshow :: GetTableVersionResponse -> String
showsPrec :: Int -> GetTableVersionResponse -> ShowS
$cshowsPrec :: Int -> GetTableVersionResponse -> ShowS
Prelude.Show, forall x. Rep GetTableVersionResponse x -> GetTableVersionResponse
forall x. GetTableVersionResponse -> Rep GetTableVersionResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep GetTableVersionResponse x -> GetTableVersionResponse
$cfrom :: forall x. GetTableVersionResponse -> Rep GetTableVersionResponse x
Prelude.Generic)

-- |
-- Create a value of 'GetTableVersionResponse' 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:
--
-- 'tableVersion', 'getTableVersionResponse_tableVersion' - The requested table version.
--
-- 'httpStatus', 'getTableVersionResponse_httpStatus' - The response's http status code.
newGetTableVersionResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  GetTableVersionResponse
newGetTableVersionResponse :: Int -> GetTableVersionResponse
newGetTableVersionResponse Int
pHttpStatus_ =
  GetTableVersionResponse'
    { $sel:tableVersion:GetTableVersionResponse' :: Maybe TableVersion
tableVersion =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:GetTableVersionResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The requested table version.
getTableVersionResponse_tableVersion :: Lens.Lens' GetTableVersionResponse (Prelude.Maybe TableVersion)
getTableVersionResponse_tableVersion :: Lens' GetTableVersionResponse (Maybe TableVersion)
getTableVersionResponse_tableVersion = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetTableVersionResponse' {Maybe TableVersion
tableVersion :: Maybe TableVersion
$sel:tableVersion:GetTableVersionResponse' :: GetTableVersionResponse -> Maybe TableVersion
tableVersion} -> Maybe TableVersion
tableVersion) (\s :: GetTableVersionResponse
s@GetTableVersionResponse' {} Maybe TableVersion
a -> GetTableVersionResponse
s {$sel:tableVersion:GetTableVersionResponse' :: Maybe TableVersion
tableVersion = Maybe TableVersion
a} :: GetTableVersionResponse)

-- | The response's http status code.
getTableVersionResponse_httpStatus :: Lens.Lens' GetTableVersionResponse Prelude.Int
getTableVersionResponse_httpStatus :: Lens' GetTableVersionResponse Int
getTableVersionResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\GetTableVersionResponse' {Int
httpStatus :: Int
$sel:httpStatus:GetTableVersionResponse' :: GetTableVersionResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: GetTableVersionResponse
s@GetTableVersionResponse' {} Int
a -> GetTableVersionResponse
s {$sel:httpStatus:GetTableVersionResponse' :: Int
httpStatus = Int
a} :: GetTableVersionResponse)

instance Prelude.NFData GetTableVersionResponse where
  rnf :: GetTableVersionResponse -> ()
rnf GetTableVersionResponse' {Int
Maybe TableVersion
httpStatus :: Int
tableVersion :: Maybe TableVersion
$sel:httpStatus:GetTableVersionResponse' :: GetTableVersionResponse -> Int
$sel:tableVersion:GetTableVersionResponse' :: GetTableVersionResponse -> Maybe TableVersion
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe TableVersion
tableVersion
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus