software.amazon.awssdk.services.elasticsearch.model

Class GetUpgradeStatusResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.elasticsearch.model.ElasticsearchResponse

software.amazon.awssdk.services.elasticsearch.model.GetUpgradeStatusResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetUpgradeStatusResponse.Builder,GetUpgradeStatusResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetUpgradeStatusResponse
extends ElasticsearchResponse
implements ToCopyableBuilder<GetUpgradeStatusResponse.Builder,GetUpgradeStatusResponse>

Container for response returned by GetUpgradeStatus operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetUpgradeStatusResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetUpgradeStatusResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends GetUpgradeStatusResponse.Builder>	serializableBuilderClass()
UpgradeStatus	stepStatus() One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object.
String	stepStatusAsString() One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object.
GetUpgradeStatusResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	upgradeName() A string that describes the update briefly
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

Methods inherited from class software.amazon.awssdk.services.elasticsearch.model.ElasticsearchResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

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

stepStatus

public final UpgradeStatus stepStatus()

One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object. 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, stepStatus will return UpgradeStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stepStatusAsString().

Returns:

One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values:

• In Progress
• Succeeded
• Succeeded with Issues
• Failed

See Also:

UpgradeStatus

stepStatusAsString

public final String stepStatusAsString()

One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object. 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, stepStatus will return UpgradeStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stepStatusAsString().

Returns:

One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values:

• In Progress
• Succeeded
• Succeeded with Issues
• Failed

See Also:

UpgradeStatus

upgradeName

public final String upgradeName()

A string that describes the update briefly

Returns:

A string that describes the update briefly

toBuilder

public GetUpgradeStatusResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetUpgradeStatusResponse.Builder,GetUpgradeStatusResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetUpgradeStatusResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo