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

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

#domainString

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

Returns:

  • (String)


1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
# File 'lib/aws-sdk-codeartifact/types.rb', line 1313

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

#domain_ownerString

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

Returns:

  • (String)


1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
# File 'lib/aws-sdk-codeartifact/types.rb', line 1313

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

#formatString

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

Returns:

  • (String)


1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
# File 'lib/aws-sdk-codeartifact/types.rb', line 1313

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

#namespaceString

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)


1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
# File 'lib/aws-sdk-codeartifact/types.rb', line 1313

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

#packageString

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

Returns:

  • (String)


1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
# File 'lib/aws-sdk-codeartifact/types.rb', line 1313

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

#package_versionString

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

Returns:

  • (String)


1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
# File 'lib/aws-sdk-codeartifact/types.rb', line 1313

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

#repositoryString

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

Returns:

  • (String)


1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
# File 'lib/aws-sdk-codeartifact/types.rb', line 1313

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