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

import Amazonka.Athena.Types.DataCatalogType
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 a data catalog in an Amazon Web Services
-- account.
--
-- /See:/ 'newDataCatalog' smart constructor.
data DataCatalog = DataCatalog'
  { -- | An optional description of the data catalog.
    DataCatalog -> Maybe Text
description :: Prelude.Maybe Prelude.Text,
    -- | Specifies the Lambda function or functions to use for the data catalog.
    -- This is a mapping whose values depend on the catalog type.
    --
    -- -   For the @HIVE@ data catalog type, use the following syntax. The
    --     @metadata-function@ parameter is required. @The sdk-version@
    --     parameter is optional and defaults to the currently supported
    --     version.
    --
    --     @metadata-function=@/@lambda_arn@/@, sdk-version=@/@version_number@/@ @
    --
    -- -   For the @LAMBDA@ data catalog type, use one of the following sets of
    --     required parameters, but not both.
    --
    --     -   If you have one Lambda function that processes metadata and
    --         another for reading the actual data, use the following syntax.
    --         Both parameters are required.
    --
    --         @metadata-function=@/@lambda_arn@/@, record-function=@/@lambda_arn@/@ @
    --
    --     -   If you have a composite Lambda function that processes both
    --         metadata and data, use the following syntax to specify your
    --         Lambda function.
    --
    --         @function=@/@lambda_arn@/@ @
    --
    -- -   The @GLUE@ type takes a catalog ID parameter and is required. The
    --     @ @/@catalog_id@/@ @ is the account ID of the Amazon Web Services
    --     account to which the Glue catalog belongs.
    --
    --     @catalog-id=@/@catalog_id@/@ @
    --
    --     -   The @GLUE@ data catalog type also applies to the default
    --         @AwsDataCatalog@ that already exists in your account, of which
    --         you can have only one and cannot modify.
    --
    --     -   Queries that specify a Glue Data Catalog other than the default
    --         @AwsDataCatalog@ must be run on Athena engine version 2.
    DataCatalog -> Maybe (HashMap Text Text)
parameters :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text),
    -- | The name of the data catalog. The catalog name must be unique for the
    -- Amazon Web Services account and can use a maximum of 127 alphanumeric,
    -- underscore, at sign, or hyphen characters. The remainder of the length
    -- constraint of 256 is reserved for use by Athena.
    DataCatalog -> Text
name :: Prelude.Text,
    -- | The type of data catalog to create: @LAMBDA@ for a federated catalog,
    -- @HIVE@ for an external hive metastore, or @GLUE@ for an Glue Data
    -- Catalog.
    DataCatalog -> DataCatalogType
type' :: DataCatalogType
  }
  deriving (DataCatalog -> DataCatalog -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DataCatalog -> DataCatalog -> Bool
$c/= :: DataCatalog -> DataCatalog -> Bool
== :: DataCatalog -> DataCatalog -> Bool
$c== :: DataCatalog -> DataCatalog -> Bool
Prelude.Eq, ReadPrec [DataCatalog]
ReadPrec DataCatalog
Int -> ReadS DataCatalog
ReadS [DataCatalog]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DataCatalog]
$creadListPrec :: ReadPrec [DataCatalog]
readPrec :: ReadPrec DataCatalog
$creadPrec :: ReadPrec DataCatalog
readList :: ReadS [DataCatalog]
$creadList :: ReadS [DataCatalog]
readsPrec :: Int -> ReadS DataCatalog
$creadsPrec :: Int -> ReadS DataCatalog
Prelude.Read, Int -> DataCatalog -> ShowS
[DataCatalog] -> ShowS
DataCatalog -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DataCatalog] -> ShowS
$cshowList :: [DataCatalog] -> ShowS
show :: DataCatalog -> String
$cshow :: DataCatalog -> String
showsPrec :: Int -> DataCatalog -> ShowS
$cshowsPrec :: Int -> DataCatalog -> ShowS
Prelude.Show, forall x. Rep DataCatalog x -> DataCatalog
forall x. DataCatalog -> Rep DataCatalog x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DataCatalog x -> DataCatalog
$cfrom :: forall x. DataCatalog -> Rep DataCatalog x
Prelude.Generic)

-- |
-- Create a value of 'DataCatalog' 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', 'dataCatalog_description' - An optional description of the data catalog.
--
-- 'parameters', 'dataCatalog_parameters' - Specifies the Lambda function or functions to use for the data catalog.
-- This is a mapping whose values depend on the catalog type.
--
-- -   For the @HIVE@ data catalog type, use the following syntax. The
--     @metadata-function@ parameter is required. @The sdk-version@
--     parameter is optional and defaults to the currently supported
--     version.
--
--     @metadata-function=@/@lambda_arn@/@, sdk-version=@/@version_number@/@ @
--
-- -   For the @LAMBDA@ data catalog type, use one of the following sets of
--     required parameters, but not both.
--
--     -   If you have one Lambda function that processes metadata and
--         another for reading the actual data, use the following syntax.
--         Both parameters are required.
--
--         @metadata-function=@/@lambda_arn@/@, record-function=@/@lambda_arn@/@ @
--
--     -   If you have a composite Lambda function that processes both
--         metadata and data, use the following syntax to specify your
--         Lambda function.
--
--         @function=@/@lambda_arn@/@ @
--
-- -   The @GLUE@ type takes a catalog ID parameter and is required. The
--     @ @/@catalog_id@/@ @ is the account ID of the Amazon Web Services
--     account to which the Glue catalog belongs.
--
--     @catalog-id=@/@catalog_id@/@ @
--
--     -   The @GLUE@ data catalog type also applies to the default
--         @AwsDataCatalog@ that already exists in your account, of which
--         you can have only one and cannot modify.
--
--     -   Queries that specify a Glue Data Catalog other than the default
--         @AwsDataCatalog@ must be run on Athena engine version 2.
--
-- 'name', 'dataCatalog_name' - The name of the data catalog. The catalog name must be unique for the
-- Amazon Web Services account and can use a maximum of 127 alphanumeric,
-- underscore, at sign, or hyphen characters. The remainder of the length
-- constraint of 256 is reserved for use by Athena.
--
-- 'type'', 'dataCatalog_type' - The type of data catalog to create: @LAMBDA@ for a federated catalog,
-- @HIVE@ for an external hive metastore, or @GLUE@ for an Glue Data
-- Catalog.
newDataCatalog ::
  -- | 'name'
  Prelude.Text ->
  -- | 'type''
  DataCatalogType ->
  DataCatalog
newDataCatalog :: Text -> DataCatalogType -> DataCatalog
newDataCatalog Text
pName_ DataCatalogType
pType_ =
  DataCatalog'
    { $sel:description:DataCatalog' :: Maybe Text
description = forall a. Maybe a
Prelude.Nothing,
      $sel:parameters:DataCatalog' :: Maybe (HashMap Text Text)
parameters = forall a. Maybe a
Prelude.Nothing,
      $sel:name:DataCatalog' :: Text
name = Text
pName_,
      $sel:type':DataCatalog' :: DataCatalogType
type' = DataCatalogType
pType_
    }

-- | An optional description of the data catalog.
dataCatalog_description :: Lens.Lens' DataCatalog (Prelude.Maybe Prelude.Text)
dataCatalog_description :: Lens' DataCatalog (Maybe Text)
dataCatalog_description = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DataCatalog' {Maybe Text
description :: Maybe Text
$sel:description:DataCatalog' :: DataCatalog -> Maybe Text
description} -> Maybe Text
description) (\s :: DataCatalog
s@DataCatalog' {} Maybe Text
a -> DataCatalog
s {$sel:description:DataCatalog' :: Maybe Text
description = Maybe Text
a} :: DataCatalog)

