Phase.hs

{-# 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.SageMaker.Types.Phase
-- 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.SageMaker.Types.Phase 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

-- | Defines the traffic pattern.
--
-- /See:/ 'newPhase' smart constructor.
data Phase = Phase'
  { -- | Specifies how long traffic phase should be.
    durationInSeconds :: Prelude.Maybe Prelude.Natural,
    -- | Specifies how many concurrent users to start with.
    initialNumberOfUsers :: Prelude.Maybe Prelude.Natural,
    -- | Specified how many new users to spawn in a minute.
    spawnRate :: Prelude.Maybe Prelude.Natural
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'Phase' 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:
--
-- 'durationInSeconds', 'phase_durationInSeconds' - Specifies how long traffic phase should be.
--
-- 'initialNumberOfUsers', 'phase_initialNumberOfUsers' - Specifies how many concurrent users to start with.
--
-- 'spawnRate', 'phase_spawnRate' - Specified how many new users to spawn in a minute.
newPhase ::
  Phase
newPhase =
  Phase'
    { durationInSeconds = Prelude.Nothing,
      initialNumberOfUsers = Prelude.Nothing,
      spawnRate = Prelude.Nothing
    }

-- | Specifies how long traffic phase should be.
phase_durationInSeconds :: Lens.Lens' Phase (Prelude.Maybe Prelude.Natural)
phase_durationInSeconds = Lens.lens (\Phase' {durationInSeconds} -> durationInSeconds) (\s@Phase' {} a -> s {durationInSeconds = a} :: Phase)

-- | Specifies how many concurrent users to start with.
phase_initialNumberOfUsers :: Lens.Lens' Phase (Prelude.Maybe Prelude.Natural)
phase_initialNumberOfUsers = Lens.lens (\Phase' {initialNumberOfUsers} -> initialNumberOfUsers) (\s@Phase' {} a -> s {initialNumberOfUsers = a} :: Phase)

-- | Specified how many new users to spawn in a minute.
phase_spawnRate :: Lens.Lens' Phase (Prelude.Maybe Prelude.Natural)
phase_spawnRate = Lens.lens (\Phase' {spawnRate} -> spawnRate) (\s@Phase' {} a -> s {spawnRate = a} :: Phase)

instance Data.FromJSON Phase where
  parseJSON =
    Data.withObject
      "Phase"
      ( \x ->
          Phase'
            Prelude.<$> (x Data..:? "DurationInSeconds")
            Prelude.<*> (x Data..:? "InitialNumberOfUsers")
            Prelude.<*> (x Data..:? "SpawnRate")
      )

instance Prelude.Hashable Phase where
  hashWithSalt _salt Phase' {..} =
    _salt
      `Prelude.hashWithSalt` durationInSeconds
      `Prelude.hashWithSalt` initialNumberOfUsers
      `Prelude.hashWithSalt` spawnRate

instance Prelude.NFData Phase where
  rnf Phase' {..} =
    Prelude.rnf durationInSeconds
      `Prelude.seq` Prelude.rnf initialNumberOfUsers
      `Prelude.seq` Prelude.rnf spawnRate

instance Data.ToJSON Phase where
  toJSON Phase' {..} =
    Data.object
      ( Prelude.catMaybes
          [ ("DurationInSeconds" Data..=)
              Prelude.<$> durationInSeconds,
            ("InitialNumberOfUsers" Data..=)
              Prelude.<$> initialNumberOfUsers,
            ("SpawnRate" Data..=) Prelude.<$> spawnRate
          ]
      )