{-# 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.CodeArtifact.Types.PackageDescription
-- 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.CodeArtifact.Types.PackageDescription where

import Amazonka.CodeArtifact.Types.PackageFormat
import Amazonka.CodeArtifact.Types.PackageOriginConfiguration
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

-- | Details about a package.
--
-- /See:/ 'newPackageDescription' smart constructor.
data PackageDescription = PackageDescription'
  { -- | A format that specifies the type of the package.
    PackageDescription -> Maybe PackageFormat
format :: Prelude.Maybe PackageFormat,
    -- | The name of the package.
    PackageDescription -> Maybe Text
name :: Prelude.Maybe Prelude.Text,
    -- | The namespace of the package. The package component that specifies its
    -- namespace depends on its type. For example:
    --
    -- -   The namespace of a Maven package is its @groupId@.
    --
    -- -   The namespace of an npm package is its @scope@.
    --
    -- -   Python and NuGet packages do not contain a corresponding component,
    --     packages of those formats do not have a namespace.
    PackageDescription -> Maybe Text
namespace :: Prelude.Maybe Prelude.Text,
    -- | The package origin configuration for the package.
    PackageDescription -> Maybe PackageOriginConfiguration
originConfiguration :: Prelude.Maybe PackageOriginConfiguration
  }
  deriving (PackageDescription -> PackageDescription -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: PackageDescription -> PackageDescription -> Bool
$c/= :: PackageDescription -> PackageDescription -> Bool
== :: PackageDescription -> PackageDescription -> Bool
$c== :: PackageDescription -> PackageDescription -> Bool
Prelude.Eq, ReadPrec [PackageDescription]
ReadPrec PackageDescription
Int -> ReadS PackageDescription
ReadS [PackageDescription]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [PackageDescription]
$creadListPrec :: ReadPrec [PackageDescription]
readPrec :: ReadPrec PackageDescription
$creadPrec :: ReadPrec PackageDescription
readList :: ReadS [PackageDescription]
$creadList :: ReadS [PackageDescription]
readsPrec :: Int -> ReadS PackageDescription
$creadsPrec :: Int -> ReadS PackageDescription
Prelude.Read, Int -> PackageDescription -> ShowS
[PackageDescription] -> ShowS
PackageDescription -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PackageDescription] -> ShowS
$cshowList :: [PackageDescription] -> ShowS
show :: PackageDescription -> String
$cshow :: PackageDescription -> String
showsPrec :: Int -> PackageDescription -> ShowS
$cshowsPrec :: Int -> PackageDescription -> ShowS
Prelude.Show, forall x. Rep PackageDescription x -> PackageDescription
forall x. PackageDescription -> Rep PackageDescription x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep PackageDescription x -> PackageDescription
$cfrom :: forall x. PackageDescription -> Rep PackageDescription x
Prelude.Generic)

-- |
-- Create a value of 'PackageDescription' 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', 'packageDescription_format' - A format that specifies the type of the package.
--
-- 'name', 'packageDescription_name' - The name of the package.
--
-- 'namespace', 'packageDescription_namespace' - The namespace of the package. The package component that specifies its
-- namespace depends on its type. For example:
--
-- -   The namespace of a Maven package is its @groupId@.
--
-- -   The namespace of an npm package is its @scope@.
--
-- -   Python and NuGet packages do not contain a corresponding component,
--     packages of those formats do not have a namespace.
--
-- 'originConfiguration', 'packageDescription_originConfiguration' - The package origin configuration for the package.
newPackageDescription ::
  PackageDescription
newPackageDescription :: PackageDescription
newPackageDescription =
  PackageDescription'
    { $sel:format:PackageDescription' :: Maybe PackageFormat
format = forall a. Maybe a
Prelude.Nothing,
      $sel:name:PackageDescription' :: Maybe Text
name = forall a. Maybe a
Prelude.Nothing,
      $sel:namespace:PackageDescription' :: Maybe Text
namespace = forall a. Maybe a
Prelude.Nothing,
      $sel:originConfiguration:PackageDescription' :: Maybe PackageOriginConfiguration
originConfiguration = forall a. Maybe a
Prelude.Nothing
    }

-- | A format that specifies the type of the package.
packageDescription_format :: Lens.Lens' PackageDescription (Prelude.Maybe PackageFormat)
packageDescription_format :: Lens' PackageDescription (Maybe PackageFormat)
packageDescription_format = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PackageDescription' {Maybe PackageFormat
format :: Maybe PackageFormat
$sel:format:PackageDescription' :: PackageDescription -> Maybe PackageFormat
format} -> Maybe PackageFormat
format) (\s :: PackageDescription
s@PackageDescription' {} Maybe PackageFormat
a -> PackageDescription
s {$sel:format:PackageDescription' :: Maybe PackageFormat
format = Maybe PackageFormat
a} :: PackageDescription)