-- | Specifies the Lambda function or functions to use for the data catalog.
-- This is a mapping whose values depend on the catalog type.
--
-- -   For the @HIVE@ data catalog type, use the following syntax. The
--     @metadata-function@ parameter is required. @The sdk-version@
--     parameter is optional and defaults to the currently supported
--     version.
--
--     @metadata-function=@/@lambda_arn@/@, sdk-version=@/@version_number@/@ @
--
-- -   For the @LAMBDA@ data catalog type, use one of the following sets of
--     required parameters, but not both.
--
--     -   If you have one Lambda function that processes metadata and
--         another for reading the actual data, use the following syntax.
--         Both parameters are required.
--
--         @metadata-function=@/@lambda_arn@/@, record-function=@/@lambda_arn@/@ @
--
--     -   If you have a composite Lambda function that processes both
--         metadata and data, use the following syntax to specify your
--         Lambda function.
--
--         @function=@/@lambda_arn@/@ @
--
-- -   The @GLUE@ type takes a catalog ID parameter and is required. The
--     @ @/@catalog_id@/@ @ is the account ID of the Amazon Web Services
--     account to which the Glue catalog belongs.
--
--     @catalog-id=@/@catalog_id@/@ @
--
--     -   The @GLUE@ data catalog type also applies to the default
--         @AwsDataCatalog@ that already exists in your account, of which
--         you can have only one and cannot modify.
--
--     -   Queries that specify a Glue Data Catalog other than the default
--         @AwsDataCatalog@ must be run on Athena engine version 2.
dataCatalog_parameters :: Lens.Lens' DataCatalog (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))
dataCatalog_parameters :: Lens' DataCatalog (Maybe (HashMap Text Text))
dataCatalog_parameters = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DataCatalog' {Maybe (HashMap Text Text)
parameters :: Maybe (HashMap Text Text)
$sel:parameters:DataCatalog' :: DataCatalog -> Maybe (HashMap Text Text)
parameters} -> Maybe (HashMap Text Text)
parameters) (\s :: DataCatalog
s@DataCatalog' {} Maybe (HashMap Text Text)
a -> DataCatalog
s {$sel:parameters:DataCatalog' :: Maybe (HashMap Text Text)
parameters = Maybe (HashMap Text Text)
a} :: DataCatalog) 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

-- | The name of the data catalog. The catalog name must be unique for the
-- Amazon Web Services account and can use a maximum of 127 alphanumeric,
-- underscore, at sign, or hyphen characters. The remainder of the length
-- constraint of 256 is reserved for use by Athena.
dataCatalog_name :: Lens.Lens' DataCatalog Prelude.Text
dataCatalog_name :: Lens' DataCatalog Text
dataCatalog_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DataCatalog' {Text
name :: Text
$sel:name:DataCatalog' :: DataCatalog -> Text
name} -> Text
name) (\s :: DataCatalog
s@DataCatalog' {} Text
a -> DataCatalog
s {$sel:name:DataCatalog' :: Text
name = Text
a} :: DataCatalog)

-- | The type of data catalog to create: @LAMBDA@ for a federated catalog,
-- @HIVE@ for an external hive metastore, or @GLUE@ for an Glue Data
-- Catalog.
dataCatalog_type :: Lens.Lens' DataCatalog DataCatalogType
dataCatalog_type :: Lens' DataCatalog DataCatalogType
dataCatalog_type = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DataCatalog' {DataCatalogType
type' :: DataCatalogType
$sel:type':DataCatalog' :: DataCatalog -> DataCatalogType
type'} -> DataCatalogType
type') (\s :: DataCatalog
s@DataCatalog' {} DataCatalogType
a -> DataCatalog
s {$sel:type':DataCatalog' :: DataCatalogType
type' = DataCatalogType
a} :: DataCatalog)

instance Data.FromJSON DataCatalog where
  parseJSON :: Value -> Parser DataCatalog
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"DataCatalog"
      ( \Object
x ->
          Maybe Text
-> Maybe (HashMap Text Text)
-> Text
-> DataCatalogType
-> DataCatalog
DataCatalog'
            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
"Parameters" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            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
"Type")
      )

instance Prelude.Hashable DataCatalog where
  hashWithSalt :: Int -> DataCatalog -> Int
hashWithSalt Int
_salt DataCatalog' {Maybe Text
Maybe (HashMap Text Text)
Text
DataCatalogType
type' :: DataCatalogType
name :: Text
parameters :: Maybe (HashMap Text Text)
description :: Maybe Text
$sel:type':DataCatalog' :: DataCatalog -> DataCatalogType
$sel:name:DataCatalog' :: DataCatalog -> Text
$sel:parameters:DataCatalog' :: DataCatalog -> Maybe (HashMap Text Text)
$sel:description:DataCatalog' :: DataCatalog -> 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 (HashMap Text Text)
parameters
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` DataCatalogType
type'

instance Prelude.NFData DataCatalog where
  rnf :: DataCatalog -> ()
rnf DataCatalog' {Maybe Text
Maybe (HashMap Text Text)
Text
DataCatalogType
type' :: DataCatalogType
name :: Text
parameters :: Maybe (HashMap Text Text)
description :: Maybe Text
$sel:type':DataCatalog' :: DataCatalog -> DataCatalogType
$sel:name:DataCatalog' :: DataCatalog -> Text
$sel:parameters:DataCatalog' :: DataCatalog -> Maybe (HashMap Text Text)
$sel:description:DataCatalog' :: DataCatalog -> 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 (HashMap Text Text)
parameters
      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 DataCatalogType
type'