software.amazon.awssdk.services.opensearch.model

Class PackageDetails

java.lang.Object

software.amazon.awssdk.services.opensearch.model.PackageDetails

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PackageDetails.Builder,PackageDetails>

@Generated(value="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 and Description
static interface	PackageDetails.Builder

Method Summary

Modifier and Type	Method and Description
String	availablePackageVersion() The package version.
static PackageDetails.Builder	builder()
Instant	createdAt() The timestamp when the package was created.
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()
Instant	lastUpdatedAt() Date and time when the package was last updated.
String	packageDescription() User-specified description of the package.
String	packageID() The unique identifier of the package.
String	packageName() The user-specified name of the package.
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.
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.

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