{-# 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.SourceFlowConfig
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.AppFlow.Types.SourceFlowConfig where

import Amazonka.AppFlow.Types.ConnectorType
import Amazonka.AppFlow.Types.IncrementalPullConfig
import Amazonka.AppFlow.Types.SourceConnectorProperties
import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import qualified Amazonka.Prelude as Prelude

-- | Contains information about the configuration of the source connector
-- used in the flow.
--
-- /See:/ 'newSourceFlowConfig' smart constructor.
data SourceFlowConfig = SourceFlowConfig'
  { -- | The name of the connector profile. This name must be unique for each
    -- connector profile in the Amazon Web Services account.
    SourceFlowConfig -> Maybe Text
connectorProfileName :: Prelude.Maybe Prelude.Text,
    -- | Defines the configuration for a scheduled incremental data pull. If a
    -- valid configuration is provided, the fields specified in the
    -- configuration are used when querying for the incremental data pull.
    SourceFlowConfig -> Maybe IncrementalPullConfig
incrementalPullConfig :: Prelude.Maybe IncrementalPullConfig,
    -- | The type of connector, such as Salesforce, Amplitude, and so on.
    SourceFlowConfig -> ConnectorType
connectorType :: ConnectorType,
    -- | Specifies the information that is required to query a particular source
    -- connector.
    SourceFlowConfig -> SourceConnectorProperties
sourceConnectorProperties :: SourceConnectorProperties
  }
  deriving (SourceFlowConfig -> SourceFlowConfig -> Bool
(SourceFlowConfig -> SourceFlowConfig -> Bool)
-> (SourceFlowConfig -> SourceFlowConfig -> Bool)
-> Eq SourceFlowConfig
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: SourceFlowConfig -> SourceFlowConfig -> Bool
$c/= :: SourceFlowConfig -> SourceFlowConfig -> Bool
== :: SourceFlowConfig -> SourceFlowConfig -> Bool
$c== :: SourceFlowConfig -> SourceFlowConfig -> Bool
Prelude.Eq, ReadPrec [SourceFlowConfig]
ReadPrec SourceFlowConfig
Int -> ReadS SourceFlowConfig
ReadS [SourceFlowConfig]
(Int -> ReadS SourceFlowConfig)
-> ReadS [SourceFlowConfig]
-> ReadPrec SourceFlowConfig
-> ReadPrec [SourceFlowConfig]
-> Read SourceFlowConfig
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [SourceFlowConfig]
$creadListPrec :: ReadPrec [SourceFlowConfig]
readPrec :: ReadPrec SourceFlowConfig
$creadPrec :: ReadPrec SourceFlowConfig
readList :: ReadS [SourceFlowConfig]
$creadList :: ReadS [SourceFlowConfig]
readsPrec :: Int -> ReadS SourceFlowConfig
$creadsPrec :: Int -> ReadS SourceFlowConfig
Prelude.Read, Int -> SourceFlowConfig -> ShowS
[SourceFlowConfig] -> ShowS
SourceFlowConfig -> String
(Int -> SourceFlowConfig -> ShowS)
-> (SourceFlowConfig -> String)
-> ([SourceFlowConfig] -> ShowS)
-> Show SourceFlowConfig
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [SourceFlowConfig] -> ShowS
$cshowList :: [SourceFlowConfig] -> ShowS
show :: SourceFlowConfig -> String
$cshow :: SourceFlowConfig -> String
showsPrec :: Int -> SourceFlowConfig -> ShowS
$cshowsPrec :: Int -> SourceFlowConfig -> ShowS
Prelude.Show, (forall x. SourceFlowConfig -> Rep SourceFlowConfig x)
-> (forall x. Rep SourceFlowConfig x -> SourceFlowConfig)
-> Generic SourceFlowConfig
forall x. Rep SourceFlowConfig x -> SourceFlowConfig
forall x. SourceFlowConfig -> Rep SourceFlowConfig x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep SourceFlowConfig x -> SourceFlowConfig
$cfrom :: forall x. SourceFlowConfig -> Rep SourceFlowConfig x
Prelude.Generic)

-- |
-- Create a value of 'SourceFlowConfig' 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:
--
-- 'connectorProfileName', 'sourceFlowConfig_connectorProfileName' - The name of the connector profile. This name must be unique for each
-- connector profile in the Amazon Web Services account.
--
-- 'incrementalPullConfig', 'sourceFlowConfig_incrementalPullConfig' - Defines the configuration for a scheduled incremental data pull. If a
-- valid configuration is provided, the fields specified in the
-- configuration are used when querying for the incremental data pull.
--
-- 'connectorType', 'sourceFlowConfig_connectorType' - The type of connector, such as Salesforce, Amplitude, and so on.
--
-- 'sourceConnectorProperties', 'sourceFlowConfig_sourceConnectorProperties' - Specifies the information that is required to query a particular source
-- connector.
newSourceFlowConfig ::
  -- | 'connectorType'
  ConnectorType ->
  -- | 'sourceConnectorProperties'
  SourceConnectorProperties ->
  SourceFlowConfig
newSourceFlowConfig :: ConnectorType -> SourceConnectorProperties -> SourceFlowConfig
newSourceFlowConfig
  ConnectorType
pConnectorType_
  SourceConnectorProperties
pSourceConnectorProperties_ =
    SourceFlowConfig' :: Maybe Text
-> Maybe IncrementalPullConfig
-> ConnectorType
-> SourceConnectorProperties
-> SourceFlowConfig
SourceFlowConfig'
      { $sel:connectorProfileName:SourceFlowConfig' :: Maybe Text
connectorProfileName =
          Maybe Text
forall a. Maybe a
Prelude.Nothing,
        $sel:incrementalPullConfig:SourceFlowConfig' :: Maybe IncrementalPullConfig
incrementalPullConfig = Maybe IncrementalPullConfig
forall a. Maybe a
Prelude.Nothing,
        $sel:connectorType:SourceFlowConfig' :: ConnectorType
connectorType = ConnectorType
pConnectorType_,
        $sel:sourceConnectorProperties:SourceFlowConfig' :: SourceConnectorProperties
sourceConnectorProperties =
          SourceConnectorProperties
pSourceConnectorProperties_
      }

-- | The name of the connector profile. This name must be unique for each
-- connector profile in the Amazon Web Services account.
sourceFlowConfig_connectorProfileName :: Lens.Lens' SourceFlowConfig (Prelude.Maybe Prelude.Text)
sourceFlowConfig_connectorProfileName :: (Maybe Text -> f (Maybe Text))
-> SourceFlowConfig -> f SourceFlowConfig
sourceFlowConfig_connectorProfileName = (SourceFlowConfig -> Maybe Text)
-> (SourceFlowConfig -> Maybe Text -> SourceFlowConfig)
-> Lens SourceFlowConfig SourceFlowConfig (Maybe Text) (Maybe Text)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SourceFlowConfig' {Maybe Text
connectorProfileName :: Maybe Text
$sel:connectorProfileName:SourceFlowConfig' :: SourceFlowConfig -> Maybe Text
connectorProfileName} -> Maybe Text
connectorProfileName) (\s :: SourceFlowConfig
s@SourceFlowConfig' {} Maybe Text
a -> SourceFlowConfig
s {$sel:connectorProfileName:SourceFlowConfig' :: Maybe Text
connectorProfileName = Maybe Text
a} :: SourceFlowConfig)

