software.amazon.awssdk.services.elasticsearch.model

Class UpgradeStepItem

java.lang.Object

software.amazon.awssdk.services.elasticsearch.model.UpgradeStepItem

All Implemented Interfaces:

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

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

Represents a single step of the Upgrade or Upgrade Eligibility Check workflow.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpgradeStepItem.Builder

Method Summary

Modifier and Type	Method and Description
static UpgradeStepItem.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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 progress percentage of a particular step.
List<SdkField<?>>	sdkFields()
static Class<? extends UpgradeStepItem.Builder>	serializableBuilderClass()
UpgradeStepItem.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
UpgradeStep	upgradeStep() Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through: PreUpgradeCheck Snapshot Upgrade
String	upgradeStepAsString() Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through: PreUpgradeCheck Snapshot Upgrade
UpgradeStatus	upgradeStepStatus() The status of a particular step during an upgrade.
String	upgradeStepStatusAsString() The status of a particular step during an upgrade.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

upgradeStep

public UpgradeStep upgradeStep()

Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does 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:

Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

• PreUpgradeCheck
• Snapshot
• Upgrade

See Also:

UpgradeStep

upgradeStepAsString

public String upgradeStepAsString()

Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does 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:

Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

• PreUpgradeCheck
• Snapshot
• Upgrade

See Also:

UpgradeStep

upgradeStepStatus

public UpgradeStatus upgradeStepStatus()

The status of a particular step during an 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 status of a particular step during an upgrade. The status can take one of the following values:

• In Progress
• Succeeded
• Succeeded with Issues
• Failed

See Also:

UpgradeStatus

upgradeStepStatusAsString

public String upgradeStepStatusAsString()

The status of a particular step during an 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 status of a particular step during an upgrade. The status can take one of the following values:

• In Progress
• Succeeded
• Succeeded with Issues
• Failed

See Also:

UpgradeStatus

issues

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

Returns:

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

progressPercent

public Double progressPercent()

The Floating point value representing progress percentage of a particular step.

Returns:

The Floating point value representing progress percentage of a particular step.

toBuilder

public UpgradeStepItem.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UpgradeStepItem.Builder,UpgradeStepItem>

Returns:

a builder for type T

builder

public static UpgradeStepItem.Builder builder()

serializableBuilderClass

public static Class<? extends UpgradeStepItem.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.