Amazonka.CodeArtifact.Types.PackageDescription

Documentation

data PackageDescription

Details about a package.

See: newPackageDescription smart constructor.

Constructors

PackageDescription'

Fields

• format :: Maybe PackageFormat

  A format that specifies the type of the package.

• name :: Maybe Text

  The name of the package.

• namespace :: Maybe 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.
• originConfiguration :: Maybe PackageOriginConfiguration

  The package origin configuration for the package.

Instances

FromJSON PackageDescription

Defined in Amazonka.CodeArtifact.Types.PackageDescription

Methods

parseJSON :: Value -> Parser PackageDescription

parseJSONList :: Value -> Parser [PackageDescription]

Generic PackageDescription

Defined in Amazonka.CodeArtifact.Types.PackageDescription

Associated Types

type Rep PackageDescription :: Type -> Type

Methods

from :: PackageDescription -> Rep PackageDescription x

to :: Rep PackageDescription x -> PackageDescription

Read PackageDescription

Defined in Amazonka.CodeArtifact.Types.PackageDescription

Methods

readsPrec :: Int -> ReadS PackageDescription

readList :: ReadS [PackageDescription]

readPrec :: ReadPrec PackageDescription

readListPrec :: ReadPrec [PackageDescription]

Show PackageDescription

Defined in Amazonka.CodeArtifact.Types.PackageDescription

Methods

showsPrec :: Int -> PackageDescription -> ShowS

show :: PackageDescription -> String

showList :: [PackageDescription] -> ShowS

NFData PackageDescription

Defined in Amazonka.CodeArtifact.Types.PackageDescription

Methods

rnf :: PackageDescription -> ()

Eq PackageDescription

Defined in Amazonka.CodeArtifact.Types.PackageDescription

Methods

(==) :: PackageDescription -> PackageDescription -> Bool

(/=) :: PackageDescription -> PackageDescription -> Bool

Hashable PackageDescription

Defined in Amazonka.CodeArtifact.Types.PackageDescription

Methods

hashWithSalt :: Int -> PackageDescription -> Int

hash :: PackageDescription -> Int

type Rep PackageDescription

Defined in Amazonka.CodeArtifact.Types.PackageDescription

type Rep PackageDescription = D1 ('MetaData "PackageDescription" "Amazonka.CodeArtifact.Types.PackageDescription" "amazonka-codeartifact-2.0-CskMABZQLQJDgej73fXQxp" 'False) (C1 ('MetaCons "PackageDescription'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PackageFormat)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "originConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PackageOriginConfiguration)))))

newPackageDescription :: PackageDescription

Create a value of PackageDescription with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:format:PackageDescription', packageDescription_format - A format that specifies the type of the package.

$sel:name:PackageDescription', packageDescription_name - The name of the package.

$sel:namespace:PackageDescription', 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.

$sel:originConfiguration:PackageDescription', packageDescription_originConfiguration - The package origin configuration for the package.

packageDescription_format :: Lens' PackageDescription (Maybe PackageFormat)

A format that specifies the type of the package.

packageDescription_name :: Lens' PackageDescription (Maybe Text)

The name of the package.

packageDescription_namespace :: Lens' PackageDescription (Maybe 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_originConfiguration :: Lens' PackageDescription (Maybe PackageOriginConfiguration)

The package origin configuration for the package.