PackageDetails (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.opensearch.model.PackageDetails

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Basic information about a package.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

PackageDetails()

Constructors
Constructor and Description
`PackageDetails()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PackageDetails`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAvailablePackageVersion()`
`Date`	`getCreatedAt()` The timestamp of when the package was created.
`ErrorDetails`	`getErrorDetails()` Additional information if the package is in an error state.
`Date`	`getLastUpdatedAt()`
`String`	`getPackageDescription()` User-specified description of the package.
`String`	`getPackageID()` Internal ID of the package.
`String`	`getPackageName()` User-specified name of the package.
`String`	`getPackageStatus()` Current state of the package.
`String`	`getPackageType()` Currently supports only TXT-DICTIONARY.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAvailablePackageVersion(String availablePackageVersion)`
`void`	`setCreatedAt(Date createdAt)` The timestamp of when the package was created.
`void`	`setErrorDetails(ErrorDetails errorDetails)` Additional information if the package is in an error state.
`void`	`setLastUpdatedAt(Date lastUpdatedAt)`
`void`	`setPackageDescription(String packageDescription)` User-specified description of the package.
`void`	`setPackageID(String packageID)` Internal ID of the package.
`void`	`setPackageName(String packageName)` User-specified name of the package.
`void`	`setPackageStatus(String packageStatus)` Current state of the package.
`void`	`setPackageType(String packageType)` Currently supports only TXT-DICTIONARY.
`String`	`toString()` Returns a string representation of this object.
`PackageDetails`	`withAvailablePackageVersion(String availablePackageVersion)`
`PackageDetails`	`withCreatedAt(Date createdAt)` The timestamp of when the package was created.
`PackageDetails`	`withErrorDetails(ErrorDetails errorDetails)` Additional information if the package is in an error state.
`PackageDetails`	`withLastUpdatedAt(Date lastUpdatedAt)`
`PackageDetails`	`withPackageDescription(String packageDescription)` User-specified description of the package.
`PackageDetails`	`withPackageID(String packageID)` Internal ID of the package.
`PackageDetails`	`withPackageName(String packageName)` User-specified name of the package.
`PackageDetails`	`withPackageStatus(PackageStatus packageStatus)` Current state of the package.
`PackageDetails`	`withPackageStatus(String packageStatus)` Current state of the package.
`PackageDetails`	`withPackageType(PackageType packageType)` Currently supports only TXT-DICTIONARY.
`PackageDetails`	`withPackageType(String packageType)` Currently supports only TXT-DICTIONARY.

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

- Constructor Detail
  - PackageDetails
```
public PackageDetails()
```
- Method Detail
  - setPackageID
```
public void setPackageID(String packageID)
```
    Internal ID of the package.
    
    Parameters:
    
    packageID - Internal ID of the package.
  - getPackageID
```
public String getPackageID()
```
    Internal ID of the package.
    
    Returns:
    
    Internal ID of the package.
  - withPackageID
```
public PackageDetails withPackageID(String packageID)
```
    Internal ID of the package.
    
    Parameters:
    
    packageID - Internal ID of the package.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPackageName
```
public void setPackageName(String packageName)
```
    User-specified name of the package.
    
    Parameters:
    
    packageName - User-specified name of the package.
  - getPackageName
```
public String getPackageName()
```
    User-specified name of the package.
    
    Returns:
    
    User-specified name of the package.
  - withPackageName
```
public PackageDetails withPackageName(String packageName)
```
    User-specified name of the package.
    
    Parameters:
    
    packageName - User-specified name of the package.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPackageType
```
public void setPackageType(String packageType)
```
    Currently supports only TXT-DICTIONARY.
    
    Parameters:
    
    packageType - Currently supports only TXT-DICTIONARY.
    
    See Also:
    
    PackageType
  - getPackageType
```
public String getPackageType()
```
    Currently supports only TXT-DICTIONARY.
    
    Returns:
    
    Currently supports only TXT-DICTIONARY.
    
    See Also:
    
    PackageType
  - withPackageType
```
public PackageDetails withPackageType(String packageType)
```
    Currently supports only TXT-DICTIONARY.
    
    Parameters:
    
    packageType - Currently supports only TXT-DICTIONARY.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PackageType
  - withPackageType
```
public PackageDetails withPackageType(PackageType packageType)
```
    Currently supports only TXT-DICTIONARY.
    
    Parameters:
    
    packageType - Currently supports only TXT-DICTIONARY.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PackageType
  - setPackageDescription
```
public void setPackageDescription(String packageDescription)
```
    User-specified description of the package.
    
    Parameters:
    
    packageDescription - User-specified description of the package.
  - getPackageDescription
```
public String getPackageDescription()
```
    User-specified description of the package.
    
    Returns:
    
    User-specified description of the package.
  - withPackageDescription
```
public PackageDetails withPackageDescription(String packageDescription)
```
    User-specified description of the package.
    
    Parameters:
    
    packageDescription - User-specified description of the package.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPackageStatus
```
public void setPackageStatus(String packageStatus)
```
    Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.
    
    Parameters:
    
    packageStatus - Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.
    
    See Also:
    
    PackageStatus
  - getPackageStatus
```
public String getPackageStatus()
```
    Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.
    
    Returns:
    
    Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.
    
    See Also:
    
    PackageStatus
  - withPackageStatus
```
public PackageDetails withPackageStatus(String packageStatus)
```
    Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.
    
    Parameters:
    
    packageStatus - Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PackageStatus
  - withPackageStatus
```
public PackageDetails withPackageStatus(PackageStatus packageStatus)
```
    Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.
    
    Parameters:
    
    packageStatus - Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PackageStatus
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The timestamp of when the package was created.
    
    Parameters:
    
    createdAt - The timestamp of when the package was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The timestamp of when the package was created.
    
    Returns:
    
    The timestamp of when the package was created.
  - withCreatedAt
```
public PackageDetails withCreatedAt(Date createdAt)
```
    The timestamp of when the package was created.
    
    Parameters:
    
    createdAt - The timestamp of when the package was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedAt
```
public void setLastUpdatedAt(Date lastUpdatedAt)
```
    Parameters:
    
    lastUpdatedAt -
  - getLastUpdatedAt
```
public Date getLastUpdatedAt()
```
    Returns:
  - withLastUpdatedAt
```
public PackageDetails withLastUpdatedAt(Date lastUpdatedAt)
```
    Parameters:
    
    lastUpdatedAt -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAvailablePackageVersion
```
public void setAvailablePackageVersion(String availablePackageVersion)
```
    Parameters:
    
    availablePackageVersion -
  - getAvailablePackageVersion
```
public String getAvailablePackageVersion()
```
    Returns:
  - withAvailablePackageVersion
```
public PackageDetails withAvailablePackageVersion(String availablePackageVersion)
```
    Parameters:
    
    availablePackageVersion -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setErrorDetails
```
public void setErrorDetails(ErrorDetails errorDetails)
```
    Additional information if the package is in an error state. Null otherwise.
    
    Parameters:
    
    errorDetails - Additional information if the package is in an error state. Null otherwise.
  - getErrorDetails
```
public ErrorDetails getErrorDetails()
```
    Additional information if the package is in an error state. Null otherwise.
    
    Returns:
    
    Additional information if the package is in an error state. Null otherwise.
  - withErrorDetails
```
public PackageDetails withErrorDetails(ErrorDetails errorDetails)
```
    Additional information if the package is in an error state. Null otherwise.
    
    Parameters:
    
    errorDetails - Additional information if the package is in an error state. Null otherwise.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 PackageDetails 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 PackageDetails

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PackageDetails

Method Detail

setPackageID

getPackageID

withPackageID

setPackageName

getPackageName

withPackageName

setPackageType

getPackageType

withPackageType

withPackageType

setPackageDescription

getPackageDescription

withPackageDescription

setPackageStatus

getPackageStatus

withPackageStatus

withPackageStatus

setCreatedAt

getCreatedAt

withCreatedAt

setLastUpdatedAt

getLastUpdatedAt

withLastUpdatedAt

setAvailablePackageVersion

getAvailablePackageVersion

withAvailablePackageVersion

setErrorDetails

getErrorDetails

withErrorDetails

toString

equals

hashCode

clone

marshall