software.amazon.awssdk.services.codeartifact.model

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

Modifier and Type	Method and Description
PackageVersionDescription.Builder	displayName(String displayName) The name of the package that is displayed.
PackageVersionDescription.Builder	format(PackageFormat format) The format of the package version.
PackageVersionDescription.Builder	format(String format) The format of the package version.
PackageVersionDescription.Builder	homePage(String homePage) The homepage associated with the package.
PackageVersionDescription.Builder	licenses(Collection<LicenseInfo> licenses) Information about licenses associated with the package version.
PackageVersionDescription.Builder	licenses(Consumer<LicenseInfo.Builder>... licenses) Information about licenses associated with the package version.
PackageVersionDescription.Builder	licenses(LicenseInfo... licenses) Information about licenses associated with the package version.
PackageVersionDescription.Builder	namespace(String namespace) The namespace of the package.
PackageVersionDescription.Builder	packageName(String packageName) The name of the requested package.
PackageVersionDescription.Builder	publishedTime(Instant publishedTime) A timestamp that contains the date and time the package version was published.
PackageVersionDescription.Builder	revision(String revision) The revision of the package version.
PackageVersionDescription.Builder	sourceCodeRepository(String sourceCodeRepository) The repository for the source code in the package version, or the source code used to build it.
PackageVersionDescription.Builder	status(PackageVersionStatus status) A string that contains the status of the package version.
PackageVersionDescription.Builder	status(String status) A string that contains the status of the package version.
PackageVersionDescription.Builder	summary(String summary) A summary of the package version.
PackageVersionDescription.Builder	version(String version) The version of the package.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

format

PackageVersionDescription.Builder format(String format)

The format of the package version. The valid package formats are:

• npm: A Node Package Manager (npm) package.

• pypi: A Python Package Index (PyPI) package.

• maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

Parameters:

format - The format of the package version. The valid package formats are:

• npm: A Node Package Manager (npm) package.

• pypi: A Python Package Index (PyPI) package.

• maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

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. The valid package formats are:

• npm: A Node Package Manager (npm) package.

• pypi: A Python Package Index (PyPI) package.

• maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

Parameters:

format - The format of the package version. The valid package formats are:

• npm: A Node Package Manager (npm) package.

• pypi: A Python Package Index (PyPI) package.

• maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.

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. 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.

Parameters:

namespace - 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.

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 displayName varies depending on the package version's format. For example, if an npm package is named ui, is in the namespace vue, and has the format npm, then the displayName is @vue/ui.

Parameters:

displayName - The name of the package that is displayed. The displayName varies depending on the package version's format. For example, if an npm package is named ui, is in the namespace vue, and has the format npm, then the displayName is @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 that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #licenses(List).

Parameters:

licenses - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#licenses(List)

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. It can be one of the following:

• Published

• Unfinished

• Unlisted

• Archived

• Disposed

Parameters:

status - A string that contains the status of the package version. It can be one of the following:

• Published

• Unfinished

• Unlisted

• Archived

• Disposed

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. It can be one of the following:

• Published

• Unfinished

• Unlisted

• Archived

• Disposed

Parameters:

status - A string that contains the status of the package version. It can be one of the following:

• Published

• Unfinished

• Unlisted

• Archived

• Disposed

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PackageVersionStatus, PackageVersionStatus