{-# 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.DataBrew.Types.JobSample
-- 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.DataBrew.Types.JobSample where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.DataBrew.Types.SampleMode
import qualified Amazonka.Prelude as Prelude

-- | A sample configuration for profile jobs only, which determines the
-- number of rows on which the profile job is run. If a @JobSample@ value
-- isn\'t provided, the default is used. The default value is CUSTOM_ROWS
-- for the mode parameter and 20,000 for the size parameter.
--
-- /See:/ 'newJobSample' smart constructor.
data JobSample = JobSample'
  { -- | A value that determines whether the profile job is run on the entire
    -- dataset or a specified number of rows. This value must be one of the
    -- following:
    --
    -- -   FULL_DATASET - The profile job is run on the entire dataset.
    --
    -- -   CUSTOM_ROWS - The profile job is run on the number of rows specified
    --     in the @Size@ parameter.
    JobSample -> Maybe SampleMode
mode :: Prelude.Maybe SampleMode,
    -- | The @Size@ parameter is only required when the mode is CUSTOM_ROWS. The
    -- profile job is run on the specified number of rows. The maximum value
    -- for size is Long.MAX_VALUE.
    --
    -- Long.MAX_VALUE = 9223372036854775807
    JobSample -> Maybe Integer
size :: Prelude.Maybe Prelude.Integer
  }
  deriving (JobSample -> JobSample -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: JobSample -> JobSample -> Bool
$c/= :: JobSample -> JobSample -> Bool
== :: JobSample -> JobSample -> Bool
$c== :: JobSample -> JobSample -> Bool
Prelude.Eq, ReadPrec [JobSample]
ReadPrec JobSample
Int -> ReadS JobSample
ReadS [JobSample]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [JobSample]
$creadListPrec :: ReadPrec [JobSample]
readPrec :: ReadPrec JobSample
$creadPrec :: ReadPrec JobSample
readList :: ReadS [JobSample]
$creadList :: ReadS [JobSample]
readsPrec :: Int -> ReadS JobSample
$creadsPrec :: Int -> ReadS JobSample
Prelude.Read, Int -> JobSample -> ShowS
[JobSample] -> ShowS
JobSample -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [JobSample] -> ShowS
$cshowList :: [JobSample] -> ShowS
show :: JobSample -> String
$cshow :: JobSample -> String
showsPrec :: Int -> JobSample -> ShowS
$cshowsPrec :: Int -> JobSample -> ShowS
Prelude.Show, forall x. Rep JobSample x -> JobSample
forall x. JobSample -> Rep JobSample x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep JobSample x -> JobSample
$cfrom :: forall x. JobSample -> Rep JobSample x
Prelude.Generic)

-- |
-- Create a value of 'JobSample' 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:
--
-- 'mode', 'jobSample_mode' - A value that determines whether the profile job is run on the entire
-- dataset or a specified number of rows. This value must be one of the
-- following:
--
-- -   FULL_DATASET - The profile job is run on the entire dataset.
--
-- -   CUSTOM_ROWS - The profile job is run on the number of rows specified
--     in the @Size@ parameter.
--
-- 'size', 'jobSample_size' - The @Size@ parameter is only required when the mode is CUSTOM_ROWS. The
-- profile job is run on the specified number of rows. The maximum value
-- for size is Long.MAX_VALUE.
--
-- Long.MAX_VALUE = 9223372036854775807
newJobSample ::
  JobSample
newJobSample :: JobSample
newJobSample =
  JobSample'
    { $sel:mode:JobSample' :: Maybe SampleMode
mode = forall a. Maybe a
Prelude.Nothing,
      $sel:size:JobSample' :: Maybe Integer
size = forall a. Maybe a
Prelude.Nothing
    }

-- | A value that determines whether the profile job is run on the entire
-- dataset or a specified number of rows. This value must be one of the
-- following:
--
-- -   FULL_DATASET - The profile job is run on the entire dataset.
--
-- -   CUSTOM_ROWS - The profile job is run on the number of rows specified
--     in the @Size@ parameter.
jobSample_mode :: Lens.Lens' JobSample (Prelude.Maybe SampleMode)
jobSample_mode :: Lens' JobSample (Maybe SampleMode)
jobSample_mode = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\JobSample' {Maybe SampleMode
mode :: Maybe SampleMode
$sel:mode:JobSample' :: JobSample -> Maybe SampleMode
mode} -> Maybe SampleMode
mode) (\s :: JobSample
s@JobSample' {} Maybe SampleMode
a -> JobSample
s {$sel:mode:JobSample' :: Maybe SampleMode
mode = Maybe SampleMode
a} :: JobSample)

-- | The @Size@ parameter is only required when the mode is CUSTOM_ROWS. The
-- profile job is run on the specified number of rows. The maximum value
-- for size is Long.MAX_VALUE.
--
-- Long.MAX_VALUE = 9223372036854775807
jobSample_size :: Lens.Lens' JobSample (Prelude.Maybe Prelude.Integer)
jobSample_size :: Lens' JobSample (Maybe Integer)
jobSample_size = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\JobSample' {Maybe Integer
size :: Maybe Integer
$sel:size:JobSample' :: JobSample -> Maybe Integer
size} -> Maybe Integer
size) (\s :: JobSample
s@JobSample' {} Maybe Integer
a -> JobSample
s {$sel:size:JobSample' :: Maybe Integer
size = Maybe Integer
a} :: JobSample)

instance Data.FromJSON JobSample where
  parseJSON :: Value -> Parser JobSample
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"JobSample"
      ( \Object
x ->
          Maybe SampleMode -> Maybe Integer -> JobSample
JobSample'
            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
"Mode")
            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
"Size")
      )

instance Prelude.Hashable JobSample where
  hashWithSalt :: Int -> JobSample -> Int
hashWithSalt Int
_salt JobSample' {Maybe Integer
Maybe SampleMode
size :: Maybe Integer
mode :: Maybe SampleMode
$sel:size:JobSample' :: JobSample -> Maybe Integer
$sel:mode:JobSample' :: JobSample -> Maybe SampleMode
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe SampleMode
mode
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Integer
size

instance Prelude.NFData JobSample where
  rnf :: JobSample -> ()
rnf JobSample' {Maybe Integer
Maybe SampleMode
size :: Maybe Integer
mode :: Maybe SampleMode
$sel:size:JobSample' :: JobSample -> Maybe Integer
$sel:mode:JobSample' :: JobSample -> Maybe SampleMode
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe SampleMode
mode seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Integer
size

instance Data.ToJSON JobSample where
  toJSON :: JobSample -> Value
toJSON JobSample' {Maybe Integer
Maybe SampleMode
size :: Maybe Integer
mode :: Maybe SampleMode
$sel:size:JobSample' :: JobSample -> Maybe Integer
$sel:mode:JobSample' :: JobSample -> Maybe SampleMode
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"Mode" 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 SampleMode
mode,
            (Key
"Size" 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 Integer
size
          ]
      )