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

Class: Aws::CodeArtifact::Types::GetPackageVersionReadmeResult

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

Overview

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#format ⇒ String

The format of the package with the requested readme file. Valid format types are:

  • npm

  • pypi

  • maven

    Possible values:

    • npm
    • pypi
    • maven

Returns:

  • (String) —

    The format of the package with the requested readme file.

#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 ⇒ String

The name of the package that contains the returned readme file.

Returns:

  • (String) —

    The name of the package that contains the returned readme file.

#readme ⇒ String

The text of the returned readme file.

Returns:

  • (String) —

    The text of the returned readme file.

#version ⇒ String

The version of the package with the requested readme file.

Returns:

  • (String) —

    The version of the package with the requested readme file.

#version_revision ⇒ String

The current revision associated with the package version.

Returns:

  • (String) —

    The current revision associated with the package version.