Class Update
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Update.Builder,
Update>
An object representing an asynchronous update.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic Update.Builder
builder()
final Instant
The Unix epoch timestamp at object creation.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final List
<ErrorDetail> errors()
Any errors associated with aFailed
update.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Errors property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Params property.final String
id()
A UUID that is used to track the update.final List
<UpdateParam> params()
A key-value map that contains the parameters associated with the update.static Class
<? extends Update.Builder> final UpdateStatus
status()
The current status of the update.final String
The current status of the update.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 UpdateType
type()
The type of the update.final String
The type of the update.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
A UUID that is used to track the update.
- Returns:
- A UUID that is used to track the update.
-
status
The current status of the update.
If the service returns an enum value that is not available in the current SDK version,
status
will returnUpdateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the update.
- See Also:
-
statusAsString
The current status of the update.
If the service returns an enum value that is not available in the current SDK version,
status
will returnUpdateStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the update.
- See Also:
-
type
The type of the update.
If the service returns an enum value that is not available in the current SDK version,
type
will returnUpdateType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the update.
- See Also:
-
typeAsString
The type of the update.
If the service returns an enum value that is not available in the current SDK version,
type
will returnUpdateType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of the update.
- See Also:
-
hasParams
public final boolean hasParams()For responses, this returns true if the service returned a value for the Params 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. -
params
A key-value map that contains the parameters associated with the update.
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
hasParams()
method.- Returns:
- A key-value map that contains the parameters associated with the update.
-
createdAt
The Unix epoch timestamp at object creation.
- Returns:
- The Unix epoch timestamp at object creation.
-
hasErrors
public final boolean hasErrors()For responses, this returns true if the service returned a value for the Errors 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. -
errors
Any errors associated with a
Failed
update.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
hasErrors()
method.- Returns:
- Any errors associated with a
Failed
update.
-
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<Update.Builder,
Update> - 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
-