{-# 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.Forecast.Types.TimeSeriesReplacementsDataSource
-- 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.Forecast.Types.TimeSeriesReplacementsDataSource where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Forecast.Types.S3Config
import Amazonka.Forecast.Types.Schema
import qualified Amazonka.Prelude as Prelude

-- | A replacement dataset is a modified version of the baseline related time
-- series that contains only the values that you want to include in a
-- what-if forecast. The replacement dataset must contain the forecast
-- dimensions and item identifiers in the baseline related time series as
-- well as at least 1 changed time series. This dataset is merged with the
-- baseline related time series to create a transformed dataset that is
-- used for the what-if forecast.
--
-- /See:/ 'newTimeSeriesReplacementsDataSource' smart constructor.
data TimeSeriesReplacementsDataSource = TimeSeriesReplacementsDataSource'
  { -- | The format of the replacement data, CSV or PARQUET.
    TimeSeriesReplacementsDataSource -> Maybe Text
format :: Prelude.Maybe Prelude.Text,
    -- | The timestamp format of the replacement data.
    TimeSeriesReplacementsDataSource -> Maybe Text
timestampFormat :: Prelude.Maybe Prelude.Text,
    TimeSeriesReplacementsDataSource -> S3Config
s3Config :: S3Config,
    TimeSeriesReplacementsDataSource -> Schema
schema :: Schema
  }
  deriving (TimeSeriesReplacementsDataSource
-> TimeSeriesReplacementsDataSource -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: TimeSeriesReplacementsDataSource
-> TimeSeriesReplacementsDataSource -> Bool
$c/= :: TimeSeriesReplacementsDataSource
-> TimeSeriesReplacementsDataSource -> Bool
== :: TimeSeriesReplacementsDataSource
-> TimeSeriesReplacementsDataSource -> Bool
$c== :: TimeSeriesReplacementsDataSource
-> TimeSeriesReplacementsDataSource -> Bool
Prelude.Eq, ReadPrec [TimeSeriesReplacementsDataSource]
ReadPrec TimeSeriesReplacementsDataSource
Int -> ReadS TimeSeriesReplacementsDataSource
ReadS [TimeSeriesReplacementsDataSource]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [TimeSeriesReplacementsDataSource]
$creadListPrec :: ReadPrec [TimeSeriesReplacementsDataSource]
readPrec :: ReadPrec TimeSeriesReplacementsDataSource
$creadPrec :: ReadPrec TimeSeriesReplacementsDataSource
readList :: ReadS [TimeSeriesReplacementsDataSource]
$creadList :: ReadS [TimeSeriesReplacementsDataSource]
readsPrec :: Int -> ReadS TimeSeriesReplacementsDataSource
$creadsPrec :: Int -> ReadS TimeSeriesReplacementsDataSource
Prelude.Read, Int -> TimeSeriesReplacementsDataSource -> ShowS
[TimeSeriesReplacementsDataSource] -> ShowS
TimeSeriesReplacementsDataSource -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [TimeSeriesReplacementsDataSource] -> ShowS
$cshowList :: [TimeSeriesReplacementsDataSource] -> ShowS
show :: TimeSeriesReplacementsDataSource -> String
$cshow :: TimeSeriesReplacementsDataSource -> String
showsPrec :: Int -> TimeSeriesReplacementsDataSource -> ShowS
$cshowsPrec :: Int -> TimeSeriesReplacementsDataSource -> ShowS
Prelude.Show, forall x.
Rep TimeSeriesReplacementsDataSource x
-> TimeSeriesReplacementsDataSource
forall x.
TimeSeriesReplacementsDataSource
-> Rep TimeSeriesReplacementsDataSource x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep TimeSeriesReplacementsDataSource x
-> TimeSeriesReplacementsDataSource
$cfrom :: forall x.
TimeSeriesReplacementsDataSource
-> Rep TimeSeriesReplacementsDataSource x
Prelude.Generic)

-- |
-- Create a value of 'TimeSeriesReplacementsDataSource' 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:
--
-- 'format', 'timeSeriesReplacementsDataSource_format' - The format of the replacement data, CSV or PARQUET.
--
-- 'timestampFormat', 'timeSeriesReplacementsDataSource_timestampFormat' - The timestamp format of the replacement data.
--
-- 's3Config', 'timeSeriesReplacementsDataSource_s3Config' - Undocumented member.
--
-- 'schema', 'timeSeriesReplacementsDataSource_schema' - Undocumented member.
newTimeSeriesReplacementsDataSource ::
  -- | 's3Config'
  S3Config ->
  -- | 'schema'
  Schema ->
  TimeSeriesReplacementsDataSource
newTimeSeriesReplacementsDataSource :: S3Config -> Schema -> TimeSeriesReplacementsDataSource
newTimeSeriesReplacementsDataSource
  S3Config
pS3Config_
  Schema
pSchema_ =
    TimeSeriesReplacementsDataSource'
      { $sel:format:TimeSeriesReplacementsDataSource' :: Maybe Text
format =
          forall a. Maybe a
Prelude.Nothing,
        $sel:timestampFormat:TimeSeriesReplacementsDataSource' :: Maybe Text
timestampFormat = forall a. Maybe a
Prelude.Nothing,
        $sel:s3Config:TimeSeriesReplacementsDataSource' :: S3Config
s3Config = S3Config
pS3Config_,
        $sel:schema:TimeSeriesReplacementsDataSource' :: Schema
schema = Schema
pSchema_
      }

-- | The format of the replacement data, CSV or PARQUET.
timeSeriesReplacementsDataSource_format :: Lens.Lens' TimeSeriesReplacementsDataSource (Prelude.Maybe Prelude.Text)
timeSeriesReplacementsDataSource_format :: Lens' TimeSeriesReplacementsDataSource (Maybe Text)
timeSeriesReplacementsDataSource_format = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeSeriesReplacementsDataSource' {Maybe Text
format :: Maybe Text
$sel:format:TimeSeriesReplacementsDataSource' :: TimeSeriesReplacementsDataSource -> Maybe Text
format} -> Maybe Text
format) (\s :: TimeSeriesReplacementsDataSource
s@TimeSeriesReplacementsDataSource' {} Maybe Text
a -> TimeSeriesReplacementsDataSource
s {$sel:format:TimeSeriesReplacementsDataSource' :: Maybe Text
format = Maybe Text
a} :: TimeSeriesReplacementsDataSource)

