Class PackageDescription

    • Method Detail

      • formatAsString

        public final String formatAsString()

        A format that specifies the type of the package.

        If the service returns an enum value that is not available in the current SDK version, format will return PackageFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

        Returns:
        A format that specifies the type of the package.
        See Also:
        PackageFormat
      • namespace

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

        • Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.

        • The namespace of a generic package is its namespace.

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

        • Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.

        • The namespace of a generic package is its namespace.

      • name

        public final String name()

        The name of the package.

        Returns:
        The name of the package.
      • originConfiguration

        public final PackageOriginConfiguration originConfiguration()

        The package origin configuration for the package.

        Returns:
        The package origin configuration for the package.
      • 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)