Package software.amazon.awssdk.services.elasticsearch.model

Class DomainPackageDetails

java.lang.Object

software.amazon.awssdk.services.elasticsearch.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 on a package that is associated with a domain.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DomainPackageDetails.Builder

Method Summary

Modifier and Type	Method	Description
static DomainPackageDetails.Builder	builder()
String	domainName()	Name of the domain you've associated a package 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()
Instant	lastUpdated()	Timestamp of the most-recent update to the association status.
String	packageID()	Internal ID of the package.
String	packageName()	User specified name of the package.
PackageType	packageType()	Currently supports only TXT-DICTIONARY.
String	packageTypeAsString()	Currently supports only TXT-DICTIONARY.
String	packageVersion()	Returns the value of the PackageVersion property for this object.
String	referencePath()	The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.
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()

Currently supports only TXT-DICTIONARY.

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:

Currently supports only TXT-DICTIONARY.

See Also:

PackageType

packageTypeAsString

public final String packageTypeAsString()

Currently supports only TXT-DICTIONARY.

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:

Currently supports only TXT-DICTIONARY.

See Also:

PackageType

lastUpdated

public final Instant lastUpdated()

Timestamp of the most-recent update to the association status.

Returns:

Timestamp of the most-recent update to the association status.

domainName

public final String domainName()

Name of the domain you've associated a package with.

Returns:

Name of the domain you've associated a package with.

domainPackageStatus

public final DomainPackageStatus domainPackageStatus()

State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.

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. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.

See Also:

DomainPackageStatus

domainPackageStatusAsString

public final String domainPackageStatusAsString()

State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.

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. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.

See Also:

DomainPackageStatus

packageVersion

public final String packageVersion()

Returns the value of the PackageVersion property for this object.

Returns:

The value of the PackageVersion property for this object.

referencePath

public final String referencePath()

The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.

Returns:

The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.

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 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