java.lang.Object
- software.amazon.awssdk.services.opensearch.model.DomainPackageDetails

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DomainPackageDetails.Builder,DomainPackageDetails>
```
@Generated("software.amazon.awssdk:codegen")
public final class DomainPackageDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<DomainPackageDetails.Builder,DomainPackageDetails>
```
Information about a package that is associated with a domain. For more information, see Custom packages for Amazon OpenSearch Service.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DomainPackageDetails.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`PackageAssociationConfiguration`	`associationConfiguration()`	The configuration for associating a package with an Amazon OpenSearch Service domain.
`static DomainPackageDetails.Builder`	`builder()`
`String`	`domainName()`	Name of the domain that the package is associated with.
`DomainPackageStatus`	`domainPackageStatus()`	State of the association.
`String`	`domainPackageStatusAsString()`	State of the association.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`ErrorDetails`	`errorDetails()`	Additional information if the package is in an error state.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasPrerequisitePackageIDList()`	For responses, this returns true if the service returned a value for the PrerequisitePackageIDList property.
`Instant`	`lastUpdated()`	Timestamp of the most recent update to the package association status.
`String`	`packageID()`	Internal ID of the package.
`String`	`packageName()`	User-specified name of the package.
`PackageType`	`packageType()`	The type of package.
`String`	`packageTypeAsString()`	The type of package.
`String`	`packageVersion()`	The current version of the package.
`List<String>`	`prerequisitePackageIDList()`	A list of package IDs that must be associated with the domain before or with the package can be associated.
`String`	`referencePath()`	The relative path of the package on the OpenSearch Service cluster nodes.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DomainPackageDetails.Builder>`	`serializableBuilderClass()`
`DomainPackageDetails.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - packageID
```
public final String packageID()
```
    Internal ID of the package.
    
    Returns:
    
    Internal ID of the package.
  - packageName
```
public final String packageName()
```
    User-specified name of the package.
    
    Returns:
    
    User-specified name of the package.
  - packageType
```
public final PackageType packageType()
```
    The type of package.
    
    If the service returns an enum value that is not available in the current SDK version, packageType will return PackageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from packageTypeAsString().
    
    Returns:
    
    The type of package.
    
    See Also:
    
    PackageType
  - packageTypeAsString
```
public final String packageTypeAsString()
```
    The type of package.
    
    If the service returns an enum value that is not available in the current SDK version, packageType will return PackageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from packageTypeAsString().
    
    Returns:
    
    The type of package.
    
    See Also:
    
    PackageType
  - lastUpdated
```
public final Instant lastUpdated()
```
    Timestamp of the most recent update to the package association status.
    
    Returns:
    
    Timestamp of the most recent update to the package association status.
  - domainName
```
public final String domainName()
```
    Name of the domain that the package is associated with.
    
    Returns:
    
    Name of the domain that the package is associated with.
  - domainPackageStatus
```
public final DomainPackageStatus domainPackageStatus()
```
    State of the association.
    
    If the service returns an enum value that is not available in the current SDK version, domainPackageStatus will return DomainPackageStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainPackageStatusAsString().
    
    Returns:
    
    State of the association.
    
    See Also:
    
    DomainPackageStatus
  - domainPackageStatusAsString
```
public final String domainPackageStatusAsString()
```
    State of the association.
    
    If the service returns an enum value that is not available in the current SDK version, domainPackageStatus will return DomainPackageStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from domainPackageStatusAsString().
    
    Returns:
    
    State of the association.
    
    See Also:
    
    DomainPackageStatus
  - packageVersion
```
public final String packageVersion()
```
    The current version of the package.
    
    Returns:
    
    The current version of the package.
  - hasPrerequisitePackageIDList
```
public final boolean hasPrerequisitePackageIDList()
```
    For responses, this returns true if the service returned a value for the PrerequisitePackageIDList 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.
  - prerequisitePackageIDList
```
public final List<String> prerequisitePackageIDList()
```
    A list of package IDs that must be associated with the domain before or with the package can be associated.
    
    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 hasPrerequisitePackageIDList() method.
    
    Returns:
    
    A list of package IDs that must be associated with the domain before or with the package can be associated.
  - referencePath
```
public final String referencePath()
```
    The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.
    
    Returns:
    
    The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.
  - errorDetails
```
public final ErrorDetails errorDetails()
```
    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.
  - associationConfiguration
```
public final PackageAssociationConfiguration associationConfiguration()
```
    The configuration for associating a package with an Amazon OpenSearch Service domain.
    
    Returns:
    
    The configuration for associating a package with an Amazon OpenSearch Service domain.
  - toBuilder
```
public DomainPackageDetails.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DomainPackageDetails.Builder,DomainPackageDetails>
  - builder
```
public static DomainPackageDetails.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DomainPackageDetails.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class DomainPackageDetails

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

packageID

packageName

packageType

packageTypeAsString

lastUpdated

domainName

domainPackageStatus

domainPackageStatusAsString

packageVersion

hasPrerequisitePackageIDList

prerequisitePackageIDList

referencePath

errorDetails

associationConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField