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

import Amazonka.AppFlow.Types.SalesforceDataTransferApi
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 are applied when Salesforce is being used as a
-- source.
--
-- /See:/ 'newSalesforceSourceProperties' smart constructor.
data SalesforceSourceProperties = SalesforceSourceProperties'
  { -- | Specifies which Salesforce API is used by Amazon AppFlow when your flow
    -- transfers data from Salesforce.
    --
    -- [AUTOMATIC]
    --     The default. Amazon AppFlow selects which API to use based on the
    --     number of records that your flow transfers from Salesforce. If your
    --     flow transfers fewer than 1,000,000 records, Amazon AppFlow uses
    --     Salesforce REST API. If your flow transfers 1,000,000 records or
    --     more, Amazon AppFlow uses Salesforce Bulk API 2.0.
    --
    --     Each of these Salesforce APIs structures data differently. If Amazon
    --     AppFlow selects the API automatically, be aware that, for recurring
    --     flows, the data output might vary from one flow run to the next. For
    --     example, if a flow runs daily, it might use REST API on one day to
    --     transfer 900,000 records, and it might use Bulk API 2.0 on the next
    --     day to transfer 1,100,000 records. For each of these flow runs, the
    --     respective Salesforce API formats the data differently. Some of the
    --     differences include how dates are formatted and null values are
    --     represented. Also, Bulk API 2.0 doesn\'t transfer Salesforce
    --     compound fields.
    --
    --     By choosing this option, you optimize flow performance for both
    --     small and large data transfers, but the tradeoff is inconsistent
    --     formatting in the output.
    --
    -- [BULKV2]
    --     Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs
    --     asynchronous data transfers, and it\'s optimal for large sets of
    --     data. By choosing this option, you ensure that your flow writes
    --     consistent output, but you optimize performance only for large data
    --     transfers.
    --
    --     Note that Bulk API 2.0 does not transfer Salesforce compound fields.
    --
    -- [REST_SYNC]
    --     Amazon AppFlow uses only Salesforce REST API. By choosing this
    --     option, you ensure that your flow writes consistent output, but you
    --     decrease performance for large data transfers that are better suited
    --     for Bulk API 2.0. In some cases, if your flow attempts to transfer a
    --     vary large set of data, it might fail wituh a timed out error.
    SalesforceSourceProperties -> Maybe SalesforceDataTransferApi
dataTransferApi :: Prelude.Maybe SalesforceDataTransferApi,
    -- | The flag that enables dynamic fetching of new (recently added) fields in
    -- the Salesforce objects while running a flow.
    SalesforceSourceProperties -> Maybe Bool
enableDynamicFieldUpdate :: Prelude.Maybe Prelude.Bool,
    -- | Indicates whether Amazon AppFlow includes deleted files in the flow run.
    SalesforceSourceProperties -> Maybe Bool
includeDeletedRecords :: Prelude.Maybe Prelude.Bool,
    -- | The object specified in the Salesforce flow source.
    SalesforceSourceProperties -> Text
object' :: Prelude.Text
  }
  deriving (SalesforceSourceProperties -> SalesforceSourceProperties -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: SalesforceSourceProperties -> SalesforceSourceProperties -> Bool
$c/= :: SalesforceSourceProperties -> SalesforceSourceProperties -> Bool
== :: SalesforceSourceProperties -> SalesforceSourceProperties -> Bool
$c== :: SalesforceSourceProperties -> SalesforceSourceProperties -> Bool
Prelude.Eq, ReadPrec [SalesforceSourceProperties]
ReadPrec SalesforceSourceProperties
Int -> ReadS SalesforceSourceProperties
ReadS [SalesforceSourceProperties]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [SalesforceSourceProperties]
$creadListPrec :: ReadPrec [SalesforceSourceProperties]
readPrec :: ReadPrec SalesforceSourceProperties
$creadPrec :: ReadPrec SalesforceSourceProperties
readList :: ReadS [SalesforceSourceProperties]
$creadList :: ReadS [SalesforceSourceProperties]
readsPrec :: Int -> ReadS SalesforceSourceProperties
$creadsPrec :: Int -> ReadS SalesforceSourceProperties
Prelude.Read, Int -> SalesforceSourceProperties -> ShowS
[SalesforceSourceProperties] -> ShowS
SalesforceSourceProperties -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [SalesforceSourceProperties] -> ShowS
$cshowList :: [SalesforceSourceProperties] -> ShowS
show :: SalesforceSourceProperties -> String
$cshow :: SalesforceSourceProperties -> String
showsPrec :: Int -> SalesforceSourceProperties -> ShowS
$cshowsPrec :: Int -> SalesforceSourceProperties -> ShowS
Prelude.Show, forall x.
Rep SalesforceSourceProperties x -> SalesforceSourceProperties
forall x.
SalesforceSourceProperties -> Rep SalesforceSourceProperties x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep SalesforceSourceProperties x -> SalesforceSourceProperties
$cfrom :: forall x.
SalesforceSourceProperties -> Rep SalesforceSourceProperties x
Prelude.Generic)

