aws_sdk_codeartifact/client/

get_package_version_readme.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`GetPackageVersionReadme`](crate::operation::get_package_version_readme::builders::GetPackageVersionReadmeFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`domain(impl Into<String>)`](crate::operation::get_package_version_readme::builders::GetPackageVersionReadmeFluentBuilder::domain) / [`set_domain(Option<String>)`](crate::operation::get_package_version_readme::builders::GetPackageVersionReadmeFluentBuilder::set_domain):<br>required: **true**<br><p>The name of the domain that contains the repository that contains the package version with the requested readme file.</p><br>
    ///   - [`domain_owner(impl Into<String>)`](crate::operation::get_package_version_readme::builders::GetPackageVersionReadmeFluentBuilder::domain_owner) / [`set_domain_owner(Option<String>)`](crate::operation::get_package_version_readme::builders::GetPackageVersionReadmeFluentBuilder::set_domain_owner):<br>required: **false**<br><p>The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.</p><br>
    ///   - [`repository(impl Into<String>)`](crate::operation::get_package_version_readme::builders::GetPackageVersionReadmeFluentBuilder::repository) / [`set_repository(Option<String>)`](crate::operation::get_package_version_readme::builders::GetPackageVersionReadmeFluentBuilder::set_repository):<br>required: **true**<br><p>The repository that contains the package with the requested readme file.</p><br>
    ///   - [`format(PackageFormat)`](crate::operation::get_package_version_readme::builders::GetPackageVersionReadmeFluentBuilder::format) / [`set_format(Option<PackageFormat>)`](crate::operation::get_package_version_readme::builders::GetPackageVersionReadmeFluentBuilder::set_format):<br>required: **true**<br><p>A format that specifies the type of the package version with the requested readme file.</p><br>
    ///   - [`namespace(impl Into<String>)`](crate::operation::get_package_version_readme::builders::GetPackageVersionReadmeFluentBuilder::namespace) / [`set_namespace(Option<String>)`](crate::operation::get_package_version_readme::builders::GetPackageVersionReadmeFluentBuilder::set_namespace):<br>required: **false**<br><p>The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:</p><note>  <p>The namespace is required when requesting the readme from package versions of the following formats:</p>  <ul>   <li>    <p>Maven</p></li>   <li>    <p>Swift</p></li>   <li>    <p>generic</p></li>  </ul> </note> <ul>  <li>   <p>The namespace of a Maven package version is its <code>groupId</code>.</p></li>  <li>   <p>The namespace of an npm or Swift package version is its <code>scope</code>.</p></li>  <li>   <p>The namespace of a generic package is its <code>namespace</code>.</p></li>  <li>   <p>Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.</p></li> </ul><br>
    ///   - [`package(impl Into<String>)`](crate::operation::get_package_version_readme::builders::GetPackageVersionReadmeFluentBuilder::package) / [`set_package(Option<String>)`](crate::operation::get_package_version_readme::builders::GetPackageVersionReadmeFluentBuilder::set_package):<br>required: **true**<br><p>The name of the package version that contains the requested readme file.</p><br>
    ///   - [`package_version(impl Into<String>)`](crate::operation::get_package_version_readme::builders::GetPackageVersionReadmeFluentBuilder::package_version) / [`set_package_version(Option<String>)`](crate::operation::get_package_version_readme::builders::GetPackageVersionReadmeFluentBuilder::set_package_version):<br>required: **true**<br><p>A string that contains the package version (for example, <code>3.5.2</code>).</p><br>
    /// - On success, responds with [`GetPackageVersionReadmeOutput`](crate::operation::get_package_version_readme::GetPackageVersionReadmeOutput) with field(s):
    ///   - [`format(Option<PackageFormat>)`](crate::operation::get_package_version_readme::GetPackageVersionReadmeOutput::format): <p>The format of the package with the requested readme file.</p>
    ///   - [`namespace(Option<String>)`](crate::operation::get_package_version_readme::GetPackageVersionReadmeOutput::namespace): <p>The namespace of the package version with the requested readme file. The package component that specifies its namespace depends on its type. For example:</p> <ul>  <li>   <p>The namespace of a Maven package version is its <code>groupId</code>.</p></li>  <li>   <p>The namespace of an npm or Swift package version is its <code>scope</code>.</p></li>  <li>   <p>The namespace of a generic package is its <code>namespace</code>.</p></li>  <li>   <p>Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.</p></li> </ul>
    ///   - [`package(Option<String>)`](crate::operation::get_package_version_readme::GetPackageVersionReadmeOutput::package): <p>The name of the package that contains the returned readme file.</p>
    ///   - [`version(Option<String>)`](crate::operation::get_package_version_readme::GetPackageVersionReadmeOutput::version): <p>The version of the package with the requested readme file.</p>
    ///   - [`version_revision(Option<String>)`](crate::operation::get_package_version_readme::GetPackageVersionReadmeOutput::version_revision): <p>The current revision associated with the package version.</p>
    ///   - [`readme(Option<String>)`](crate::operation::get_package_version_readme::GetPackageVersionReadmeOutput::readme): <p>The text of the returned readme file.</p>
    /// - On failure, responds with [`SdkError<GetPackageVersionReadmeError>`](crate::operation::get_package_version_readme::GetPackageVersionReadmeError)
    pub fn get_package_version_readme(&self) -> crate::operation::get_package_version_readme::builders::GetPackageVersionReadmeFluentBuilder {
        crate::operation::get_package_version_readme::builders::GetPackageVersionReadmeFluentBuilder::new(self.handle.clone())
    }
}