-- | The name of the package.
packageDescription_name :: Lens.Lens' PackageDescription (Prelude.Maybe Prelude.Text)
packageDescription_name :: Lens' PackageDescription (Maybe Text)
packageDescription_name = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PackageDescription' {Maybe Text
name :: Maybe Text
$sel:name:PackageDescription' :: PackageDescription -> Maybe Text
name} -> Maybe Text
name) (\s :: PackageDescription
s@PackageDescription' {} Maybe Text
a -> PackageDescription
s {$sel:name:PackageDescription' :: Maybe Text
name = Maybe Text
a} :: PackageDescription)

-- | The namespace of the package. The package component that specifies its
-- namespace depends on its type. For example:
--
-- -   The namespace of a Maven package is its @groupId@.
--
-- -   The namespace of an npm package is its @scope@.
--
-- -   Python and NuGet packages do not contain a corresponding component,
--     packages of those formats do not have a namespace.
packageDescription_namespace :: Lens.Lens' PackageDescription (Prelude.Maybe Prelude.Text)
packageDescription_namespace :: Lens' PackageDescription (Maybe Text)
packageDescription_namespace = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PackageDescription' {Maybe Text
namespace :: Maybe Text
$sel:namespace:PackageDescription' :: PackageDescription -> Maybe Text
namespace} -> Maybe Text
namespace) (\s :: PackageDescription
s@PackageDescription' {} Maybe Text
a -> PackageDescription
s {$sel:namespace:PackageDescription' :: Maybe Text
namespace = Maybe Text
a} :: PackageDescription)

-- | The package origin configuration for the package.
packageDescription_originConfiguration :: Lens.Lens' PackageDescription (Prelude.Maybe PackageOriginConfiguration)
packageDescription_originConfiguration :: Lens' PackageDescription (Maybe PackageOriginConfiguration)
packageDescription_originConfiguration = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\PackageDescription' {Maybe PackageOriginConfiguration
originConfiguration :: Maybe PackageOriginConfiguration
$sel:originConfiguration:PackageDescription' :: PackageDescription -> Maybe PackageOriginConfiguration
originConfiguration} -> Maybe PackageOriginConfiguration
originConfiguration) (\s :: PackageDescription
s@PackageDescription' {} Maybe PackageOriginConfiguration
a -> PackageDescription
s {$sel:originConfiguration:PackageDescription' :: Maybe PackageOriginConfiguration
originConfiguration = Maybe PackageOriginConfiguration
a} :: PackageDescription)

instance Data.FromJSON PackageDescription where
  parseJSON :: Value -> Parser PackageDescription
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"PackageDescription"
      ( \Object
x ->
          Maybe PackageFormat
-> Maybe Text
-> Maybe Text
-> Maybe PackageOriginConfiguration
-> PackageDescription
PackageDescription'
            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
"name")
            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
"namespace")
            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
"originConfiguration")
      )

instance Prelude.Hashable PackageDescription where
  hashWithSalt :: Int -> PackageDescription -> Int
hashWithSalt Int
_salt PackageDescription' {Maybe Text
Maybe PackageFormat
Maybe PackageOriginConfiguration
originConfiguration :: Maybe PackageOriginConfiguration
namespace :: Maybe Text
name :: Maybe Text
format :: Maybe PackageFormat
$sel:originConfiguration:PackageDescription' :: PackageDescription -> Maybe PackageOriginConfiguration
$sel:namespace:PackageDescription' :: PackageDescription -> Maybe Text
$sel:name:PackageDescription' :: PackageDescription -> Maybe Text
$sel:format:PackageDescription' :: PackageDescription -> Maybe PackageFormat
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe PackageFormat
format
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
name
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
namespace
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe PackageOriginConfiguration
originConfiguration

instance Prelude.NFData PackageDescription where
  rnf :: PackageDescription -> ()
rnf PackageDescription' {Maybe Text
Maybe PackageFormat
Maybe PackageOriginConfiguration
originConfiguration :: Maybe PackageOriginConfiguration
namespace :: Maybe Text
name :: Maybe Text
format :: Maybe PackageFormat
$sel:originConfiguration:PackageDescription' :: PackageDescription -> Maybe PackageOriginConfiguration
$sel:namespace:PackageDescription' :: PackageDescription -> Maybe Text
$sel:name:PackageDescription' :: PackageDescription -> Maybe Text
$sel:format:PackageDescription' :: PackageDescription -> Maybe PackageFormat
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe PackageFormat
format
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
name
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
namespace
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe PackageOriginConfiguration
originConfiguration