PackageVersionDescription (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.codeartifact.model.PackageVersionDescription

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<PackageVersionDescription.Builder,PackageVersionDescription>

@Generated(value="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 and Description

static interface PackageVersionDescription.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PackageVersionDescription.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static PackageVersionDescription.Builder`	`builder()`
`String`	`displayName()` The name of the package that is displayed.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`PackageFormat`	`format()` The format of the package version.
`String`	`formatAsString()` The format of the package version.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasLicenses()` Returns true if the Licenses property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`homePage()` The homepage associated with the package.
`List<LicenseInfo>`	`licenses()` Information about licenses associated with the package version.
`String`	`namespace()` The namespace of the package.
`String`	`packageName()` The name of the requested package.
`Instant`	`publishedTime()` A timestamp that contains the date and time the package version was published.
`String`	`revision()` The revision of the package version.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PackageVersionDescription.Builder>`	`serializableBuilderClass()`
`String`	`sourceCodeRepository()` The repository for the source code in the package version, or the source code used to build it.
`PackageVersionStatus`	`status()` A string that contains the status of the package version.
`String`	`statusAsString()` A string that contains the status of the package version.
`String`	`summary()` A summary of the package version.
`PackageVersionDescription.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`version()` 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. The valid package formats are:
    - npm: A Node Package Manager (npm) package.
    - pypi: A Python Package Index (PyPI) package.
    - maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.
    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. The valid package formats are:
    
    npm: A Node Package Manager (npm) package.
    
    pypi: A Python Package Index (PyPI) package.
    
    maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.
    See Also:
    
    PackageFormat
  - formatAsString
```
public final String formatAsString()
```
    The format of the package version. The valid package formats are:
    - npm: A Node Package Manager (npm) package.
    - pypi: A Python Package Index (PyPI) package.
    - maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.
    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. The valid package formats are:
    
    npm: A Node Package Manager (npm) package.
    
    pypi: A Python Package Index (PyPI) package.
    
    maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.
    See Also:
    
    PackageFormat
  - namespace
```
public final String namespace()
```
    The namespace of the package. 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.
    - A Python package does not contain a corresponding component, so Python packages do not have a namespace.
    Returns:
    The namespace of the package. 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.
    
    A Python package does not contain a corresponding component, so Python packages 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()
```
    Returns true if the Licenses property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasLicenses() to see if a value was sent in this field.
    
    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. It can be one of the following:
    - Published
    - Unfinished
    - Unlisted
    - Archived
    - Disposed
    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. It can be one of the following:
    
    Published
    
    Unfinished
    
    Unlisted
    
    Archived
    
    Disposed
    See Also:
    
    PackageVersionStatus
  - statusAsString
```
public final String statusAsString()
```
    A string that contains the status of the package version. It can be one of the following:
    - Published
    - Unfinished
    - Unlisted
    - Archived
    - Disposed
    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. It can be one of the following:
    
    Published
    
    Unfinished
    
    Unlisted
    
    Archived
    
    Disposed
    See Also:
    
    PackageVersionStatus
  - toBuilder
```
public PackageVersionDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PackageVersionDescription.Builder,PackageVersionDescription>
  - 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)
```
    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

Class PackageVersionDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

format

formatAsString

namespace

packageName

displayName

version

summary

homePage

sourceCodeRepository

publishedTime

hasLicenses

licenses

revision

status

statusAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields