PackageVersionDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.codeartifact.model.PackageVersionDescription

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PackageVersionDescription
extends Object
implements Serializable, Cloneable, StructuredPojo

Details about a package version.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PackageVersionDescription()

Constructors
Constructor and Description
`PackageVersionDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PackageVersionDescription`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDisplayName()` The name of the package that is displayed.
`String`	`getFormat()` The format of the package version.
`String`	`getHomePage()` The homepage associated with the package.
`List<LicenseInfo>`	`getLicenses()` Information about licenses associated with the package version.
`String`	`getNamespace()` The namespace of the package.
`String`	`getPackageName()` The name of the requested package.
`Date`	`getPublishedTime()` A timestamp that contains the date and time the package version was published.
`String`	`getRevision()` The revision of the package version.
`String`	`getSourceCodeRepository()` The repository for the source code in the package version, or the source code used to build it.
`String`	`getStatus()` A string that contains the status of the package version.
`String`	`getSummary()` A summary of the package version.
`String`	`getVersion()` The version of the package.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDisplayName(String displayName)` The name of the package that is displayed.
`void`	`setFormat(String format)` The format of the package version.
`void`	`setHomePage(String homePage)` The homepage associated with the package.
`void`	`setLicenses(Collection<LicenseInfo> licenses)` Information about licenses associated with the package version.
`void`	`setNamespace(String namespace)` The namespace of the package.
`void`	`setPackageName(String packageName)` The name of the requested package.
`void`	`setPublishedTime(Date publishedTime)` A timestamp that contains the date and time the package version was published.
`void`	`setRevision(String revision)` The revision of the package version.
`void`	`setSourceCodeRepository(String sourceCodeRepository)` The repository for the source code in the package version, or the source code used to build it.
`void`	`setStatus(String status)` A string that contains the status of the package version.
`void`	`setSummary(String summary)` A summary of the package version.
`void`	`setVersion(String version)` The version of the package.
`String`	`toString()` Returns a string representation of this object.
`PackageVersionDescription`	`withDisplayName(String displayName)` The name of the package that is displayed.
`PackageVersionDescription`	`withFormat(PackageFormat format)` The format of the package version.
`PackageVersionDescription`	`withFormat(String format)` The format of the package version.
`PackageVersionDescription`	`withHomePage(String homePage)` The homepage associated with the package.
`PackageVersionDescription`	`withLicenses(Collection<LicenseInfo> licenses)` Information about licenses associated with the package version.
`PackageVersionDescription`	`withLicenses(LicenseInfo... licenses)` Information about licenses associated with the package version.
`PackageVersionDescription`	`withNamespace(String namespace)` The namespace of the package.
`PackageVersionDescription`	`withPackageName(String packageName)` The name of the requested package.
`PackageVersionDescription`	`withPublishedTime(Date publishedTime)` A timestamp that contains the date and time the package version was published.
`PackageVersionDescription`	`withRevision(String revision)` The revision of the package version.
`PackageVersionDescription`	`withSourceCodeRepository(String sourceCodeRepository)` The repository for the source code in the package version, or the source code used to build it.
`PackageVersionDescription`	`withStatus(PackageVersionStatus status)` A string that contains the status of the package version.
`PackageVersionDescription`	`withStatus(String status)` A string that contains the status of the package version.
`PackageVersionDescription`	`withSummary(String summary)` A summary of the package version.
`PackageVersionDescription`	`withVersion(String version)` The version of the package.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PackageVersionDescription
```
public PackageVersionDescription()
```
- Method Detail
  - setFormat
