{-# 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.FinSpaceData.Types.ColumnDefinition
-- 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.FinSpaceData.Types.ColumnDefinition where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.FinSpaceData.Types.ColumnDataType
import qualified Amazonka.Prelude as Prelude

-- | The definition of a column in a tabular Dataset.
--
-- /See:/ 'newColumnDefinition' smart constructor.
data ColumnDefinition = ColumnDefinition'
  { -- | Description for a column.
    ColumnDefinition -> Maybe Text
columnDescription :: Prelude.Maybe Prelude.Text,
    -- | The name of a column.
    ColumnDefinition -> Maybe Text
columnName :: Prelude.Maybe Prelude.Text,
    -- | Data type of a column.
    --
    -- -   @STRING@ – A String data type.
    --
    --     @CHAR@ – A char data type.
    --
    --     @INTEGER@ – An integer data type.
    --
    --     @TINYINT@ – A tinyint data type.
    --
    --     @SMALLINT@ – A smallint data type.
    --
    --     @BIGINT@ – A bigint data type.
    --
    --     @FLOAT@ – A float data type.
    --
    --     @DOUBLE@ – A double data type.
    --
    --     @DATE@ – A date data type.
    --
    --     @DATETIME@ – A datetime data type.
    --
    --     @BOOLEAN@ – A boolean data type.
    --
    --     @BINARY@ – A binary data type.
    ColumnDefinition -> Maybe ColumnDataType
dataType :: Prelude.Maybe ColumnDataType
  }
  deriving (ColumnDefinition -> ColumnDefinition -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ColumnDefinition -> ColumnDefinition -> Bool
$c/= :: ColumnDefinition -> ColumnDefinition -> Bool
== :: ColumnDefinition -> ColumnDefinition -> Bool
$c== :: ColumnDefinition -> ColumnDefinition -> Bool
Prelude.Eq, ReadPrec [ColumnDefinition]
ReadPrec ColumnDefinition
Int -> ReadS ColumnDefinition
ReadS [ColumnDefinition]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ColumnDefinition]
$creadListPrec :: ReadPrec [ColumnDefinition]
readPrec :: ReadPrec ColumnDefinition
$creadPrec :: ReadPrec ColumnDefinition
readList :: ReadS [ColumnDefinition]
$creadList :: ReadS [ColumnDefinition]
readsPrec :: Int -> ReadS ColumnDefinition
$creadsPrec :: Int -> ReadS ColumnDefinition
Prelude.Read, Int -> ColumnDefinition -> ShowS
[ColumnDefinition] -> ShowS
ColumnDefinition -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ColumnDefinition] -> ShowS
$cshowList :: [ColumnDefinition] -> ShowS
show :: ColumnDefinition -> String
$cshow :: ColumnDefinition -> String
showsPrec :: Int -> ColumnDefinition -> ShowS
$cshowsPrec :: Int -> ColumnDefinition -> ShowS
Prelude.Show, forall x. Rep ColumnDefinition x -> ColumnDefinition
forall x. ColumnDefinition -> Rep ColumnDefinition x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ColumnDefinition x -> ColumnDefinition
$cfrom :: forall x. ColumnDefinition -> Rep ColumnDefinition x
Prelude.Generic)

-- |
-- Create a value of 'ColumnDefinition' 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:
--
-- 'columnDescription', 'columnDefinition_columnDescription' - Description for a column.
--
-- 'columnName', 'columnDefinition_columnName' - The name of a column.
--
-- 'dataType', 'columnDefinition_dataType' - Data type of a column.
--
-- -   @STRING@ – A String data type.
--
--     @CHAR@ – A char data type.
--
--     @INTEGER@ – An integer data type.
--
--     @TINYINT@ – A tinyint data type.
--
--     @SMALLINT@ – A smallint data type.
--
--     @BIGINT@ – A bigint data type.
--
--     @FLOAT@ – A float data type.
--
--     @DOUBLE@ – A double data type.
--
--     @DATE@ – A date data type.
--
--     @DATETIME@ – A datetime data type.
--
--     @BOOLEAN@ – A boolean data type.
--
--     @BINARY@ – A binary data type.
newColumnDefinition ::
  ColumnDefinition
newColumnDefinition :: ColumnDefinition
newColumnDefinition =
  ColumnDefinition'
    { $sel:columnDescription:ColumnDefinition' :: Maybe Text
columnDescription =
        forall a. Maybe a
Prelude.Nothing,
      $sel:columnName:ColumnDefinition' :: Maybe Text
columnName = forall a. Maybe a
Prelude.Nothing,
      $sel:dataType:ColumnDefinition' :: Maybe ColumnDataType
dataType = forall a. Maybe a
Prelude.Nothing
    }

-- | Description for a column.
columnDefinition_columnDescription :: Lens.Lens' ColumnDefinition (Prelude.Maybe Prelude.Text)
columnDefinition_columnDescription :: Lens' ColumnDefinition (Maybe Text)
columnDefinition_columnDescription = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ColumnDefinition' {Maybe Text
columnDescription :: Maybe Text
$sel:columnDescription:ColumnDefinition' :: ColumnDefinition -> Maybe Text
columnDescription} -> Maybe Text
columnDescription) (\s :: ColumnDefinition
s@ColumnDefinition' {} Maybe Text
a -> ColumnDefinition
s {$sel:columnDescription:ColumnDefinition' :: Maybe Text
columnDescription = Maybe Text
a} :: ColumnDefinition)

-- | The name of a column.
columnDefinition_columnName :: Lens.Lens' ColumnDefinition (Prelude.Maybe Prelude.Text)
columnDefinition_columnName :: Lens' ColumnDefinition (Maybe Text)
columnDefinition_columnName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ColumnDefinition' {Maybe Text
columnName :: Maybe Text
$sel:columnName:ColumnDefinition' :: ColumnDefinition -> Maybe Text
columnName} -> Maybe Text
columnName) (\s :: ColumnDefinition
s@ColumnDefinition' {} Maybe Text
a -> ColumnDefinition
s {$sel:columnName:ColumnDefinition' :: Maybe Text
columnName = Maybe Text
a} :: ColumnDefinition)

-- | Data type of a column.
--
-- -   @STRING@ – A String data type.
--
--     @CHAR@ – A char data type.
--
--     @INTEGER@ – An integer data type.
--
--     @TINYINT@ – A tinyint data type.
--
--     @SMALLINT@ – A smallint data type.
--
--     @BIGINT@ – A bigint data type.
--
--     @FLOAT@ – A float data type.
--
--     @DOUBLE@ – A double data type.
--
--     @DATE@ – A date data type.
--
--     @DATETIME@ – A datetime data type.
--
--     @BOOLEAN@ – A boolean data type.
--
--     @BINARY@ – A binary data type.
columnDefinition_dataType :: Lens.Lens' ColumnDefinition (Prelude.Maybe ColumnDataType)
columnDefinition_dataType :: Lens' ColumnDefinition (Maybe ColumnDataType)
columnDefinition_dataType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ColumnDefinition' {Maybe ColumnDataType
dataType :: Maybe ColumnDataType
$sel:dataType:ColumnDefinition' :: ColumnDefinition -> Maybe ColumnDataType
dataType} -> Maybe ColumnDataType
dataType) (\s :: ColumnDefinition
s@ColumnDefinition' {} Maybe ColumnDataType
a -> ColumnDefinition
s {$sel:dataType:ColumnDefinition' :: Maybe ColumnDataType
dataType = Maybe ColumnDataType
a} :: ColumnDefinition)

instance Data.FromJSON ColumnDefinition where
  parseJSON :: Value -> Parser ColumnDefinition
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ColumnDefinition"
      ( \Object
x ->
          Maybe Text
-> Maybe Text -> Maybe ColumnDataType -> ColumnDefinition
ColumnDefinition'
            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
"columnDescription")
            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
"columnName")
            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
"dataType")
      )

instance Prelude.Hashable ColumnDefinition where
  hashWithSalt :: Int -> ColumnDefinition -> Int
hashWithSalt Int
_salt ColumnDefinition' {Maybe Text
Maybe ColumnDataType
dataType :: Maybe ColumnDataType
columnName :: Maybe Text
columnDescription :: Maybe Text
$sel:dataType:ColumnDefinition' :: ColumnDefinition -> Maybe ColumnDataType
$sel:columnName:ColumnDefinition' :: ColumnDefinition -> Maybe Text
$sel:columnDescription:ColumnDefinition' :: ColumnDefinition -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
columnDescription
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
columnName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ColumnDataType
dataType

instance Prelude.NFData ColumnDefinition where
  rnf :: ColumnDefinition -> ()
rnf ColumnDefinition' {Maybe Text
Maybe ColumnDataType
dataType :: Maybe ColumnDataType
columnName :: Maybe Text
columnDescription :: Maybe Text
$sel:dataType:ColumnDefinition' :: ColumnDefinition -> Maybe ColumnDataType
$sel:columnName:ColumnDefinition' :: ColumnDefinition -> Maybe Text
$sel:columnDescription:ColumnDefinition' :: ColumnDefinition -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
columnDescription
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
columnName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ColumnDataType
dataType

instance Data.ToJSON ColumnDefinition where
  toJSON :: ColumnDefinition -> Value
toJSON ColumnDefinition' {Maybe Text
Maybe ColumnDataType
dataType :: Maybe ColumnDataType
columnName :: Maybe Text
columnDescription :: Maybe Text
$sel:dataType:ColumnDefinition' :: ColumnDefinition -> Maybe ColumnDataType
$sel:columnName:ColumnDefinition' :: ColumnDefinition -> Maybe Text
$sel:columnDescription:ColumnDefinition' :: ColumnDefinition -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"columnDescription" 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
columnDescription,
            (Key
"columnName" 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
columnName,
            (Key
"dataType" 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 ColumnDataType
dataType
          ]
      )