-- | The timestamp format of the replacement data.
timeSeriesReplacementsDataSource_timestampFormat :: Lens.Lens' TimeSeriesReplacementsDataSource (Prelude.Maybe Prelude.Text)
timeSeriesReplacementsDataSource_timestampFormat :: Lens' TimeSeriesReplacementsDataSource (Maybe Text)
timeSeriesReplacementsDataSource_timestampFormat = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeSeriesReplacementsDataSource' {Maybe Text
timestampFormat :: Maybe Text
$sel:timestampFormat:TimeSeriesReplacementsDataSource' :: TimeSeriesReplacementsDataSource -> Maybe Text
timestampFormat} -> Maybe Text
timestampFormat) (\s :: TimeSeriesReplacementsDataSource
s@TimeSeriesReplacementsDataSource' {} Maybe Text
a -> TimeSeriesReplacementsDataSource
s {$sel:timestampFormat:TimeSeriesReplacementsDataSource' :: Maybe Text
timestampFormat = Maybe Text
a} :: TimeSeriesReplacementsDataSource)

-- | Undocumented member.
timeSeriesReplacementsDataSource_s3Config :: Lens.Lens' TimeSeriesReplacementsDataSource S3Config
timeSeriesReplacementsDataSource_s3Config :: Lens' TimeSeriesReplacementsDataSource S3Config
timeSeriesReplacementsDataSource_s3Config = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeSeriesReplacementsDataSource' {S3Config
s3Config :: S3Config
$sel:s3Config:TimeSeriesReplacementsDataSource' :: TimeSeriesReplacementsDataSource -> S3Config
s3Config} -> S3Config
s3Config) (\s :: TimeSeriesReplacementsDataSource
s@TimeSeriesReplacementsDataSource' {} S3Config
a -> TimeSeriesReplacementsDataSource
s {$sel:s3Config:TimeSeriesReplacementsDataSource' :: S3Config
s3Config = S3Config
a} :: TimeSeriesReplacementsDataSource)