```
public void setFormat(String 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.
    Parameters:
    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.
    See Also:
    
    PackageFormat
  - getFormat
```
public String getFormat()
```
    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.
    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
  - withFormat
```
public PackageVersionDescription withFormat(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PackageFormat
  - withFormat
```
public PackageVersionDescription withFormat(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PackageFormat
  - setNamespace
```
public void setNamespace(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.
    Parameters:
    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.
  - getNamespace
```
public String getNamespace()
```
    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.
  - withNamespace
```
public PackageVersionDescription withNamespace(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPackageName
```
public void setPackageName(String packageName)
```
    The name of the requested package.
    
    Parameters:
    
    packageName - The name of the requested package.
  - getPackageName
```
public String getPackageName()
```
    The name of the requested package.
    
    Returns:
    
    The name of the requested package.
  - withPackageName
```
public PackageVersionDescription withPackageName(String packageName)
```
    The name of the requested package.
    
    Parameters:
    
    packageName - The name of the requested package.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDisplayName
```
public void setDisplayName(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.
    
    Parameters:
    
    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.
  - getDisplayName
```
public String getDisplayName()
```
    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.
  - withDisplayName
```
public PackageVersionDescription withDisplayName(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersion
```
public void setVersion(String version)
```
    The version of the package.
    
    Parameters:
    
    version - The version of the package.
  - getVersion
```
public String getVersion()
```
    The version of the package.
    
    Returns:
    
    The version of the package.
  - withVersion
```
public PackageVersionDescription withVersion(String version)
```
    The version of the package.
    
    Parameters:
    
    version - The version of the package.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSummary
```
public void setSummary(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.
    
    Parameters:
    
    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.
  - getSummary
```
public String getSummary()
```
    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.
  - withSummary
```
public PackageVersionDescription withSummary(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setHomePage
```
public void setHomePage(String homePage)
```
    The homepage associated with the package.
    
    Parameters:
    
    homePage - The homepage associated with the package.
  - getHomePage
```
public String getHomePage()
```
    The homepage associated with the package.
    
    Returns:
    
    The homepage associated with the package.
  - withHomePage
```
public PackageVersionDescription withHomePage(String homePage)
```
    The homepage associated with the package.
    
    Parameters:
    
    homePage - The homepage associated with the package.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceCodeRepository
```
public void setSourceCodeRepository(String sourceCodeRepository)
```
    The repository for the source code in the package version, or the source code used to build it.
    
    Parameters:
    
    sourceCodeRepository - The repository for the source code in the package version, or the source code used to build it.
  - getSourceCodeRepository
```
public String getSourceCodeRepository()
```
    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.
  - withSourceCodeRepository
```
public PackageVersionDescription withSourceCodeRepository(String sourceCodeRepository)
```
    The repository for the source code in the package version, or the source code used to build it.
    
    Parameters:
    
    sourceCodeRepository - The repository for the source code in the package version, or the source code used to build it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPublishedTime
```
public void setPublishedTime(Date publishedTime)
```
    A timestamp that contains the date and time the package version was published.
    
    Parameters:
    
    publishedTime - A timestamp that contains the date and time the package version was published.
  - getPublishedTime
```
public Date getPublishedTime()
```
    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.
  - withPublishedTime
```
public PackageVersionDescription withPublishedTime(Date publishedTime)
```
    A timestamp that contains the date and time the package version was published.
    
    Parameters:
    
    publishedTime - A timestamp that contains the date and time the package version was published.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getLicenses
```
public List<LicenseInfo> getLicenses()
```
    Information about licenses associated with the package version.
    
    Returns:
    
    Information about licenses associated with the package version.
  - setLicenses
```
public void setLicenses(Collection<LicenseInfo> licenses)
```
    Information about licenses associated with the package version.
    
    Parameters:
    
    licenses - Information about licenses associated with the package version.
  - withLicenses
```
public PackageVersionDescription withLicenses(LicenseInfo... licenses)
```
    Information about licenses associated with the package version.
    
    NOTE: This method appends the values to the existing list (if any). Use setLicenses(java.util.Collection) or withLicenses(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    licenses - Information about licenses associated with the package version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withLicenses
```
public PackageVersionDescription withLicenses(Collection<LicenseInfo> licenses)
```
    Information about licenses associated with the package version.
    
    Parameters:
    
    licenses - Information about licenses associated with the package version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRevision
```
public void setRevision(String revision)
```
    The revision of the package version.
    
    Parameters:
    
    revision - The revision of the package version.
  - getRevision
```
public String getRevision()
```
    The revision of the package version.
    
    Returns:
    
    The revision of the package version.
  - withRevision
```
public PackageVersionDescription withRevision(String revision)
```
    The revision of the package version.
    
    Parameters:
    
    revision - The revision of the package version.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    A string that contains the status of the package version. It can be one of the following:
    - Published
    - Unfinished
    - Unlisted
    - Archived
    - Disposed
    Parameters:
    status - 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
  - getStatus
```
public String getStatus()
```
    A string that contains the status of the package version. It can be one of the following:
    - Published
    - Unfinished
    - Unlisted
    - Archived
    - Disposed
    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
  - withStatus
```
public PackageVersionDescription withStatus(String status)
```
    A string that contains the status of the package version. It can be one of the following:
    - Published
    - Unfinished
    - Unlisted
    - Archived
    - Disposed
    Parameters:
    status - A string that contains the status of the package version. It can be one of the following:
    
    Published
    
    Unfinished
    
    Unlisted
    
    Archived
    
    Disposed
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PackageVersionStatus
  - withStatus
```
public PackageVersionDescription withStatus(PackageVersionStatus status)
```
    A string that contains the status of the package version. It can be one of the following:
    - Published
    - Unfinished
    - Unlisted
    - Archived
    - Disposed
    Parameters:
    status - A string that contains the status of the package version. It can be one of the following:
    
    Published
    
    Unfinished
    
    Unlisted
    
    Archived
    
    Disposed
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PackageVersionStatus
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public PackageVersionDescription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class PackageVersionDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PackageVersionDescription

Method Detail

setFormat

getFormat

withFormat

withFormat

setNamespace

getNamespace

withNamespace

setPackageName

getPackageName

withPackageName

setDisplayName

getDisplayName

withDisplayName

setVersion

getVersion

withVersion

setSummary

getSummary

withSummary

setHomePage

getHomePage

withHomePage

setSourceCodeRepository

getSourceCodeRepository

withSourceCodeRepository

setPublishedTime

getPublishedTime

withPublishedTime

getLicenses

setLicenses

withLicenses

withLicenses

setRevision

getRevision

withRevision

setStatus

getStatus

withStatus

withStatus

toString

equals

hashCode

clone

marshall