{-# 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.AppFlow.Types.SourceFieldProperties
-- 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.AppFlow.Types.SourceFieldProperties 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

-- | The properties that can be applied to a field when the connector is
-- being used as a source.
--
-- /See:/ 'newSourceFieldProperties' smart constructor.
data SourceFieldProperties = SourceFieldProperties'
  { -- | Indicates if the field can be queried.
    SourceFieldProperties -> Maybe Bool
isQueryable :: Prelude.Maybe Prelude.Bool,
    -- | Indicates whether the field can be returned in a search result.
    SourceFieldProperties -> Maybe Bool
isRetrievable :: Prelude.Maybe Prelude.Bool,
    -- | Indicates if this timestamp field can be used for incremental queries.
    SourceFieldProperties -> Maybe Bool
isTimestampFieldForIncrementalQueries :: Prelude.Maybe Prelude.Bool
  }
  deriving (SourceFieldProperties -> SourceFieldProperties -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: SourceFieldProperties -> SourceFieldProperties -> Bool
$c/= :: SourceFieldProperties -> SourceFieldProperties -> Bool
== :: SourceFieldProperties -> SourceFieldProperties -> Bool
$c== :: SourceFieldProperties -> SourceFieldProperties -> Bool
Prelude.Eq, ReadPrec [SourceFieldProperties]
ReadPrec SourceFieldProperties
Int -> ReadS SourceFieldProperties
ReadS [SourceFieldProperties]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [SourceFieldProperties]
$creadListPrec :: ReadPrec [SourceFieldProperties]
readPrec :: ReadPrec SourceFieldProperties
$creadPrec :: ReadPrec SourceFieldProperties
readList :: ReadS [SourceFieldProperties]
$creadList :: ReadS [SourceFieldProperties]
readsPrec :: Int -> ReadS SourceFieldProperties
$creadsPrec :: Int -> ReadS SourceFieldProperties
Prelude.Read, Int -> SourceFieldProperties -> ShowS
[SourceFieldProperties] -> ShowS
SourceFieldProperties -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [SourceFieldProperties] -> ShowS
$cshowList :: [SourceFieldProperties] -> ShowS
show :: SourceFieldProperties -> String
$cshow :: SourceFieldProperties -> String
showsPrec :: Int -> SourceFieldProperties -> ShowS
$cshowsPrec :: Int -> SourceFieldProperties -> ShowS
Prelude.Show, forall x. Rep SourceFieldProperties x -> SourceFieldProperties
forall x. SourceFieldProperties -> Rep SourceFieldProperties x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep SourceFieldProperties x -> SourceFieldProperties
$cfrom :: forall x. SourceFieldProperties -> Rep SourceFieldProperties x
Prelude.Generic)

-- |
-- Create a value of 'SourceFieldProperties' 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:
--
-- 'isQueryable', 'sourceFieldProperties_isQueryable' - Indicates if the field can be queried.
--
-- 'isRetrievable', 'sourceFieldProperties_isRetrievable' - Indicates whether the field can be returned in a search result.
--
-- 'isTimestampFieldForIncrementalQueries', 'sourceFieldProperties_isTimestampFieldForIncrementalQueries' - Indicates if this timestamp field can be used for incremental queries.
newSourceFieldProperties ::
  SourceFieldProperties
newSourceFieldProperties :: SourceFieldProperties
newSourceFieldProperties =
  SourceFieldProperties'
    { $sel:isQueryable:SourceFieldProperties' :: Maybe Bool
isQueryable =
        forall a. Maybe a
Prelude.Nothing,
      $sel:isRetrievable:SourceFieldProperties' :: Maybe Bool
isRetrievable = forall a. Maybe a
Prelude.Nothing,
      $sel:isTimestampFieldForIncrementalQueries:SourceFieldProperties' :: Maybe Bool
isTimestampFieldForIncrementalQueries =
        forall a. Maybe a
Prelude.Nothing
    }

-- | Indicates if the field can be queried.
sourceFieldProperties_isQueryable :: Lens.Lens' SourceFieldProperties (Prelude.Maybe Prelude.Bool)
sourceFieldProperties_isQueryable :: Lens' SourceFieldProperties (Maybe Bool)
sourceFieldProperties_isQueryable = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SourceFieldProperties' {Maybe Bool
isQueryable :: Maybe Bool
$sel:isQueryable:SourceFieldProperties' :: SourceFieldProperties -> Maybe Bool
isQueryable} -> Maybe Bool
isQueryable) (\s :: SourceFieldProperties
s@SourceFieldProperties' {} Maybe Bool
a -> SourceFieldProperties
s {$sel:isQueryable:SourceFieldProperties' :: Maybe Bool
isQueryable = Maybe Bool
a} :: SourceFieldProperties)