-- |
-- Create a value of 'SalesforceSourceProperties' 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:
--
-- 'dataTransferApi', 'salesforceSourceProperties_dataTransferApi' - Specifies which Salesforce API is used by Amazon AppFlow when your flow
-- transfers data from Salesforce.
--
-- [AUTOMATIC]
--     The default. Amazon AppFlow selects which API to use based on the
--     number of records that your flow transfers from Salesforce. If your
--     flow transfers fewer than 1,000,000 records, Amazon AppFlow uses
--     Salesforce REST API. If your flow transfers 1,000,000 records or
--     more, Amazon AppFlow uses Salesforce Bulk API 2.0.
--
--     Each of these Salesforce APIs structures data differently. If Amazon
--     AppFlow selects the API automatically, be aware that, for recurring
--     flows, the data output might vary from one flow run to the next. For
--     example, if a flow runs daily, it might use REST API on one day to
--     transfer 900,000 records, and it might use Bulk API 2.0 on the next
--     day to transfer 1,100,000 records. For each of these flow runs, the
--     respective Salesforce API formats the data differently. Some of the
--     differences include how dates are formatted and null values are
--     represented. Also, Bulk API 2.0 doesn\'t transfer Salesforce
--     compound fields.
--
--     By choosing this option, you optimize flow performance for both
--     small and large data transfers, but the tradeoff is inconsistent
--     formatting in the output.
--
-- [BULKV2]
--     Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs
--     asynchronous data transfers, and it\'s optimal for large sets of
--     data. By choosing this option, you ensure that your flow writes
--     consistent output, but you optimize performance only for large data
--     transfers.
--
--     Note that Bulk API 2.0 does not transfer Salesforce compound fields.
--
-- [REST_SYNC]
--     Amazon AppFlow uses only Salesforce REST API. By choosing this
--     option, you ensure that your flow writes consistent output, but you
--     decrease performance for large data transfers that are better suited
--     for Bulk API 2.0. In some cases, if your flow attempts to transfer a
--     vary large set of data, it might fail wituh a timed out error.
--
-- 'enableDynamicFieldUpdate', 'salesforceSourceProperties_enableDynamicFieldUpdate' - The flag that enables dynamic fetching of new (recently added) fields in
-- the Salesforce objects while running a flow.
--
-- 'includeDeletedRecords', 'salesforceSourceProperties_includeDeletedRecords' - Indicates whether Amazon AppFlow includes deleted files in the flow run.
--
-- 'object'', 'salesforceSourceProperties_object' - The object specified in the Salesforce flow source.
newSalesforceSourceProperties ::
  -- | 'object''
  Prelude.Text ->
  SalesforceSourceProperties
newSalesforceSourceProperties :: Text -> SalesforceSourceProperties
newSalesforceSourceProperties Text
pObject_ =
  SalesforceSourceProperties'
    { $sel:dataTransferApi:SalesforceSourceProperties' :: Maybe SalesforceDataTransferApi
dataTransferApi =
        forall a. Maybe a
Prelude.Nothing,
      $sel:enableDynamicFieldUpdate:SalesforceSourceProperties' :: Maybe Bool
enableDynamicFieldUpdate = forall a. Maybe a
Prelude.Nothing,
      $sel:includeDeletedRecords:SalesforceSourceProperties' :: Maybe Bool
includeDeletedRecords = forall a. Maybe a
Prelude.Nothing,
      $sel:object':SalesforceSourceProperties' :: Text
object' = Text
pObject_
    }

-- | Specifies which Salesforce API is used by Amazon AppFlow when your flow
-- transfers data from Salesforce.
--
-- [AUTOMATIC]
--     The default. Amazon AppFlow selects which API to use based on the
--     number of records that your flow transfers from Salesforce. If your
--     flow transfers fewer than 1,000,000 records, Amazon AppFlow uses
--     Salesforce REST API. If your flow transfers 1,000,000 records or
--     more, Amazon AppFlow uses Salesforce Bulk API 2.0.
--
--     Each of these Salesforce APIs structures data differently. If Amazon
--     AppFlow selects the API automatically, be aware that, for recurring
--     flows, the data output might vary from one flow run to the next. For
--     example, if a flow runs daily, it might use REST API on one day to
--     transfer 900,000 records, and it might use Bulk API 2.0 on the next
--     day to transfer 1,100,000 records. For each of these flow runs, the
--     respective Salesforce API formats the data differently. Some of the
--     differences include how dates are formatted and null values are
--     represented. Also, Bulk API 2.0 doesn\'t transfer Salesforce
--     compound fields.
--
--     By choosing this option, you optimize flow performance for both
--     small and large data transfers, but the tradeoff is inconsistent
--     formatting in the output.
--
-- [BULKV2]
--     Amazon AppFlow uses only Salesforce Bulk API 2.0. This API runs
--     asynchronous data transfers, and it\'s optimal for large sets of
--     data. By choosing this option, you ensure that your flow writes
--     consistent output, but you optimize performance only for large data
--     transfers.
--
--     Note that Bulk API 2.0 does not transfer Salesforce compound fields.
--
-- [REST_SYNC]
--     Amazon AppFlow uses only Salesforce REST API. By choosing this
--     option, you ensure that your flow writes consistent output, but you
--     decrease performance for large data transfers that are better suited
--     for Bulk API 2.0. In some cases, if your flow attempts to transfer a
--     vary large set of data, it might fail wituh a timed out error.
salesforceSourceProperties_dataTransferApi :: Lens.Lens' SalesforceSourceProperties (Prelude.Maybe SalesforceDataTransferApi)
salesforceSourceProperties_dataTransferApi :: Lens' SalesforceSourceProperties (Maybe SalesforceDataTransferApi)
salesforceSourceProperties_dataTransferApi = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SalesforceSourceProperties' {Maybe SalesforceDataTransferApi
dataTransferApi :: Maybe SalesforceDataTransferApi
$sel:dataTransferApi:SalesforceSourceProperties' :: SalesforceSourceProperties -> Maybe SalesforceDataTransferApi
dataTransferApi} -> Maybe SalesforceDataTransferApi
dataTransferApi) (\s :: SalesforceSourceProperties
s@SalesforceSourceProperties' {} Maybe SalesforceDataTransferApi
a -> SalesforceSourceProperties
s {$sel:dataTransferApi:SalesforceSourceProperties' :: Maybe SalesforceDataTransferApi
dataTransferApi = Maybe SalesforceDataTransferApi
a} :: SalesforceSourceProperties)

-- | The flag that enables dynamic fetching of new (recently added) fields in
-- the Salesforce objects while running a flow.
salesforceSourceProperties_enableDynamicFieldUpdate :: Lens.Lens' SalesforceSourceProperties (Prelude.Maybe Prelude.Bool)
salesforceSourceProperties_enableDynamicFieldUpdate :: Lens' SalesforceSourceProperties (Maybe Bool)
salesforceSourceProperties_enableDynamicFieldUpdate = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SalesforceSourceProperties' {Maybe Bool
enableDynamicFieldUpdate :: Maybe Bool
$sel:enableDynamicFieldUpdate:SalesforceSourceProperties' :: SalesforceSourceProperties -> Maybe Bool
enableDynamicFieldUpdate} -> Maybe Bool
enableDynamicFieldUpdate) (\s :: SalesforceSourceProperties
s@SalesforceSourceProperties' {} Maybe Bool
a -> SalesforceSourceProperties
s {$sel:enableDynamicFieldUpdate:SalesforceSourceProperties' :: Maybe Bool
enableDynamicFieldUpdate = Maybe Bool
a} :: SalesforceSourceProperties)

-- | Indicates whether Amazon AppFlow includes deleted files in the flow run.
salesforceSourceProperties_includeDeletedRecords :: Lens.Lens' SalesforceSourceProperties (Prelude.Maybe Prelude.Bool)
salesforceSourceProperties_includeDeletedRecords :: Lens' SalesforceSourceProperties (Maybe Bool)
salesforceSourceProperties_includeDeletedRecords = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SalesforceSourceProperties' {Maybe Bool
includeDeletedRecords :: Maybe Bool
$sel:includeDeletedRecords:SalesforceSourceProperties' :: SalesforceSourceProperties -> Maybe Bool
includeDeletedRecords} -> Maybe Bool
includeDeletedRecords) (\s :: SalesforceSourceProperties
s@SalesforceSourceProperties' {} Maybe Bool
a -> SalesforceSourceProperties
s {$sel:includeDeletedRecords:SalesforceSourceProperties' :: Maybe Bool
includeDeletedRecords = Maybe Bool
a} :: SalesforceSourceProperties)

