Class PackageDependency

java.lang.Object
software.amazon.awssdk.services.codeartifact.model.PackageDependency
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PackageDependency.Builder,PackageDependency>
@Generated("software.amazon.awssdk:codegen") public final class PackageDependency extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PackageDependency.Builder,PackageDependency>

Details about a package dependency.

See Also:

  • Method Details

    • namespace

      public final String namespace()

      The namespace of the package that this package depends on. The package 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 or Swift package version is its scope.

      • The namespace of a generic package is its namespace.

      • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

      Returns:
      The namespace of the package that this package depends on. The package 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 or Swift package version is its scope.

      • The namespace of a generic package is its namespace.

      • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

    • packageValue

      public final String packageValue()

      The name of the package that this package depends on.

      Returns:
      The name of the package that this package depends on.

    • dependencyType

      public final String dependencyType()

      The type of a package dependency. The possible values depend on the package type.

      • npm: regular, dev, peer, optional

      • maven: optional, parent, compile, runtime, test, system, provided.

        Note that parent is not a regular Maven dependency type; instead this is extracted from the <parent> element if one is defined in the package version's POM file.

      • nuget: The dependencyType field is never set for NuGet packages.

      • pypi: Requires-Dist

      Returns:
      The type of a package dependency. The possible values depend on the package type.

      • npm: regular, dev, peer, optional

      • maven: optional, parent, compile, runtime, test, system, provided.

        Note that parent is not a regular Maven dependency type; instead this is extracted from the <parent> element if one is defined in the package version's POM file.

      • nuget: The dependencyType field is never set for NuGet packages.

      • pypi: Requires-Dist

    • versionRequirement

      public final String versionRequirement()

      The required version, or version range, of the package that this package depends on. The version format is specific to the package type. For example, the following are possible valid required versions: 1.2.3, ^2.3.4, or 4.x.

      Returns:
      The required version, or version range, of the package that this package depends on. The version format is specific to the package type. For example, the following are possible valid required versions: 1.2.3, ^2.3.4, or 4.x.

    • toBuilder

      public PackageDependency.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PackageDependency.Builder,PackageDependency>
      Returns:
      a builder for type T

    • builder

      public static PackageDependency.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PackageDependency.Builder> serializableBuilderClass()

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.