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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfacePackageVersionDescription.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PackageVersionDescription.Builderbuilder()StringdisplayName()The name of the package that is displayed.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)PackageFormatformat()The format of the package version.StringformatAsString()The format of the package version.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasLicenses()For responses, this returns true if the service returned a value for the Licenses property.StringhomePage()The homepage associated with the package.List<LicenseInfo>licenses()Information about licenses associated with the package version.Stringnamespace()The namespace of the package version.PackageVersionOriginorigin()A PackageVersionOrigin object that contains information about how the package version was added to the repository.StringpackageName()The name of the requested package.InstantpublishedTime()A timestamp that contains the date and time the package version was published.Stringrevision()The revision of the package version.List<SdkField<?>>sdkFields()static Class<? extends PackageVersionDescription.Builder>serializableBuilderClass()StringsourceCodeRepository()The repository for the source code in the package version, or the source code used to build it.PackageVersionStatusstatus()A string that contains the status of the package version.StringstatusAsString()A string that contains the status of the package version.Stringsummary()A summary of the package version.PackageVersionDescription.BuildertoBuilder()StringtoString()Returns a string representation of this object.Stringversion()The version of the package.-
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
-
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,
formatwill returnPackageFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromformatAsString().- Returns:
- The format of the package version.
- See Also:
PackageFormat
-
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,
formatwill returnPackageFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromformatAsString().- Returns:
- The format of the package version.
- See Also:
PackageFormat
-
namespace
public final String namespace()
The namespace of the package version. The package version 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 package version is its
scope. -
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
The namespace of a generic package is its
namespace.
- Returns:
- The namespace of the package version. The package version 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 package version is its
scope. -
Python and NuGet package versions do not contain a corresponding component, package versions of those formats do not have a namespace.
-
The namespace of a generic package is its
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
displayNamevaries depending on the package version's format. For example, if an npm package is namedui, is in the namespacevue, and has the formatnpm, then thedisplayNameis@vue/ui.- Returns:
- The name of the package that is displayed. The
displayNamevaries depending on the package version's format. For example, if an npm package is namedui, is in the namespacevue, and has the formatnpm, then thedisplayNameis@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 theisEmpty()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,
statuswill returnPackageVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- A string that contains the status of the package version.
- See Also:
PackageVersionStatus
-
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,
statuswill returnPackageVersionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- A string that contains the status of the package version.
- See Also:
PackageVersionStatus
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<PackageVersionDescription.Builder,PackageVersionDescription>
-
builder
public static PackageVersionDescription.Builder builder()
-
serializableBuilderClass
public static Class<? extends PackageVersionDescription.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-