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 Details

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

      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

      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

      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

      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

      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

      Information about licenses associated with the package version.

      This is a convenience method that creates an instance of the LicenseInfo.Builder avoiding the need to create one manually via LicenseInfo.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to licenses(List<LicenseInfo>).

      Parameters:
      licenses - a consumer that will call methods on LicenseInfo.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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

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

      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 the PackageVersionOrigin.Builder avoiding the need to create one manually via PackageVersionOrigin.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to origin(PackageVersionOrigin).

      Parameters:
      origin - a consumer that will call methods on PackageVersionOrigin.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: