You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CodeArtifact::Types::PackageVersionDescription

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Details about a package version.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#display_name ⇒ String

The name of the package that is displayed. The displayName varies depending on the package version\'s format. For example, if an npm package is named ui, is in the namespace vue, and has the format npm, then the displayName is @vue/ui.

Returns:

  • (String) —

    The name of the package that is displayed.

#format ⇒ String

The format of the package version. The valid package formats are:

  • npm: A Node Package Manager (npm) package.

  • pypi: A Python Package Index (PyPI) package.

  • maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

    Possible values:

    • npm
    • pypi
    • maven

Returns:

  • (String) —

    The format of the package version.

#home_page ⇒ String

The homepage associated with the package.

Returns:

  • (String) —

    The homepage associated with the package.

#licenses ⇒ Array<Types::LicenseInfo>

Information about licenses associated with the package version.

Returns:

  • (Array<Types::LicenseInfo>) —

    Information about licenses associated with the package version.

#namespace ⇒ String

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.

  • A Python package does not contain a corresponding component, so Python packages do not have a namespace.

Returns:

  • (String) —

    The namespace of the package.

#package_name ⇒ String

The name of the requested package.

Returns:

  • (String) —

    The name of the requested package.

#published_time ⇒ Time

A timestamp that contains the date and time the package version was published.

Returns:

  • (Time) —

    A timestamp that contains the date and time the package version was published.

#revision ⇒ String

The revision of the package version.

Returns:

  • (String) —

    The revision of the package version.

#source_code_repository ⇒ String

The repository for the source code in the package version, or the source code used to build it.

Returns:

  • (String) —

    The repository for the source code in the package version, or the source code used to build it.

#status ⇒ String

A string that contains the status of the package version. It can be one of the following:

  • Published

  • Unfinished

  • Unlisted

  • Archived

  • Disposed

    Possible values:

    • Published
    • Unfinished
    • Unlisted
    • Archived
    • Disposed
    • Deleted

Returns:

  • (String) —

    A string that contains the status of the package version.

#summary ⇒ String

A summary of the package version. The summary is extracted from the package. The information in and detail level of the summary depends on the package version\'s format.

Returns:

  • (String) —

    A summary of the package version.

#version ⇒ String

The version of the package.

Returns:

  • (String) —

    The version of the package.