Interface PackageVersionDescription.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<PackageVersionDescription.Builder,PackageVersionDescription>,SdkBuilder<PackageVersionDescription.Builder,PackageVersionDescription>,SdkPojo
- Enclosing class:
- PackageVersionDescription
public static interface PackageVersionDescription.Builder extends SdkPojo, CopyableBuilder<PackageVersionDescription.Builder,PackageVersionDescription>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description PackageVersionDescription.BuilderdisplayName(String displayName)The name of the package that is displayed.PackageVersionDescription.Builderformat(String format)The format of the package version.PackageVersionDescription.Builderformat(PackageFormat format)The format of the package version.PackageVersionDescription.BuilderhomePage(String homePage)The homepage associated with the package.PackageVersionDescription.Builderlicenses(Collection<LicenseInfo> licenses)Information about licenses associated with the package version.PackageVersionDescription.Builderlicenses(Consumer<LicenseInfo.Builder>... licenses)Information about licenses associated with the package version.PackageVersionDescription.Builderlicenses(LicenseInfo... licenses)Information about licenses associated with the package version.PackageVersionDescription.Buildernamespace(String namespace)The namespace of the package version.default PackageVersionDescription.Builderorigin(Consumer<PackageVersionOrigin.Builder> origin)A PackageVersionOrigin object that contains information about how the package version was added to the repository.PackageVersionDescription.Builderorigin(PackageVersionOrigin origin)A PackageVersionOrigin object that contains information about how the package version was added to the repository.PackageVersionDescription.BuilderpackageName(String packageName)The name of the requested package.PackageVersionDescription.BuilderpublishedTime(Instant publishedTime)A timestamp that contains the date and time the package version was published.PackageVersionDescription.Builderrevision(String revision)The revision of the package version.PackageVersionDescription.BuildersourceCodeRepository(String sourceCodeRepository)The repository for the source code in the package version, or the source code used to build it.PackageVersionDescription.Builderstatus(String status)A string that contains the status of the package version.PackageVersionDescription.Builderstatus(PackageVersionStatus status)A string that contains the status of the package version.PackageVersionDescription.Buildersummary(String summary)A summary of the package version.PackageVersionDescription.Builderversion(String version)The version of the package.-
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 Detail
-
format
PackageVersionDescription.Builder format(String format)
The format of the package version.
- Parameters:
format- The format of the package version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
PackageFormat,PackageFormat
-
format
PackageVersionDescription.Builder format(PackageFormat format)
The format of the package version.
- Parameters:
format- The format of the package version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
PackageFormat,PackageFormat
-
namespace
PackageVersionDescription.Builder namespace(String namespace)
The namespace of the package version. 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.
-
The namespace of a generic package is its
namespace.
- Parameters:
namespace- The namespace of the package version. 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.
-
The namespace of a generic package is its
namespace.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
packageName
PackageVersionDescription.Builder packageName(String packageName)
The name of the requested package.
- Parameters:
packageName- The name of the requested package.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
displayName
PackageVersionDescription.Builder displayName(String displayName)
The name of the package that is displayed. The
displayNamevaries depending on the package version's format. For example, if an npm package is namedui, is in the namespacevue, and has the formatnpm, then thedisplayNameis@vue/ui.- Parameters:
displayName- The name of the package that is displayed. ThedisplayNamevaries depending on the package version's format. For example, if an npm package is namedui, is in the namespacevue, and has the formatnpm, then thedisplayNameis@vue/ui.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
version
PackageVersionDescription.Builder version(String version)
The version of the package.
- Parameters:
version- The version of the package.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
summary
PackageVersionDescription.Builder summary(String summary)
A summary of the package version. The summary is extracted from the package. The information in and detail level of the summary depends on the package version's format.
- Parameters:
summary- A summary of the package version. The summary is extracted from the package. The information in and detail level of the summary depends on the package version's format.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
homePage
PackageVersionDescription.Builder homePage(String homePage)
The homepage associated with the package.
- Parameters:
homePage- The homepage associated with the package.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceCodeRepository
PackageVersionDescription.Builder sourceCodeRepository(String sourceCodeRepository)
The repository for the source code in the package version, or the source code used to build it.
- Parameters:
sourceCodeRepository- The repository for the source code in the package version, or the source code used to build it.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
publishedTime
PackageVersionDescription.Builder publishedTime(Instant publishedTime)
A timestamp that contains the date and time the package version was published.
- Parameters:
publishedTime- A timestamp that contains the date and time the package version was published.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
licenses
PackageVersionDescription.Builder licenses(Collection<LicenseInfo> licenses)
Information about licenses associated with the package version.
- Parameters:
licenses- Information about licenses associated with the package version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
licenses
PackageVersionDescription.Builder licenses(LicenseInfo... licenses)
Information about licenses associated with the package version.
- Parameters:
licenses- Information about licenses associated with the package version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
licenses
PackageVersionDescription.Builder licenses(Consumer<LicenseInfo.Builder>... licenses)
Information about licenses associated with the package version.
This is a convenience method that creates an instance of theLicenseInfo.Builderavoiding the need to create one manually viaLicenseInfo.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#licenses(List.) - Parameters:
licenses- a consumer that will call methods onLicenseInfo.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#licenses(java.util.Collection)
-
revision
PackageVersionDescription.Builder revision(String revision)
The revision of the package version.
- Parameters:
revision- The revision of the package version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
status
PackageVersionDescription.Builder status(String status)
A string that contains the status of the package version.
- Parameters:
status- A string that contains the status of the package version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
PackageVersionStatus,PackageVersionStatus
-
status
PackageVersionDescription.Builder status(PackageVersionStatus status)
A string that contains the status of the package version.
- Parameters:
status- A string that contains the status of the package version.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
PackageVersionStatus,PackageVersionStatus
-
origin
PackageVersionDescription.Builder origin(PackageVersionOrigin origin)
A PackageVersionOrigin object that contains information about how the package version was added to the repository.
- Parameters:
origin- A PackageVersionOrigin object that contains information about how the package version was added to the repository.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
origin
default PackageVersionDescription.Builder origin(Consumer<PackageVersionOrigin.Builder> origin)
A PackageVersionOrigin object that contains information about how the package version was added to the repository.
This is a convenience method that creates an instance of thePackageVersionOrigin.Builderavoiding the need to create one manually viaPackageVersionOrigin.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toorigin(PackageVersionOrigin).- Parameters:
origin- a consumer that will call methods onPackageVersionOrigin.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
origin(PackageVersionOrigin)
-
-