-- | The object specified in the Salesforce flow source.
salesforceSourceProperties_object :: Lens.Lens' SalesforceSourceProperties Prelude.Text
salesforceSourceProperties_object :: Lens' SalesforceSourceProperties Text
salesforceSourceProperties_object = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SalesforceSourceProperties' {Text
object' :: Text
$sel:object':SalesforceSourceProperties' :: SalesforceSourceProperties -> Text
object'} -> Text
object') (\s :: SalesforceSourceProperties
s@SalesforceSourceProperties' {} Text
a -> SalesforceSourceProperties
s {$sel:object':SalesforceSourceProperties' :: Text
object' = Text
a} :: SalesforceSourceProperties)

instance Data.FromJSON SalesforceSourceProperties where
  parseJSON :: Value -> Parser SalesforceSourceProperties
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"SalesforceSourceProperties"
      ( \Object
x ->
          Maybe SalesforceDataTransferApi
-> Maybe Bool -> Maybe Bool -> Text -> SalesforceSourceProperties
SalesforceSourceProperties'
            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
"dataTransferApi")
            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
"enableDynamicFieldUpdate")
            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
"includeDeletedRecords")
            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
"object")
      )

instance Prelude.Hashable SalesforceSourceProperties where
  hashWithSalt :: Int -> SalesforceSourceProperties -> Int
hashWithSalt Int
_salt SalesforceSourceProperties' {Maybe Bool
Maybe SalesforceDataTransferApi
Text
object' :: Text
includeDeletedRecords :: Maybe Bool
enableDynamicFieldUpdate :: Maybe Bool
dataTransferApi :: Maybe SalesforceDataTransferApi
$sel:object':SalesforceSourceProperties' :: SalesforceSourceProperties -> Text
$sel:includeDeletedRecords:SalesforceSourceProperties' :: SalesforceSourceProperties -> Maybe Bool
$sel:enableDynamicFieldUpdate:SalesforceSourceProperties' :: SalesforceSourceProperties -> Maybe Bool
$sel:dataTransferApi:SalesforceSourceProperties' :: SalesforceSourceProperties -> Maybe SalesforceDataTransferApi
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe SalesforceDataTransferApi
dataTransferApi
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
enableDynamicFieldUpdate
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Bool
includeDeletedRecords
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
object'

instance Prelude.NFData SalesforceSourceProperties where
  rnf :: SalesforceSourceProperties -> ()
rnf SalesforceSourceProperties' {Maybe Bool
Maybe SalesforceDataTransferApi
Text
object' :: Text
includeDeletedRecords :: Maybe Bool
enableDynamicFieldUpdate :: Maybe Bool
dataTransferApi :: Maybe SalesforceDataTransferApi
$sel:object':SalesforceSourceProperties' :: SalesforceSourceProperties -> Text
$sel:includeDeletedRecords:SalesforceSourceProperties' :: SalesforceSourceProperties -> Maybe Bool
$sel:enableDynamicFieldUpdate:SalesforceSourceProperties' :: SalesforceSourceProperties -> Maybe Bool
$sel:dataTransferApi:SalesforceSourceProperties' :: SalesforceSourceProperties -> Maybe SalesforceDataTransferApi
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe SalesforceDataTransferApi
dataTransferApi
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
enableDynamicFieldUpdate
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Bool
includeDeletedRecords
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
object'

instance Data.ToJSON SalesforceSourceProperties where
  toJSON :: SalesforceSourceProperties -> Value
toJSON SalesforceSourceProperties' {Maybe Bool
Maybe SalesforceDataTransferApi
Text
object' :: Text
includeDeletedRecords :: Maybe Bool
enableDynamicFieldUpdate :: Maybe Bool
dataTransferApi :: Maybe SalesforceDataTransferApi
$sel:object':SalesforceSourceProperties' :: SalesforceSourceProperties -> Text
$sel:includeDeletedRecords:SalesforceSourceProperties' :: SalesforceSourceProperties -> Maybe Bool
$sel:enableDynamicFieldUpdate:SalesforceSourceProperties' :: SalesforceSourceProperties -> Maybe Bool
$sel:dataTransferApi:SalesforceSourceProperties' :: SalesforceSourceProperties -> Maybe SalesforceDataTransferApi
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"dataTransferApi" 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 SalesforceDataTransferApi
dataTransferApi,
            (Key
"enableDynamicFieldUpdate" 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 Bool
enableDynamicFieldUpdate,
            (Key
"includeDeletedRecords" 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 Bool
includeDeletedRecords,
            forall a. a -> Maybe a
Prelude.Just (Key
"object" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
object')
          ]
      )