-- | Defines the configuration for a scheduled incremental data pull. If a
-- valid configuration is provided, the fields specified in the
-- configuration are used when querying for the incremental data pull.
sourceFlowConfig_incrementalPullConfig :: Lens.Lens' SourceFlowConfig (Prelude.Maybe IncrementalPullConfig)
sourceFlowConfig_incrementalPullConfig :: (Maybe IncrementalPullConfig -> f (Maybe IncrementalPullConfig))
-> SourceFlowConfig -> f SourceFlowConfig
sourceFlowConfig_incrementalPullConfig = (SourceFlowConfig -> Maybe IncrementalPullConfig)
-> (SourceFlowConfig
    -> Maybe IncrementalPullConfig -> SourceFlowConfig)
-> Lens
     SourceFlowConfig
     SourceFlowConfig
     (Maybe IncrementalPullConfig)
     (Maybe IncrementalPullConfig)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SourceFlowConfig' {Maybe IncrementalPullConfig
incrementalPullConfig :: Maybe IncrementalPullConfig
$sel:incrementalPullConfig:SourceFlowConfig' :: SourceFlowConfig -> Maybe IncrementalPullConfig
incrementalPullConfig} -> Maybe IncrementalPullConfig
incrementalPullConfig) (\s :: SourceFlowConfig
s@SourceFlowConfig' {} Maybe IncrementalPullConfig
a -> SourceFlowConfig
s {$sel:incrementalPullConfig:SourceFlowConfig' :: Maybe IncrementalPullConfig
incrementalPullConfig = Maybe IncrementalPullConfig
a} :: SourceFlowConfig)

-- | The type of connector, such as Salesforce, Amplitude, and so on.
sourceFlowConfig_connectorType :: Lens.Lens' SourceFlowConfig ConnectorType
sourceFlowConfig_connectorType :: (ConnectorType -> f ConnectorType)
-> SourceFlowConfig -> f SourceFlowConfig
sourceFlowConfig_connectorType = (SourceFlowConfig -> ConnectorType)
-> (SourceFlowConfig -> ConnectorType -> SourceFlowConfig)
-> Lens
     SourceFlowConfig SourceFlowConfig ConnectorType ConnectorType
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SourceFlowConfig' {ConnectorType
connectorType :: ConnectorType
$sel:connectorType:SourceFlowConfig' :: SourceFlowConfig -> ConnectorType
connectorType} -> ConnectorType
connectorType) (\s :: SourceFlowConfig
s@SourceFlowConfig' {} ConnectorType
a -> SourceFlowConfig
s {$sel:connectorType:SourceFlowConfig' :: ConnectorType
connectorType = ConnectorType
a} :: SourceFlowConfig)

