Class PackageVersionDescription

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

Details about a package version.

See Also:

  • Method Details

    • format

      public final PackageFormat format()

      The format of the package version.

      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:
      The format of the package version.
      See Also:

    • formatAsString

      public final String formatAsString()

      The format of the package version.

      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:
      The format of the package version.
      See Also:

    • namespace

      public final String namespace()

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

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

    • status

      public final PackageVersionStatus status()

      A string that contains the status of the package version.

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

      Returns:
      A string that contains the status of the package version.
      See Also:

    • statusAsString

      public final String statusAsString()

      A string that contains the status of the package version.

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

      Returns:
      A string that contains the status of the package version.
      See Also:

    • origin

      public final PackageVersionOrigin origin()

      A PackageVersionOrigin object that contains information about how the package version was added to the repository.

      Returns:
      A PackageVersionOrigin object that contains information about how the package version was added to the repository.

    • toBuilder

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

    • builder

      public static PackageVersionDescription.Builder builder()

    • serializableBuilderClass

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