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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codeartifact/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. Valid format types are:

  • npm

  • pypi

  • maven

  • nuget

Returns:

  • (String)


1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/types.rb', line 1577

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

#namespaceString

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.

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

Returns:

  • (String)


1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/types.rb', line 1577

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)


1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/types.rb', line 1577

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)


1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/types.rb', line 1577

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)


1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/types.rb', line 1577

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)


1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/types.rb', line 1577

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