Interface PackageVersionDescription.Builder

    • Method Detail

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