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

Class UpgradeStepItem

java.lang.Object

software.amazon.awssdk.services.opensearch.model.UpgradeStepItem

All Implemented Interfaces:

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

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

Represents a single step of an upgrade or upgrade eligibility check workflow.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpgradeStepItem.Builder

Method Summary

Modifier and Type	Method	Description
static UpgradeStepItem.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasIssues()	For responses, this returns true if the service returned a value for the Issues property.
List<String>	issues()	A list of strings containing detailed information about the errors encountered in a particular step.
Double	progressPercent()	The floating point value representing the progress percentage of a particular step.
List<SdkField<?>>	sdkFields()
static Class<? extends UpgradeStepItem.Builder>	serializableBuilderClass()
UpgradeStepItem.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
UpgradeStep	upgradeStep()	One of three steps that an upgrade or upgrade eligibility check goes through:
String	upgradeStepAsString()	One of three steps that an upgrade or upgrade eligibility check goes through:
UpgradeStatus	upgradeStepStatus()	The current status of the upgrade.
String	upgradeStepStatusAsString()	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

upgradeStep

public final UpgradeStep upgradeStep()

One of three steps that an upgrade or upgrade eligibility check goes through:

• PreUpgradeCheck

• Snapshot

• Upgrade

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

Returns:

One of three steps that an upgrade or upgrade eligibility check goes through:

• PreUpgradeCheck

• Snapshot

• Upgrade

See Also:

UpgradeStep

upgradeStepAsString

public final String upgradeStepAsString()

One of three steps that an upgrade or upgrade eligibility check goes through:

• PreUpgradeCheck

• Snapshot

• Upgrade

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

Returns:

One of three steps that an upgrade or upgrade eligibility check goes through:

• PreUpgradeCheck

• Snapshot

• Upgrade

See Also:

UpgradeStep

upgradeStepStatus

public final UpgradeStatus upgradeStepStatus()

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, upgradeStepStatus will return UpgradeStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from upgradeStepStatusAsString().

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

upgradeStepStatusAsString

public final String upgradeStepStatusAsString()

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, upgradeStepStatus will return UpgradeStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from upgradeStepStatusAsString().

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

hasIssues

public final boolean hasIssues()

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

issues

public final List<String> issues()

A list of strings containing detailed information about the errors encountered in a particular step.

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

Returns:

A list of strings containing detailed information about the errors encountered in a particular step.

progressPercent

public final Double progressPercent()

The floating point value representing the progress percentage of a particular step.

Returns:

The floating point value representing the progress percentage of a particular step.

toBuilder

public UpgradeStepItem.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpgradeStepItem.Builder,UpgradeStepItem>

builder

public static UpgradeStepItem.Builder builder()

serializableBuilderClass

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