Class AssociatedPackage

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

A package associated with a package group.

See Also:

  • Method Details

    • format

      public final PackageFormat format()

      A format that specifies the type of the associated 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 associated package.
      See Also:

    • formatAsString

      public final String formatAsString()

      A format that specifies the type of the associated 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 associated package.
      See Also:

    • namespace

      public final String namespace()

      The namespace of the associated package. 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 associated package. 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 associated package.

      Returns:
      The name of the associated package.

    • associationType

      public final PackageGroupAssociationType associationType()

      Describes the strength of the association between the package and package group. A strong match can be thought of as an exact match, and a weak match can be thought of as a variation match, for example, the package name matches a variation of the package group pattern. For more information about package group pattern matching, including strong and weak matches, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.

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

      Returns:
      Describes the strength of the association between the package and package group. A strong match can be thought of as an exact match, and a weak match can be thought of as a variation match, for example, the package name matches a variation of the package group pattern. For more information about package group pattern matching, including strong and weak matches, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
      See Also:

    • associationTypeAsString

      public final String associationTypeAsString()

      Describes the strength of the association between the package and package group. A strong match can be thought of as an exact match, and a weak match can be thought of as a variation match, for example, the package name matches a variation of the package group pattern. For more information about package group pattern matching, including strong and weak matches, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.

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

      Returns:
      Describes the strength of the association between the package and package group. A strong match can be thought of as an exact match, and a weak match can be thought of as a variation match, for example, the package name matches a variation of the package group pattern. For more information about package group pattern matching, including strong and weak matches, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
      See Also:

    • toBuilder

      public AssociatedPackage.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<AssociatedPackage.Builder,AssociatedPackage>
      Returns:
      a builder for type T

    • builder

      public static AssociatedPackage.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AssociatedPackage.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.