Class PackageVersionDescription

    • Method Detail

      • namespace

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

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

      • packageName

        public final String packageName()

        The name of the requested package.

        Returns:
        The name of the requested package.
      • displayName

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

        Returns:
        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.
      • version

        public final String version()

        The version of the package.

        Returns:
        The version of the package.
      • summary

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

        Returns:
        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.
      • homePage

        public final String homePage()

        The homepage associated with the package.

        Returns:
        The homepage associated with the package.
      • sourceCodeRepository

        public final String sourceCodeRepository()

        The repository for the source code in the package version, or the source code used to build it.

        Returns:
        The repository for the source code in the package version, or the source code used to build it.
      • publishedTime

        public final Instant publishedTime()

        A timestamp that contains the date and time the package version was published.

        Returns:
        A timestamp that contains the date and time the package version was published.
      • hasLicenses

        public final boolean hasLicenses()
        For responses, this returns true if the service returned a value for the Licenses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • licenses

        public final List<LicenseInfo> licenses()

        Information about licenses associated with the package version.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLicenses() method.

        Returns:
        Information about licenses associated with the package version.
      • revision

        public final String revision()

        The revision of the package version.

        Returns:
        The revision of the package version.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)