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

Inherits:

Struct

• Object
• Struct
• Aws::CodeArtifact::Types::PackageVersionDescription

Includes:

Structure

Defined in:

lib/aws-sdk-codeartifact/types.rb

Overview

Details about a package version.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #display_name ⇒ String

  The name of the package that is displayed.

• #format ⇒ String

  The format of the package version.

• #home_page ⇒ String

  The homepage associated with the package.

• #licenses ⇒ Array<Types::LicenseInfo>

  Information about licenses associated with the package version.

• #namespace ⇒ String

  The namespace of the package version.

• #origin ⇒ Types::PackageVersionOrigin

  A [PackageVersionOrigin] object that contains information about how the package version was added to the repository.

• #package_name ⇒ String

  The name of the requested package.

• #published_time ⇒ Time

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

• #revision ⇒ 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.

• #status ⇒ String

  A string that contains the status of the package version.

• #summary ⇒ String

  A summary of the package version.

• #version ⇒ String

  The version of the package.

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)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2425

class PackageVersionDescription < Struct.new(
  :format,
  :namespace,
  :package_name,
  :display_name,
  :version,
  :summary,
  :home_page,
  :source_code_repository,
  :published_time,
  :licenses,
  :revision,
  :status,
  :origin)
  SENSITIVE = []
  include Aws::Structure
end

#format ⇒ String

The format of the package version.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2425

class PackageVersionDescription < Struct.new(
  :format,
  :namespace,
  :package_name,
  :display_name,
  :version,
  :summary,
  :home_page,
  :source_code_repository,
  :published_time,
  :licenses,
  :revision,
  :status,
  :origin)
  SENSITIVE = []
  include Aws::Structure
end

#home_page ⇒ String

The homepage associated with the package.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2425

class PackageVersionDescription < Struct.new(
  :format,
  :namespace,
  :package_name,
  :display_name,
  :version,
  :summary,
  :home_page,
  :source_code_repository,
  :published_time,
  :licenses,
  :revision,
  :status,
  :origin)
  SENSITIVE = []
  include Aws::Structure
end

#licenses ⇒ Array<Types::LicenseInfo>

Information about licenses associated with the package version.

Returns:

• (Array<Types::LicenseInfo>)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2425

class PackageVersionDescription < Struct.new(
  :format,
  :namespace,
  :package_name,
  :display_name,
  :version,
  :summary,
  :home_page,
  :source_code_repository,
  :published_time,
  :licenses,
  :revision,
  :status,
  :origin)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ String

The namespace of the package version. The package version component that specifies its namespace depends on its type. For example:

• The namespace of a Maven package version is its `groupId`.

• The namespace of an npm package version is its `scope`.

• Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2425

class PackageVersionDescription < Struct.new(
  :format,
  :namespace,
  :package_name,
  :display_name,
  :version,
  :summary,
  :home_page,
  :source_code_repository,
  :published_time,
  :licenses,
  :revision,
  :status,
  :origin)
  SENSITIVE = []
  include Aws::Structure
end

#origin ⇒ Types::PackageVersionOrigin

A [PackageVersionOrigin] object that contains information about how the package version was added to the repository.

[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageVersionOrigin.html

Returns:

• (Types::PackageVersionOrigin)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2425

class PackageVersionDescription < Struct.new(
  :format,
  :namespace,
  :package_name,
  :display_name,
  :version,
  :summary,
  :home_page,
  :source_code_repository,
  :published_time,
  :licenses,
  :revision,
  :status,
  :origin)
  SENSITIVE = []
  include Aws::Structure
end

#package_name ⇒ String

The name of the requested package.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2425

class PackageVersionDescription < Struct.new(
  :format,
  :namespace,
  :package_name,
  :display_name,
  :version,
  :summary,
  :home_page,
  :source_code_repository,
  :published_time,
  :licenses,
  :revision,
  :status,
  :origin)
  SENSITIVE = []
  include Aws::Structure
end

#published_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2425

class PackageVersionDescription < Struct.new(
  :format,
  :namespace,
  :package_name,
  :display_name,
  :version,
  :summary,
  :home_page,
  :source_code_repository,
  :published_time,
  :licenses,
  :revision,
  :status,
  :origin)
  SENSITIVE = []
  include Aws::Structure
end

#revision ⇒ String

The revision of the package version.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2425

class PackageVersionDescription < Struct.new(
  :format,
  :namespace,
  :package_name,
  :display_name,
  :version,
  :summary,
  :home_page,
  :source_code_repository,
  :published_time,
  :licenses,
  :revision,
  :status,
  :origin)
  SENSITIVE = []
  include Aws::Structure
end

#source_code_repository ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2425

class PackageVersionDescription < Struct.new(
  :format,
  :namespace,
  :package_name,
  :display_name,
  :version,
  :summary,
  :home_page,
  :source_code_repository,
  :published_time,
  :licenses,
  :revision,
  :status,
  :origin)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

A string that contains the status of the package version.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2425

class PackageVersionDescription < Struct.new(
  :format,
  :namespace,
  :package_name,
  :display_name,
  :version,
  :summary,
  :home_page,
  :source_code_repository,
  :published_time,
  :licenses,
  :revision,
  :status,
  :origin)
  SENSITIVE = []
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2425

class PackageVersionDescription < Struct.new(
  :format,
  :namespace,
  :package_name,
  :display_name,
  :version,
  :summary,
  :home_page,
  :source_code_repository,
  :published_time,
  :licenses,
  :revision,
  :status,
  :origin)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

The version of the package.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2425

class PackageVersionDescription < Struct.new(
  :format,
  :namespace,
  :package_name,
  :display_name,
  :version,
  :summary,
  :home_page,
  :source_code_repository,
  :published_time,
  :licenses,
  :revision,
  :status,
  :origin)
  SENSITIVE = []
  include Aws::Structure
end