Interface GetPackageVersionReadmeRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CodeartifactRequest.Builder
,CopyableBuilder<GetPackageVersionReadmeRequest.Builder,
,GetPackageVersionReadmeRequest> SdkBuilder<GetPackageVersionReadmeRequest.Builder,
,GetPackageVersionReadmeRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetPackageVersionReadmeRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe name of the domain that contains the repository that contains the package version with the requested readme file.domainOwner
(String domainOwner) The 12-digit account number of the Amazon Web Services account that owns the domain.A format that specifies the type of the package version with the requested readme file.format
(PackageFormat format) A format that specifies the type of the package version with the requested readme file.The namespace of the package version with the requested readme file.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.packageValue
(String packageValue) The name of the package version that contains the requested readme file.packageVersion
(String packageVersion) A string that contains the package version (for example,3.5.2
).repository
(String repository) The repository that contains the package with the requested readme file.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.codeartifact.model.CodeartifactRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
domain
The name of the domain that contains the repository that contains the package version with the requested readme file.
- Parameters:
domain
- The name of the domain that contains the repository that contains the package version with the requested readme file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
domainOwner
The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
- Parameters:
domainOwner
- The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
repository
The repository that contains the package with the requested readme file.
- Parameters:
repository
- The repository that contains the package with the requested readme file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
format
A format that specifies the type of the package version with the requested readme file.
- Parameters:
format
- A format that specifies the type of the package version with the requested readme file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
format
A format that specifies the type of the package version with the requested readme file.
- Parameters:
format
- A format that specifies the type of the package version with the requested readme file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
namespace
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.
- Parameters:
namespace
- 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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
packageValue
The name of the package version that contains the requested readme file.
- Parameters:
packageValue
- The name of the package version that contains the requested readme file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
packageVersion
A string that contains the package version (for example,
3.5.2
).- Parameters:
packageVersion
- A string that contains the package version (for example,3.5.2
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
GetPackageVersionReadmeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetPackageVersionReadmeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-