Struct aws_sdk_codeartifact::operation::get_package_version_readme::builders::GetPackageVersionReadmeFluentBuilder

pub struct GetPackageVersionReadmeFluentBuilder { /* private fields */ }

Fluent builder constructing a request to GetPackageVersionReadme.

Gets the readme file or descriptive text for a package version.

The returned text might contain formatting. For example, it might contain formatting for Markdown or reStructuredText.

Implementations

impl GetPackageVersionReadmeFluentBuilder

pub fn as_input(&self) -> &GetPackageVersionReadmeInputBuilder

Access the GetPackageVersionReadme as a reference.

pub async fn send( self ) -> Result<GetPackageVersionReadmeOutput, SdkError<GetPackageVersionReadmeError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<GetPackageVersionReadmeOutput, GetPackageVersionReadmeError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn domain(self, input: impl Into<String>) -> Self

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

pub fn set_domain(self, input: Option<String>) -> Self

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

pub fn get_domain(&self) -> &Option<String>

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

pub fn domain_owner(self, input: impl Into<String>) -> Self

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

pub fn set_domain_owner(self, input: Option<String>) -> Self

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

pub fn get_domain_owner(&self) -> &Option<String>

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, input: impl Into<String>) -> Self

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

pub fn set_repository(self, input: Option<String>) -> Self

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

pub fn get_repository(&self) -> &Option<String>

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

pub fn format(self, input: PackageFormat) -> Self

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

pub fn set_format(self, input: Option<PackageFormat>) -> Self

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

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

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

pub fn namespace(self, input: impl Into<String>) -> Self

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, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

pub fn set_namespace(self, input: Option<String>) -> Self

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, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

pub fn get_namespace(&self) -> &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, and Ruby package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

pub fn package(self, input: impl Into<String>) -> Self

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

pub fn set_package(self, input: Option<String>) -> Self

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

pub fn get_package(&self) -> &Option<String>

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

pub fn package_version(self, input: impl Into<String>) -> Self

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

pub fn set_package_version(self, input: Option<String>) -> Self

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

pub fn get_package_version(&self) -> &Option<String>

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

Trait Implementations

impl Clone for GetPackageVersionReadmeFluentBuilder

fn clone(&self) -> GetPackageVersionReadmeFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetPackageVersionReadmeFluentBuilder

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

Formats the value using the given formatter.