-- | Indicates whether the field can be returned in a search result.
sourceFieldProperties_isRetrievable :: Lens.Lens' SourceFieldProperties (Prelude.Maybe Prelude.Bool)
sourceFieldProperties_isRetrievable :: Lens' SourceFieldProperties (Maybe Bool)
sourceFieldProperties_isRetrievable = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SourceFieldProperties' {Maybe Bool
isRetrievable :: Maybe Bool
$sel:isRetrievable:SourceFieldProperties' :: SourceFieldProperties -> Maybe Bool
isRetrievable} -> Maybe Bool
isRetrievable) (\s :: SourceFieldProperties
s@SourceFieldProperties' {} Maybe Bool
a -> SourceFieldProperties
s {$sel:isRetrievable:SourceFieldProperties' :: Maybe Bool
isRetrievable = Maybe Bool
a} :: SourceFieldProperties)

-- | Indicates if this timestamp field can be used for incremental queries.
sourceFieldProperties_isTimestampFieldForIncrementalQueries :: Lens.Lens' SourceFieldProperties (Prelude.Maybe Prelude.Bool)
sourceFieldProperties_isTimestampFieldForIncrementalQueries :: Lens' SourceFieldProperties (Maybe Bool)
sourceFieldProperties_isTimestampFieldForIncrementalQueries = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SourceFieldProperties' {Maybe Bool
isTimestampFieldForIncrementalQueries :: Maybe Bool
$sel:isTimestampFieldForIncrementalQueries:SourceFieldProperties' :: SourceFieldProperties -> Maybe Bool
isTimestampFieldForIncrementalQueries} -> Maybe Bool
isTimestampFieldForIncrementalQueries) (\s :: SourceFieldProperties
s@SourceFieldProperties' {} Maybe Bool
a -> SourceFieldProperties
s {$sel:isTimestampFieldForIncrementalQueries:SourceFieldProperties' :: Maybe Bool
isTimestampFieldForIncrementalQueries = Maybe Bool
a} :: SourceFieldProperties)

instance Data.FromJSON SourceFieldProperties where
  parseJSON :: Value -> Parser SourceFieldProperties
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"SourceFieldProperties"
      ( \Object
x ->
          Maybe Bool -> Maybe Bool -> Maybe Bool -> SourceFieldProperties
SourceFieldProperties'
            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
"isQueryable")
            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
"isRetrievable")
            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
"isTimestampFieldForIncrementalQueries")
      )

instance Prelude.Hashable SourceFieldProperties where
  hashWithSalt :: Int -> SourceFieldProperties -> Int
hashWithSalt Int
_salt SourceFieldProperties' {Maybe Bool
isTimestampFieldForIncrementalQueries :: Maybe Bool
isRetrievable :: Maybe Bool
isQueryable :: Maybe Bool
$sel:isTimestampFieldForIncrementalQueries:SourceFieldProperties' :: SourceFieldProperties -> Maybe Bool
$sel:isRetrievable:SourceFieldProperties' :: SourceFieldProperties -> Maybe Bool
$sel:isQueryable:SourceFieldProperties' :: SourceFieldProperties -> Maybe Bool
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
isQueryable
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
isRetrievable
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
isTimestampFieldForIncrementalQueries

instance Prelude.NFData SourceFieldProperties where
  rnf :: SourceFieldProperties -> ()
rnf SourceFieldProperties' {Maybe Bool
isTimestampFieldForIncrementalQueries :: Maybe Bool
isRetrievable :: Maybe Bool
isQueryable :: Maybe Bool
$sel:isTimestampFieldForIncrementalQueries:SourceFieldProperties' :: SourceFieldProperties -> Maybe Bool
$sel:isRetrievable:SourceFieldProperties' :: SourceFieldProperties -> Maybe Bool
$sel:isQueryable:SourceFieldProperties' :: SourceFieldProperties -> Maybe Bool
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
isQueryable
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
isRetrievable
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
isTimestampFieldForIncrementalQueries