Package software.amazon.awssdk.services.codeartifact.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PackageDependency.Builder

Method Summary

Modifier and Type	Method	Description
static PackageDependency.Builder	builder()
String	dependencyType()	The type of a package dependency.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	namespace()	The namespace of the package that this package depends on.
String	packageValue()	The name of the package that this package depends on.
List<SdkField<?>>	sdkFields()
static Class<? extends PackageDependency.Builder>	serializableBuilderClass()
PackageDependency.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	versionRequirement()	The required version, or version range, of the package that this package depends on.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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

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

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

Specified by:

toBuilder in interface ToCopyableBuilder<PackageDependency.Builder,PackageDependency>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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