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

Inherits:

Struct

• Object
• Struct
• Aws::CodeArtifact::Types::GetPackageVersionReadmeResult

Includes:

Structure

Defined in:

lib/aws-sdk-codeartifact/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #format ⇒ String

  The format of the package with the requested readme file.

• #namespace ⇒ String

  The namespace of the package version with the requested readme file.

• #package ⇒ String

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

• #readme ⇒ String

  The text of the returned readme file.

• #version ⇒ String

  The version of the package with the requested readme file.

• #version_revision ⇒ String

  The current revision associated with the package version.

Instance Attribute Details

#format ⇒ String

The format of the package with the requested readme file.

Returns:

• (String)

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

class GetPackageVersionReadmeResult < Struct.new(
  :format,
  :namespace,
  :package,
  :version,
  :version_revision,
  :readme)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ String

The namespace of the package version with the requested readme file. 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 1589

class GetPackageVersionReadmeResult < Struct.new(
  :format,
  :namespace,
  :package,
  :version,
  :version_revision,
  :readme)
  SENSITIVE = []
  include Aws::Structure
end

#package ⇒ String

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

Returns:

• (String)

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

class GetPackageVersionReadmeResult < Struct.new(
  :format,
  :namespace,
  :package,
  :version,
  :version_revision,
  :readme)
  SENSITIVE = []
  include Aws::Structure
end

#readme ⇒ String

The text of the returned readme file.

Returns:

• (String)

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

class GetPackageVersionReadmeResult < Struct.new(
  :format,
  :namespace,
  :package,
  :version,
  :version_revision,
  :readme)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ String

The version of the package with the requested readme file.

Returns:

• (String)

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

class GetPackageVersionReadmeResult < Struct.new(
  :format,
  :namespace,
  :package,
  :version,
  :version_revision,
  :readme)
  SENSITIVE = []
  include Aws::Structure
end

#version_revision ⇒ String

The current revision associated with the package version.

Returns:

• (String)

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

class GetPackageVersionReadmeResult < Struct.new(
  :format,
  :namespace,
  :package,
  :version,
  :version_revision,
  :readme)
  SENSITIVE = []
  include Aws::Structure
end