{-# 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.LakeFormation.Types.DataCellsFilter
-- 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.LakeFormation.Types.DataCellsFilter where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.LakeFormation.Types.ColumnWildcard
import Amazonka.LakeFormation.Types.RowFilter
import qualified Amazonka.Prelude as Prelude

-- | A structure that describes certain columns on certain rows.
--
-- /See:/ 'newDataCellsFilter' smart constructor.
data DataCellsFilter = DataCellsFilter'
  { -- | A list of column names.
    DataCellsFilter -> Maybe [Text]
columnNames :: Prelude.Maybe [Prelude.Text],
    -- | A wildcard with exclusions.
    --
    -- You must specify either a @ColumnNames@ list or the @ColumnWildCard@.
    DataCellsFilter -> Maybe ColumnWildcard
columnWildcard :: Prelude.Maybe ColumnWildcard,
    -- | A PartiQL predicate.
    DataCellsFilter -> Maybe RowFilter
rowFilter :: Prelude.Maybe RowFilter,
    -- | The ID of the catalog to which the table belongs.
    DataCellsFilter -> Text
tableCatalogId :: Prelude.Text,
    -- | A database in the Glue Data Catalog.
    DataCellsFilter -> Text
databaseName :: Prelude.Text,
    -- | A table in the database.
    DataCellsFilter -> Text
tableName :: Prelude.Text,
    -- | The name given by the user to the data filter cell.
    DataCellsFilter -> Text
name :: Prelude.Text
  }
  deriving (DataCellsFilter -> DataCellsFilter -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DataCellsFilter -> DataCellsFilter -> Bool
$c/= :: DataCellsFilter -> DataCellsFilter -> Bool
== :: DataCellsFilter -> DataCellsFilter -> Bool
$c== :: DataCellsFilter -> DataCellsFilter -> Bool
Prelude.Eq, ReadPrec [DataCellsFilter]
ReadPrec DataCellsFilter
Int -> ReadS DataCellsFilter
ReadS [DataCellsFilter]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DataCellsFilter]
$creadListPrec :: ReadPrec [DataCellsFilter]
readPrec :: ReadPrec DataCellsFilter
$creadPrec :: ReadPrec DataCellsFilter
readList :: ReadS [DataCellsFilter]
$creadList :: ReadS [DataCellsFilter]
readsPrec :: Int -> ReadS DataCellsFilter
$creadsPrec :: Int -> ReadS DataCellsFilter
Prelude.Read, Int -> DataCellsFilter -> ShowS
[DataCellsFilter] -> ShowS
DataCellsFilter -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DataCellsFilter] -> ShowS
$cshowList :: [DataCellsFilter] -> ShowS
show :: DataCellsFilter -> String
$cshow :: DataCellsFilter -> String
showsPrec :: Int -> DataCellsFilter -> ShowS
$cshowsPrec :: Int -> DataCellsFilter -> ShowS
Prelude.Show, forall x. Rep DataCellsFilter x -> DataCellsFilter
forall x. DataCellsFilter -> Rep DataCellsFilter x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DataCellsFilter x -> DataCellsFilter
$cfrom :: forall x. DataCellsFilter -> Rep DataCellsFilter x
Prelude.Generic)

-- |
-- Create a value of 'DataCellsFilter' 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:
--
-- 'columnNames', 'dataCellsFilter_columnNames' - A list of column names.
--
-- 'columnWildcard', 'dataCellsFilter_columnWildcard' - A wildcard with exclusions.
--
-- You must specify either a @ColumnNames@ list or the @ColumnWildCard@.
--
-- 'rowFilter', 'dataCellsFilter_rowFilter' - A PartiQL predicate.
--
-- 'tableCatalogId', 'dataCellsFilter_tableCatalogId' - The ID of the catalog to which the table belongs.
--
-- 'databaseName', 'dataCellsFilter_databaseName' - A database in the Glue Data Catalog.
--
-- 'tableName', 'dataCellsFilter_tableName' - A table in the database.
--
-- 'name', 'dataCellsFilter_name' - The name given by the user to the data filter cell.
newDataCellsFilter ::
  -- | 'tableCatalogId'
  Prelude.Text ->
  -- | 'databaseName'
  Prelude.Text ->
  -- | 'tableName'
  Prelude.Text ->
  -- | 'name'
  Prelude.Text ->
  DataCellsFilter
newDataCellsFilter :: Text -> Text -> Text -> Text -> DataCellsFilter
newDataCellsFilter
  Text
pTableCatalogId_
  Text
pDatabaseName_
  Text
pTableName_
  Text
pName_ =
    DataCellsFilter'
      { $sel:columnNames:DataCellsFilter' :: Maybe [Text]
columnNames = forall a. Maybe a
Prelude.Nothing,
        $sel:columnWildcard:DataCellsFilter' :: Maybe ColumnWildcard
columnWildcard = forall a. Maybe a
Prelude.Nothing,
        $sel:rowFilter:DataCellsFilter' :: Maybe RowFilter
rowFilter = forall a. Maybe a
Prelude.Nothing,
        $sel:tableCatalogId:DataCellsFilter' :: Text
tableCatalogId = Text
pTableCatalogId_,
        $sel:databaseName:DataCellsFilter' :: Text
databaseName = Text
pDatabaseName_,
        $sel:tableName:DataCellsFilter' :: Text
tableName = Text
pTableName_,
        $sel:name:DataCellsFilter' :: Text
name = Text
pName_
      }

-- | A list of column names.
dataCellsFilter_columnNames :: Lens.Lens' DataCellsFilter (Prelude.Maybe [Prelude.Text])
dataCellsFilter_columnNames :: Lens' DataCellsFilter (Maybe [Text])
dataCellsFilter_columnNames = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DataCellsFilter' {Maybe [Text]
columnNames :: Maybe [Text]
$sel:columnNames:DataCellsFilter' :: DataCellsFilter -> Maybe [Text]
columnNames} -> Maybe [Text]
columnNames) (\s :: DataCellsFilter
s@DataCellsFilter' {} Maybe [Text]
a -> DataCellsFilter
s {$sel:columnNames:DataCellsFilter' :: Maybe [Text]
columnNames = Maybe [Text]
a} :: DataCellsFilter) 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

-- | A wildcard with exclusions.
--
-- You must specify either a @ColumnNames@ list or the @ColumnWildCard@.
dataCellsFilter_columnWildcard :: Lens.Lens' DataCellsFilter (Prelude.Maybe ColumnWildcard)
dataCellsFilter_columnWildcard :: Lens' DataCellsFilter (Maybe ColumnWildcard)
dataCellsFilter_columnWildcard = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DataCellsFilter' {Maybe ColumnWildcard
columnWildcard :: Maybe ColumnWildcard
$sel:columnWildcard:DataCellsFilter' :: DataCellsFilter -> Maybe ColumnWildcard
columnWildcard} -> Maybe ColumnWildcard
columnWildcard) (\s :: DataCellsFilter
s@DataCellsFilter' {} Maybe ColumnWildcard
a -> DataCellsFilter
s {$sel:columnWildcard:DataCellsFilter' :: Maybe ColumnWildcard
columnWildcard = Maybe ColumnWildcard
a} :: DataCellsFilter)

-- | A PartiQL predicate.
dataCellsFilter_rowFilter :: Lens.Lens' DataCellsFilter (Prelude.Maybe RowFilter)
dataCellsFilter_rowFilter :: Lens' DataCellsFilter (Maybe RowFilter)
dataCellsFilter_rowFilter = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DataCellsFilter' {Maybe RowFilter
rowFilter :: Maybe RowFilter
$sel:rowFilter:DataCellsFilter' :: DataCellsFilter -> Maybe RowFilter
rowFilter} -> Maybe RowFilter
rowFilter) (\s :: DataCellsFilter
s@DataCellsFilter' {} Maybe RowFilter
a -> DataCellsFilter
s {$sel:rowFilter:DataCellsFilter' :: Maybe RowFilter
rowFilter = Maybe RowFilter
a} :: DataCellsFilter)

-- | The ID of the catalog to which the table belongs.
dataCellsFilter_tableCatalogId :: Lens.Lens' DataCellsFilter Prelude.Text
dataCellsFilter_tableCatalogId :: Lens' DataCellsFilter Text
dataCellsFilter_tableCatalogId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DataCellsFilter' {Text
tableCatalogId :: Text
$sel:tableCatalogId:DataCellsFilter' :: DataCellsFilter -> Text
tableCatalogId} -> Text
tableCatalogId) (\s :: DataCellsFilter
s@DataCellsFilter' {} Text
a -> DataCellsFilter
s {$sel:tableCatalogId:DataCellsFilter' :: Text
tableCatalogId = Text
a} :: DataCellsFilter)

-- | A database in the Glue Data Catalog.
dataCellsFilter_databaseName :: Lens.Lens' DataCellsFilter Prelude.Text
dataCellsFilter_databaseName :: Lens' DataCellsFilter Text
dataCellsFilter_databaseName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DataCellsFilter' {Text
databaseName :: Text
$sel:databaseName:DataCellsFilter' :: DataCellsFilter -> Text
databaseName} -> Text
databaseName) (\s :: DataCellsFilter
s@DataCellsFilter' {} Text
a -> DataCellsFilter
s {$sel:databaseName:DataCellsFilter' :: Text
databaseName = Text
a} :: DataCellsFilter)

-- | A table in the database.
dataCellsFilter_tableName :: Lens.Lens' DataCellsFilter Prelude.Text
dataCellsFilter_tableName :: Lens' DataCellsFilter Text
dataCellsFilter_tableName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DataCellsFilter' {Text
tableName :: Text
$sel:tableName:DataCellsFilter' :: DataCellsFilter -> Text
tableName} -> Text
tableName) (\s :: DataCellsFilter
s@DataCellsFilter' {} Text
a -> DataCellsFilter
s {$sel:tableName:DataCellsFilter' :: Text
tableName = Text
a} :: DataCellsFilter)