-- | Undocumented member.
timeSeriesReplacementsDataSource_schema :: Lens.Lens' TimeSeriesReplacementsDataSource Schema
timeSeriesReplacementsDataSource_schema :: Lens' TimeSeriesReplacementsDataSource Schema
timeSeriesReplacementsDataSource_schema = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\TimeSeriesReplacementsDataSource' {Schema
schema :: Schema
$sel:schema:TimeSeriesReplacementsDataSource' :: TimeSeriesReplacementsDataSource -> Schema
schema} -> Schema
schema) (\s :: TimeSeriesReplacementsDataSource
s@TimeSeriesReplacementsDataSource' {} Schema
a -> TimeSeriesReplacementsDataSource
s {$sel:schema:TimeSeriesReplacementsDataSource' :: Schema
schema = Schema
a} :: TimeSeriesReplacementsDataSource)

instance
  Data.FromJSON
    TimeSeriesReplacementsDataSource
  where
  parseJSON :: Value -> Parser TimeSeriesReplacementsDataSource
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"TimeSeriesReplacementsDataSource"
      ( \Object
x ->
          Maybe Text
-> Maybe Text
-> S3Config
-> Schema
-> TimeSeriesReplacementsDataSource
TimeSeriesReplacementsDataSource'
            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
"Format")
            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
"TimestampFormat")
            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
"S3Config")
            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
"Schema")
      )

instance
  Prelude.Hashable
    TimeSeriesReplacementsDataSource
  where
  hashWithSalt :: Int -> TimeSeriesReplacementsDataSource -> Int
hashWithSalt
    Int
_salt
    TimeSeriesReplacementsDataSource' {Maybe Text
S3Config
Schema
schema :: Schema
s3Config :: S3Config
timestampFormat :: Maybe Text
format :: Maybe Text
$sel:schema:TimeSeriesReplacementsDataSource' :: TimeSeriesReplacementsDataSource -> Schema
$sel:s3Config:TimeSeriesReplacementsDataSource' :: TimeSeriesReplacementsDataSource -> S3Config
$sel:timestampFormat:TimeSeriesReplacementsDataSource' :: TimeSeriesReplacementsDataSource -> Maybe Text
$sel:format:TimeSeriesReplacementsDataSource' :: TimeSeriesReplacementsDataSource -> Maybe Text
..} =
      Int
_salt
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
format
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
timestampFormat
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` S3Config
s3Config
        forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Schema
schema

instance
  Prelude.NFData
    TimeSeriesReplacementsDataSource
  where
  rnf :: TimeSeriesReplacementsDataSource -> ()
rnf TimeSeriesReplacementsDataSource' {Maybe Text
S3Config
Schema
schema :: Schema
s3Config :: S3Config
timestampFormat :: Maybe Text
format :: Maybe Text
$sel:schema:TimeSeriesReplacementsDataSource' :: TimeSeriesReplacementsDataSource -> Schema
$sel:s3Config:TimeSeriesReplacementsDataSource' :: TimeSeriesReplacementsDataSource -> S3Config
$sel:timestampFormat:TimeSeriesReplacementsDataSource' :: TimeSeriesReplacementsDataSource -> Maybe Text
$sel:format:TimeSeriesReplacementsDataSource' :: TimeSeriesReplacementsDataSource -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
format
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
timestampFormat
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf S3Config
s3Config
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Schema
schema

instance Data.ToJSON TimeSeriesReplacementsDataSource where
  toJSON :: TimeSeriesReplacementsDataSource -> Value
toJSON TimeSeriesReplacementsDataSource' {Maybe Text
S3Config
Schema
schema :: Schema
s3Config :: S3Config
timestampFormat :: Maybe Text
format :: Maybe Text
$sel:schema:TimeSeriesReplacementsDataSource' :: TimeSeriesReplacementsDataSource -> Schema
$sel:s3Config:TimeSeriesReplacementsDataSource' :: TimeSeriesReplacementsDataSource -> S3Config
$sel:timestampFormat:TimeSeriesReplacementsDataSource' :: TimeSeriesReplacementsDataSource -> Maybe Text
$sel:format:TimeSeriesReplacementsDataSource' :: TimeSeriesReplacementsDataSource -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"Format" 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
format,
            (Key
"TimestampFormat" 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
timestampFormat,
            forall a. a -> Maybe a
Prelude.Just (Key
"S3Config" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= S3Config
s3Config),
            forall a. a -> Maybe a
Prelude.Just (Key
"Schema" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Schema
schema)
          ]
      )