Struct aws_sdk_codeartifact::client::fluent_builders::GetPackageVersionReadme

source ·

pub struct GetPackageVersionReadme { /* private fields */ }

Expand description

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§

source §

impl GetPackageVersionReadme

source

pub async fn customize(
self
) -> Result<CustomizableOperation<GetPackageVersionReadme, AwsResponseRetryClassifier>, SdkError<GetPackageVersionReadmeError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

source

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

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.

source

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.

source

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.

source

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.

source

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.

source

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

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

source

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

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

source

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

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

Although maven is listed as a valid value, CodeArtifact does not support displaying readme files for Maven packages.

source

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

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

Although maven is listed as a valid value, CodeArtifact does not support displaying readme files for Maven packages.

source

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

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.

source

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

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.

source