Package software.amazon.awssdk.services.opensearch.model

Class UpgradeHistory

java.lang.Object

software.amazon.awssdk.services.opensearch.model.UpgradeHistory

All Implemented Interfaces:

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

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

History of the last 10 upgrades and upgrade eligibility checks for an Amazon OpenSearch Service domain.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpgradeHistory.Builder

Method Summary

Modifier and Type	Method	Description
static UpgradeHistory.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStepsList()	For responses, this returns true if the service returned a value for the StepsList property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpgradeHistory.Builder>	serializableBuilderClass()
Instant	startTimestamp()	UTC timestamp at which the upgrade API call was made, in the format yyyy-MM-ddTHH:mm:ssZ.
List<UpgradeStepItem>	stepsList()	A list of each step performed as part of a specific upgrade or upgrade eligibility check.
UpgradeHistory.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	upgradeName()	A string that describes the upgrade.
UpgradeStatus	upgradeStatus()	The current status of the upgrade.
String	upgradeStatusAsString()	The current status of the upgrade.

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

upgradeName

public final String upgradeName()

A string that describes the upgrade.

Returns:

A string that describes the upgrade.

startTimestamp

public final Instant startTimestamp()

UTC timestamp at which the upgrade API call was made, in the format yyyy-MM-ddTHH:mm:ssZ.

Returns:

UTC timestamp at which the upgrade API call was made, in the format yyyy-MM-ddTHH:mm:ssZ.

upgradeStatus

public final UpgradeStatus upgradeStatus()

The current status of the upgrade. The status can take one of the following values:

• In Progress

• Succeeded

• Succeeded with Issues

• Failed

If the service returns an enum value that is not available in the current SDK version, upgradeStatus will return UpgradeStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from upgradeStatusAsString().

Returns:

The current status of the upgrade. The status can take one of the following values:

• In Progress

• Succeeded

• Succeeded with Issues

• Failed

See Also:

UpgradeStatus

upgradeStatusAsString

public final String upgradeStatusAsString()

The current status of the upgrade. The status can take one of the following values:

• In Progress

• Succeeded

• Succeeded with Issues

• Failed

If the service returns an enum value that is not available in the current SDK version, upgradeStatus will return UpgradeStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from upgradeStatusAsString().

Returns:

The current status of the upgrade. The status can take one of the following values:

• In Progress

• Succeeded

• Succeeded with Issues

• Failed

See Also:

UpgradeStatus

hasStepsList

public final boolean hasStepsList()

For responses, this returns true if the service returned a value for the StepsList 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.

stepsList

public final List<UpgradeStepItem> stepsList()

A list of each step performed as part of a specific upgrade or upgrade eligibility check.

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 hasStepsList() method.

Returns:

A list of each step performed as part of a specific upgrade or upgrade eligibility check.

toBuilder

public UpgradeHistory.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpgradeHistory.Builder,UpgradeHistory>

builder

public static UpgradeHistory.Builder builder()

serializableBuilderClass

public static Class<? extends UpgradeHistory.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