{-# 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.Batch.Types.NodeOverrides
-- 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.Batch.Types.NodeOverrides where

import Amazonka.Batch.Types.NodePropertyOverride
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

-- | An object that represents any node overrides to a job definition that\'s
-- used in a SubmitJob API operation.
--
-- This parameter isn\'t applicable to jobs that are running on Fargate
-- resources. Don\'t provide it for these jobs. Rather, use
-- @containerOverrides@ instead.
--
-- /See:/ 'newNodeOverrides' smart constructor.
data NodeOverrides = NodeOverrides'
  { -- | The node property overrides for the job.
    NodeOverrides -> Maybe [NodePropertyOverride]
nodePropertyOverrides :: Prelude.Maybe [NodePropertyOverride],
    -- | The number of nodes to use with a multi-node parallel job. This value
    -- overrides the number of nodes that are specified in the job definition.
    -- To use this override, you must meet the following conditions:
    --
    -- -   There must be at least one node range in your job definition that
    --     has an open upper boundary, such as @:@ or @n:@.
    --
    -- -   The lower boundary of the node range that\'s specified in the job
    --     definition must be fewer than the number of nodes specified in the
    --     override.
    --
    -- -   The main node index that\'s specified in the job definition must be
    --     fewer than the number of nodes specified in the override.
    NodeOverrides -> Maybe Int
numNodes :: Prelude.Maybe Prelude.Int
  }
  deriving (NodeOverrides -> NodeOverrides -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: NodeOverrides -> NodeOverrides -> Bool
$c/= :: NodeOverrides -> NodeOverrides -> Bool
== :: NodeOverrides -> NodeOverrides -> Bool
$c== :: NodeOverrides -> NodeOverrides -> Bool
Prelude.Eq, ReadPrec [NodeOverrides]
ReadPrec NodeOverrides
Int -> ReadS NodeOverrides
ReadS [NodeOverrides]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [NodeOverrides]
$creadListPrec :: ReadPrec [NodeOverrides]
readPrec :: ReadPrec NodeOverrides
$creadPrec :: ReadPrec NodeOverrides
readList :: ReadS [NodeOverrides]
$creadList :: ReadS [NodeOverrides]
readsPrec :: Int -> ReadS NodeOverrides
$creadsPrec :: Int -> ReadS NodeOverrides
Prelude.Read, Int -> NodeOverrides -> ShowS
[NodeOverrides] -> ShowS
NodeOverrides -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [NodeOverrides] -> ShowS
$cshowList :: [NodeOverrides] -> ShowS
show :: NodeOverrides -> String
$cshow :: NodeOverrides -> String
showsPrec :: Int -> NodeOverrides -> ShowS
$cshowsPrec :: Int -> NodeOverrides -> ShowS
Prelude.Show, forall x. Rep NodeOverrides x -> NodeOverrides
forall x. NodeOverrides -> Rep NodeOverrides x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep NodeOverrides x -> NodeOverrides
$cfrom :: forall x. NodeOverrides -> Rep NodeOverrides x
Prelude.Generic)

-- |
-- Create a value of 'NodeOverrides' 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:
--
-- 'nodePropertyOverrides', 'nodeOverrides_nodePropertyOverrides' - The node property overrides for the job.
--
-- 'numNodes', 'nodeOverrides_numNodes' - The number of nodes to use with a multi-node parallel job. This value
-- overrides the number of nodes that are specified in the job definition.
-- To use this override, you must meet the following conditions:
--
-- -   There must be at least one node range in your job definition that
--     has an open upper boundary, such as @:@ or @n:@.
--
-- -   The lower boundary of the node range that\'s specified in the job
--     definition must be fewer than the number of nodes specified in the
--     override.
--
-- -   The main node index that\'s specified in the job definition must be
--     fewer than the number of nodes specified in the override.
newNodeOverrides ::
  NodeOverrides
newNodeOverrides :: NodeOverrides
newNodeOverrides =
  NodeOverrides'
    { $sel:nodePropertyOverrides:NodeOverrides' :: Maybe [NodePropertyOverride]
nodePropertyOverrides =
        forall a. Maybe a
Prelude.Nothing,
      $sel:numNodes:NodeOverrides' :: Maybe Int
numNodes = forall a. Maybe a
Prelude.Nothing
    }

-- | The node property overrides for the job.
nodeOverrides_nodePropertyOverrides :: Lens.Lens' NodeOverrides (Prelude.Maybe [NodePropertyOverride])
nodeOverrides_nodePropertyOverrides :: Lens' NodeOverrides (Maybe [NodePropertyOverride])
nodeOverrides_nodePropertyOverrides = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\NodeOverrides' {Maybe [NodePropertyOverride]
nodePropertyOverrides :: Maybe [NodePropertyOverride]
$sel:nodePropertyOverrides:NodeOverrides' :: NodeOverrides -> Maybe [NodePropertyOverride]
nodePropertyOverrides} -> Maybe [NodePropertyOverride]
nodePropertyOverrides) (\s :: NodeOverrides
s@NodeOverrides' {} Maybe [NodePropertyOverride]
a -> NodeOverrides
s {$sel:nodePropertyOverrides:NodeOverrides' :: Maybe [NodePropertyOverride]
nodePropertyOverrides = Maybe [NodePropertyOverride]
a} :: NodeOverrides) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The number of nodes to use with a multi-node parallel job. This value
-- overrides the number of nodes that are specified in the job definition.
-- To use this override, you must meet the following conditions:
--
-- -   There must be at least one node range in your job definition that
--     has an open upper boundary, such as @:@ or @n:@.
--
-- -   The lower boundary of the node range that\'s specified in the job
--     definition must be fewer than the number of nodes specified in the
--     override.
--
-- -   The main node index that\'s specified in the job definition must be
--     fewer than the number of nodes specified in the override.
nodeOverrides_numNodes :: Lens.Lens' NodeOverrides (Prelude.Maybe Prelude.Int)
nodeOverrides_numNodes :: Lens' NodeOverrides (Maybe Int)
nodeOverrides_numNodes = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\NodeOverrides' {Maybe Int
numNodes :: Maybe Int
$sel:numNodes:NodeOverrides' :: NodeOverrides -> Maybe Int
numNodes} -> Maybe Int
numNodes) (\s :: NodeOverrides
s@NodeOverrides' {} Maybe Int
a -> NodeOverrides
s {$sel:numNodes:NodeOverrides' :: Maybe Int
numNodes = Maybe Int
a} :: NodeOverrides)

instance Prelude.Hashable NodeOverrides where
  hashWithSalt :: Int -> NodeOverrides -> Int
hashWithSalt Int
_salt NodeOverrides' {Maybe Int
Maybe [NodePropertyOverride]
numNodes :: Maybe Int
nodePropertyOverrides :: Maybe [NodePropertyOverride]
$sel:numNodes:NodeOverrides' :: NodeOverrides -> Maybe Int
$sel:nodePropertyOverrides:NodeOverrides' :: NodeOverrides -> Maybe [NodePropertyOverride]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [NodePropertyOverride]
nodePropertyOverrides
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
numNodes

instance Prelude.NFData NodeOverrides where
  rnf :: NodeOverrides -> ()
rnf NodeOverrides' {Maybe Int
Maybe [NodePropertyOverride]
numNodes :: Maybe Int
nodePropertyOverrides :: Maybe [NodePropertyOverride]
$sel:numNodes:NodeOverrides' :: NodeOverrides -> Maybe Int
$sel:nodePropertyOverrides:NodeOverrides' :: NodeOverrides -> Maybe [NodePropertyOverride]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [NodePropertyOverride]
nodePropertyOverrides
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
numNodes

instance Data.ToJSON NodeOverrides where
  toJSON :: NodeOverrides -> Value
toJSON NodeOverrides' {Maybe Int
Maybe [NodePropertyOverride]
numNodes :: Maybe Int
nodePropertyOverrides :: Maybe [NodePropertyOverride]
$sel:numNodes:NodeOverrides' :: NodeOverrides -> Maybe Int
$sel:nodePropertyOverrides:NodeOverrides' :: NodeOverrides -> Maybe [NodePropertyOverride]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"nodePropertyOverrides" 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 [NodePropertyOverride]
nodePropertyOverrides,
            (Key
"numNodes" 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 Int
numNodes
          ]
      )