Class GetUpgradeStatusResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetUpgradeStatusResponse.Builder,
GetUpgradeStatusResponse>
Container for response returned by GetUpgradeStatus
operation.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
static Class
<? extends GetUpgradeStatusResponse.Builder> final UpgradeStatus
One of 4 statuses that a step can go through returned as part of theGetUpgradeStatusResponse
object.final String
One of 4 statuses that a step can go through returned as part of theGetUpgradeStatusResponse
object.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
A string that describes the update brieflyfinal UpgradeStep
Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through: PreUpgradeCheck Snapshot Upgradefinal String
Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through: PreUpgradeCheck Snapshot UpgradeMethods inherited from class software.amazon.awssdk.services.elasticsearch.model.ElasticsearchResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnUpgradeStep.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromupgradeStepAsString()
.- Returns:
- Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:
- PreUpgradeCheck
- Snapshot
- Upgrade
- See Also:
-
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 returnUpgradeStep.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromupgradeStepAsString()
.- Returns:
- Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:
- PreUpgradeCheck
- Snapshot
- Upgrade
- See Also:
-
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 returnUpgradeStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstepStatusAsString()
.- 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:
-
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 returnUpgradeStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstepStatusAsString()
.- 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:
-
upgradeName
A string that describes the update briefly
- Returns:
- A string that describes the update briefly
-
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 interfaceToCopyableBuilder<GetUpgradeStatusResponse.Builder,
GetUpgradeStatusResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-