Struct aws_sdk_codeartifact::client::fluent_builders::GetPackageVersionReadme

pub struct GetPackageVersionReadme<C = DynConnector, M = AwsMiddleware, R = Standard> { /* fields omitted */ }

Fluent builder constructing a request to GetPackageVersionReadme.

Gets the readme file or descriptive text for a package version. For packages that do not contain a readme file, CodeArtifact extracts a description from a metadata file. For example, from the element in the pom.xml file of a Maven package.

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

Implementations

impl<C, M, R> GetPackageVersionReadme<C, M, R> where
    C: SmithyConnector,
    M: SmithyMiddleware<C>,
    R: NewRequestPolicy, 

pub async fn send(
    self
) -> Result<GetPackageVersionReadmeOutput, SdkError<GetPackageVersionReadmeError>> where
    R::Policy: SmithyRetryPolicy<GetPackageVersionReadmeInputOperationOutputAlias, GetPackageVersionReadmeOutput, GetPackageVersionReadmeError, GetPackageVersionReadmeInputOperationRetryAlias>, 

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 domain(self, inp: 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 domain_owner(self, inp: impl Into<String>) -> Self

The 12-digit account number of the AWS 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 AWS account that owns the domain. It does not include dashes or spaces.

pub fn repository(self, inp: 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 format(self, inp: PackageFormat) -> Self

A format that specifies the type of the package version with the requested readme file. The valid values are:

• npm

• pypi

• maven

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

A format that specifies the type of the package version with the requested readme file. The valid values are:

• npm

• pypi

• maven

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

The namespace of the package. The package component that specifies its namespace depends on its type. For example:

• The namespace of a Maven package is its groupId.

• The namespace of an npm package is its scope.

• A Python package does not contain a corresponding component, so Python packages do not have a namespace.

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

The namespace of the package. The package component that specifies its namespace depends on its type. For example:

• The namespace of a Maven package is its groupId.

• The namespace of an npm package is its scope.

• A Python package does not contain a corresponding component, so Python packages do not have a namespace.

pub fn package(self, inp: 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 package_version(self, inp: 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).

Trait Implementations

impl<C: Debug, M: Debug, R: Debug> Debug for GetPackageVersionReadme<C, M, R>

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

Formats the value using the given formatter.