Struct aws_sdk_codeartifact::operation::get_package_version_readme::GetPackageVersionReadmeInput

#[non_exhaustive]
pub struct GetPackageVersionReadmeInput {
    pub domain: Option<String>,
    pub domain_owner: Option<String>,
    pub repository: Option<String>,
    pub format: Option<PackageFormat>,
    pub namespace: Option<String>,
    pub package: Option<String>,
    pub package_version: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

domain: Option<String>

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

domain_owner: Option<String>

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

repository: Option<String>

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

format: Option<PackageFormat>

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

namespace: Option<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.

package: Option<String>

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

package_version: Option<String>

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

Implementations

impl GetPackageVersionReadmeInput

pub fn domain(&self) -> Option<&str>

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

pub fn domain_owner(&self) -> Option<&str>

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

pub fn repository(&self) -> Option<&str>

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

pub fn format(&self) -> Option<&PackageFormat>

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

pub fn namespace(&self) -> Option<&str>

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.

pub fn package(&self) -> Option<&str>

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

pub fn package_version(&self) -> Option<&str>

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

impl GetPackageVersionReadmeInput

pub fn builder() -> GetPackageVersionReadmeInputBuilder

Creates a new builder-style object to manufacture GetPackageVersionReadmeInput.

Trait Implementations

impl Clone for GetPackageVersionReadmeInput

fn clone(&self) -> GetPackageVersionReadmeInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetPackageVersionReadmeInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for GetPackageVersionReadmeInput

fn eq(&self, other: &GetPackageVersionReadmeInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetPackageVersionReadmeInput