Class: Aws::CodeArtifact::Types::GetPackageVersionReadmeRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#domain ⇒ String

The name of the domain that contains the repository that contains the package version with the requested readme file.

Returns:

  • (String) 


1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
 
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/types.rb', line 1744

class GetPackageVersionReadmeRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :package_version)
  SENSITIVE = []
  include Aws::Structure
end

#domain_owner ⇒ String

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

Returns:

  • (String) 


1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
 
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/types.rb', line 1744

class GetPackageVersionReadmeRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :package_version)
  SENSITIVE = []
  include Aws::Structure
end

#format ⇒ String

A format that specifies the type of the package version with the requested readme file.

Returns:

  • (String) 


1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
 
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/types.rb', line 1744

class GetPackageVersionReadmeRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :package_version)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ String

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 is required when requesting the readme from package versions of the following formats:

  • Maven

  • Swift

  • generic

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


1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
 
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/types.rb', line 1744

class GetPackageVersionReadmeRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :package_version)
  SENSITIVE = []
  include Aws::Structure
end

#package ⇒ String

The name of the package version that contains the requested readme file.

Returns:

  • (String) 


1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
 
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/types.rb', line 1744

class GetPackageVersionReadmeRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :package_version)
  SENSITIVE = []
  include Aws::Structure
end

#package_version ⇒ String

A string that contains the package version (for example, 3.5.2).

Returns:

  • (String) 


1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
 
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/types.rb', line 1744

class GetPackageVersionReadmeRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :package_version)
  SENSITIVE = []
  include Aws::Structure
end

#repository ⇒ String

The repository that contains the package with the requested readme file.

Returns:

  • (String) 


1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
 
# File 'gems/aws-sdk-codeartifact/lib/aws-sdk-codeartifact/types.rb', line 1744

class GetPackageVersionReadmeRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :package_version)
  SENSITIVE = []
  include Aws::Structure
end