-- | The name given by the user to the data filter cell.
dataCellsFilter_name :: Lens.Lens' DataCellsFilter Prelude.Text
dataCellsFilter_name :: Lens' DataCellsFilter Text
dataCellsFilter_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DataCellsFilter' {Text
name :: Text
$sel:name:DataCellsFilter' :: DataCellsFilter -> Text
name} -> Text
name) (\s :: DataCellsFilter
s@DataCellsFilter' {} Text
a -> DataCellsFilter
s {$sel:name:DataCellsFilter' :: Text
name = Text
a} :: DataCellsFilter)

instance Data.FromJSON DataCellsFilter where
  parseJSON :: Value -> Parser DataCellsFilter
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"DataCellsFilter"
      ( \Object
x ->
          Maybe [Text]
-> Maybe ColumnWildcard
-> Maybe RowFilter
-> Text
-> Text
-> Text
-> Text
-> DataCellsFilter
DataCellsFilter'
            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
"ColumnNames" 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 (Maybe a)
Data..:? Key
"ColumnWildcard")
            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
"RowFilter")
            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
"TableCatalogId")
            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
"DatabaseName")
            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
"TableName")
            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")
      )

instance Prelude.Hashable DataCellsFilter where
  hashWithSalt :: Int -> DataCellsFilter -> Int
hashWithSalt Int
_salt DataCellsFilter' {Maybe [Text]
Maybe ColumnWildcard
Maybe RowFilter
Text
name :: Text
tableName :: Text
databaseName :: Text
tableCatalogId :: Text
rowFilter :: Maybe RowFilter
columnWildcard :: Maybe ColumnWildcard
columnNames :: Maybe [Text]
$sel:name:DataCellsFilter' :: DataCellsFilter -> Text
$sel:tableName:DataCellsFilter' :: DataCellsFilter -> Text
$sel:databaseName:DataCellsFilter' :: DataCellsFilter -> Text
$sel:tableCatalogId:DataCellsFilter' :: DataCellsFilter -> Text
$sel:rowFilter:DataCellsFilter' :: DataCellsFilter -> Maybe RowFilter
$sel:columnWildcard:DataCellsFilter' :: DataCellsFilter -> Maybe ColumnWildcard
$sel:columnNames:DataCellsFilter' :: DataCellsFilter -> Maybe [Text]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
columnNames
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ColumnWildcard
columnWildcard
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe RowFilter
rowFilter
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
tableCatalogId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
databaseName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
tableName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
name

instance Prelude.NFData DataCellsFilter where
  rnf :: DataCellsFilter -> ()
rnf DataCellsFilter' {Maybe [Text]
Maybe ColumnWildcard
Maybe RowFilter
Text
name :: Text
tableName :: Text
databaseName :: Text
tableCatalogId :: Text
rowFilter :: Maybe RowFilter
columnWildcard :: Maybe ColumnWildcard
columnNames :: Maybe [Text]
$sel:name:DataCellsFilter' :: DataCellsFilter -> Text
$sel:tableName:DataCellsFilter' :: DataCellsFilter -> Text
$sel:databaseName:DataCellsFilter' :: DataCellsFilter -> Text
$sel:tableCatalogId:DataCellsFilter' :: DataCellsFilter -> Text
$sel:rowFilter:DataCellsFilter' :: DataCellsFilter -> Maybe RowFilter
$sel:columnWildcard:DataCellsFilter' :: DataCellsFilter -> Maybe ColumnWildcard
$sel:columnNames:DataCellsFilter' :: DataCellsFilter -> Maybe [Text]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
columnNames
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ColumnWildcard
columnWildcard
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe RowFilter
rowFilter
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
tableCatalogId
      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
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
name

instance Data.ToJSON DataCellsFilter where
  toJSON :: DataCellsFilter -> Value
toJSON DataCellsFilter' {Maybe [Text]
Maybe ColumnWildcard
Maybe RowFilter
Text
name :: Text
tableName :: Text
databaseName :: Text
tableCatalogId :: Text
rowFilter :: Maybe RowFilter
columnWildcard :: Maybe ColumnWildcard
columnNames :: Maybe [Text]
$sel:name:DataCellsFilter' :: DataCellsFilter -> Text
$sel:tableName:DataCellsFilter' :: DataCellsFilter -> Text
$sel:databaseName:DataCellsFilter' :: DataCellsFilter -> Text
$sel:tableCatalogId:DataCellsFilter' :: DataCellsFilter -> Text
$sel:rowFilter:DataCellsFilter' :: DataCellsFilter -> Maybe RowFilter
$sel:columnWildcard:DataCellsFilter' :: DataCellsFilter -> Maybe ColumnWildcard
$sel:columnNames:DataCellsFilter' :: DataCellsFilter -> Maybe [Text]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"ColumnNames" 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]
columnNames,
            (Key
"ColumnWildcard" 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 ColumnWildcard
columnWildcard,
            (Key
"RowFilter" 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 RowFilter
rowFilter,
            forall a. a -> Maybe a
Prelude.Just
              (Key
"TableCatalogId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
tableCatalogId),
            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),
            forall a. a -> Maybe a
Prelude.Just (Key
"Name" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
name)
          ]
      )