Class UpgradeHistory
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<UpgradeHistory.Builder,
UpgradeHistory>
History of the last 10 upgrades and upgrade eligibility checks for an Amazon OpenSearch Service domain.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic UpgradeHistory.Builder
builder()
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) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the StepsList property.static Class
<? extends UpgradeHistory.Builder> final Instant
UTC timestamp at which the upgrade API call was made, in the formatyyyy-MM-ddTHH:mm:ssZ
.final List
<UpgradeStepItem> A list of each step performed as part of a specific upgrade or upgrade eligibility check.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 upgrade.final UpgradeStatus
The current status of the upgrade.final String
The current status of the upgrade.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
upgradeName
A string that describes the upgrade.
- Returns:
- A string that describes the upgrade.
-
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
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 returnUpgradeStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromupgradeStatusAsString()
.- 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:
-
-
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 returnUpgradeStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromupgradeStatusAsString()
.- 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:
-
-
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 theisEmpty()
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
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
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<UpgradeHistory.Builder,
UpgradeHistory> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-