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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-codeartifact/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#formatString

The format of the package with the requested readme file.

Returns:

  • (String)


1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
# File 'lib/aws-sdk-codeartifact/types.rb', line 1794

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

#namespaceString

The namespace of the package version with the requested readme file. The package 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 or Swift package version is its ‘scope`.

  • The namespace of a generic package is its ‘namespace`.

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

Returns:

  • (String)


1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
# File 'lib/aws-sdk-codeartifact/types.rb', line 1794

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

#packageString

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

Returns:

  • (String)


1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
# File 'lib/aws-sdk-codeartifact/types.rb', line 1794

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

#readmeString

The text of the returned readme file.

Returns:

  • (String)


1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
# File 'lib/aws-sdk-codeartifact/types.rb', line 1794

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

#versionString

The version of the package with the requested readme file.

Returns:

  • (String)


1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
# File 'lib/aws-sdk-codeartifact/types.rb', line 1794

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

#version_revisionString

The current revision associated with the package version.

Returns:

  • (String)


1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
# File 'lib/aws-sdk-codeartifact/types.rb', line 1794

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