-- | Specifies the information that is required to query a particular source
-- connector.
sourceFlowConfig_sourceConnectorProperties :: Lens.Lens' SourceFlowConfig SourceConnectorProperties
sourceFlowConfig_sourceConnectorProperties :: (SourceConnectorProperties -> f SourceConnectorProperties)
-> SourceFlowConfig -> f SourceFlowConfig
sourceFlowConfig_sourceConnectorProperties = (SourceFlowConfig -> SourceConnectorProperties)
-> (SourceFlowConfig
    -> SourceConnectorProperties -> SourceFlowConfig)
-> Lens
     SourceFlowConfig
     SourceFlowConfig
     SourceConnectorProperties
     SourceConnectorProperties
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\SourceFlowConfig' {SourceConnectorProperties
sourceConnectorProperties :: SourceConnectorProperties
$sel:sourceConnectorProperties:SourceFlowConfig' :: SourceFlowConfig -> SourceConnectorProperties
sourceConnectorProperties} -> SourceConnectorProperties
sourceConnectorProperties) (\s :: SourceFlowConfig
s@SourceFlowConfig' {} SourceConnectorProperties
a -> SourceFlowConfig
s {$sel:sourceConnectorProperties:SourceFlowConfig' :: SourceConnectorProperties
sourceConnectorProperties = SourceConnectorProperties
a} :: SourceFlowConfig)

instance Core.FromJSON SourceFlowConfig where
  parseJSON :: Value -> Parser SourceFlowConfig
parseJSON =
    String
-> (Object -> Parser SourceFlowConfig)
-> Value
-> Parser SourceFlowConfig
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Core.withObject
      String
"SourceFlowConfig"
      ( \Object
x ->
          Maybe Text
-> Maybe IncrementalPullConfig
-> ConnectorType
-> SourceConnectorProperties
-> SourceFlowConfig
SourceFlowConfig'
            (Maybe Text
 -> Maybe IncrementalPullConfig
 -> ConnectorType
 -> SourceConnectorProperties
 -> SourceFlowConfig)
-> Parser (Maybe Text)
-> Parser
     (Maybe IncrementalPullConfig
      -> ConnectorType -> SourceConnectorProperties -> SourceFlowConfig)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Parser (Maybe Text)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"connectorProfileName")
            Parser
  (Maybe IncrementalPullConfig
   -> ConnectorType -> SourceConnectorProperties -> SourceFlowConfig)
-> Parser (Maybe IncrementalPullConfig)
-> Parser
     (ConnectorType -> SourceConnectorProperties -> SourceFlowConfig)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe IncrementalPullConfig)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"incrementalPullConfig")
            Parser
  (ConnectorType -> SourceConnectorProperties -> SourceFlowConfig)
-> Parser ConnectorType
-> Parser (SourceConnectorProperties -> SourceFlowConfig)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser ConnectorType
forall a. FromJSON a => Object -> Text -> Parser a
Core..: Text
"connectorType")
            Parser (SourceConnectorProperties -> SourceFlowConfig)
-> Parser SourceConnectorProperties -> Parser SourceFlowConfig
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser SourceConnectorProperties
forall a. FromJSON a => Object -> Text -> Parser a
Core..: Text
"sourceConnectorProperties")
      )

instance Prelude.Hashable SourceFlowConfig

instance Prelude.NFData SourceFlowConfig

instance Core.ToJSON SourceFlowConfig where
  toJSON :: SourceFlowConfig -> Value
toJSON SourceFlowConfig' {Maybe Text
Maybe IncrementalPullConfig
ConnectorType
SourceConnectorProperties
sourceConnectorProperties :: SourceConnectorProperties
connectorType :: ConnectorType
incrementalPullConfig :: Maybe IncrementalPullConfig
connectorProfileName :: Maybe Text
$sel:sourceConnectorProperties:SourceFlowConfig' :: SourceFlowConfig -> SourceConnectorProperties
$sel:connectorType:SourceFlowConfig' :: SourceFlowConfig -> ConnectorType
$sel:incrementalPullConfig:SourceFlowConfig' :: SourceFlowConfig -> Maybe IncrementalPullConfig
$sel:connectorProfileName:SourceFlowConfig' :: SourceFlowConfig -> Maybe Text
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"connectorProfileName" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=)
              (Text -> Pair) -> Maybe Text -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
connectorProfileName,
            (Text
"incrementalPullConfig" Text -> IncrementalPullConfig -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=)
              (IncrementalPullConfig -> Pair)
-> Maybe IncrementalPullConfig -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe IncrementalPullConfig
incrementalPullConfig,
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"connectorType" Text -> ConnectorType -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= ConnectorType
connectorType),
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just
              ( Text
"sourceConnectorProperties"
                  Text -> SourceConnectorProperties -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= SourceConnectorProperties
sourceConnectorProperties
              )
          ]
      )