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

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

@Generated("software.amazon.awssdk:codegen")
public final class PackageDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PackageDetails.Builder,PackageDetails>

Basic information about a package.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface PackageDetails.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<String>`	`allowListedUserList()`	A list of users who are allowed to view and associate the package.
`PackageConfiguration`	`availablePackageConfiguration()`	This represents the available configuration parameters for the package.
`String`	`availablePackageVersion()`	The package version.
`PluginProperties`	`availablePluginProperties()`	If the package is a `ZIP-PLUGIN` package, additional information about plugin properties.
`static PackageDetails.Builder`	`builder()`
`Instant`	`createdAt()`	The timestamp when the package was created.
`String`	`engineVersion()`	Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y.
`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)`
`boolean`	`hasAllowListedUserList()`	For responses, this returns true if the service returned a value for the AllowListedUserList property.
`int`	`hashCode()`
`Instant`	`lastUpdatedAt()`	Date and time when the package was last updated.
`String`	`packageDescription()`	User-specified description of the package.
`PackageEncryptionOptions`	`packageEncryptionOptions()`	Encryption options for a package.
`String`	`packageID()`	The unique identifier of the package.
`String`	`packageName()`	The user-specified name of the package.
`String`	`packageOwner()`	The owner of the package who is allowed to create and update a package and add users to the package scope.
`PackageStatus`	`packageStatus()`	The current status of the package.
`String`	`packageStatusAsString()`	The current status of the package.
`PackageType`	`packageType()`	The type of package.
`String`	`packageTypeAsString()`	The type of package.
`PackageVendingOptions`	`packageVendingOptions()`	Package Vending Options for a package.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PackageDetails.Builder>`	`serializableBuilderClass()`
`PackageDetails.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()
```
    The unique identifier of the package.
    
    Returns:
    
    The unique identifier of the package.
  - packageName
```
public final String packageName()
```
    The user-specified name of the package.
    
    Returns:
    
    The 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
  - packageDescription
```
public final String packageDescription()
```
    User-specified description of the package.
    
    Returns:
    
    User-specified description of the package.
  - packageStatus
```
public final PackageStatus packageStatus()
```
    The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING, and DELETE_FAILED.
    
    If the service returns an enum value that is not available in the current SDK version, packageStatus will return PackageStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from packageStatusAsString().
    
    Returns:
    
    The current status of the package. The available options are AVAILABLE, COPYING , COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING , and DELETE_FAILED.
    
    See Also:
    
    PackageStatus
  - packageStatusAsString
```
public final String packageStatusAsString()
```
    The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING, and DELETE_FAILED.
    
    If the service returns an enum value that is not available in the current SDK version, packageStatus will return PackageStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from packageStatusAsString().
    
    Returns:
    
    The current status of the package. The available options are AVAILABLE, COPYING , COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING , and DELETE_FAILED.
    
    See Also:
    
    PackageStatus
  - createdAt
```
public final Instant createdAt()
```
    The timestamp when the package was created.
    
    Returns:
    
    The timestamp when the package was created.
  - lastUpdatedAt
```
public final Instant lastUpdatedAt()
```
    Date and time when the package was last updated.
    
    Returns:
    
    Date and time when the package was last updated.
  - availablePackageVersion
```
public final String availablePackageVersion()
```
    The package version.
    
    Returns:
    
    The package version.
  - 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.
  - engineVersion
```
public final String engineVersion()
```
    Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
    
    Returns:
    
    Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
  - availablePluginProperties
```
public final PluginProperties availablePluginProperties()
```
    If the package is a ZIP-PLUGIN package, additional information about plugin properties.
    
    Returns:
    
    If the package is a ZIP-PLUGIN package, additional information about plugin properties.
  - availablePackageConfiguration
```
public final PackageConfiguration availablePackageConfiguration()
```
    This represents the available configuration parameters for the package.
    
    Returns:
    
    This represents the available configuration parameters for the package.
  - hasAllowListedUserList
```
public final boolean hasAllowListedUserList()
```
    For responses, this returns true if the service returned a value for the AllowListedUserList 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.
  - allowListedUserList
```
public final List<String> allowListedUserList()
```
    A list of users who are allowed to view and associate the package. This field is only visible to the owner of a package.
    
    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 hasAllowListedUserList() method.
    
    Returns:
    
    A list of users who are allowed to view and associate the package. This field is only visible to the owner of a package.
  - packageOwner
```
public final String packageOwner()
```
    The owner of the package who is allowed to create and update a package and add users to the package scope.
    
    Returns:
    
    The owner of the package who is allowed to create and update a package and add users to the package scope.
  - packageVendingOptions
```
public final PackageVendingOptions packageVendingOptions()
```
    Package Vending Options for a package.
    
    Returns:
    
    Package Vending Options for a package.
  - packageEncryptionOptions
```
public final PackageEncryptionOptions packageEncryptionOptions()
```
    Encryption options for a package.
    
    Returns:
    
    Encryption options for a package.
  - toBuilder
```
public PackageDetails.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PackageDetails.Builder,PackageDetails>
  - builder
```
public static PackageDetails.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PackageDetails.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 PackageDetails

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

packageDescription

packageStatus

packageStatusAsString

createdAt

lastUpdatedAt

availablePackageVersion

errorDetails

engineVersion

availablePluginProperties

availablePackageConfiguration

hasAllowListedUserList

allowListedUserList

packageOwner

packageVendingOptions

packageEncryptionOptions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField