Class ChangeEvent
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ChangeEvent.Builder,
ChangeEvent>
A structure that contains information about a change event that occurred for a service, such as a deployment or configuration change.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal String
The Amazon Web Services account ID where this change event occurred.static ChangeEvent.Builder
builder()
final ChangeEventType
The type of change event that occurred, such asDEPLOYMENT
.final String
The type of change event that occurred, such asDEPLOYMENT
.entity()
The entity (service or resource) that was affected by this change event, including its key attributes.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
eventId()
A unique identifier for this change event.final String
The name or description of this change event.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 Entity property.final int
hashCode()
final String
region()
The Amazon Web Services region where this change event occurred.static Class
<? extends ChangeEvent.Builder> final Instant
The timestamp when this change event occurred.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
userName()
The name of the user who initiated this change event, if available.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
timestamp
The timestamp when this change event occurred. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.
- Returns:
- The timestamp when this change event occurred. When used in a raw HTTP Query API, it is formatted as epoch time in seconds.
-
accountId
The Amazon Web Services account ID where this change event occurred.
- Returns:
- The Amazon Web Services account ID where this change event occurred.
-
region
The Amazon Web Services region where this change event occurred.
- Returns:
- The Amazon Web Services region where this change event occurred.
-
hasEntity
public final boolean hasEntity()For responses, this returns true if the service returned a value for the Entity 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. -
entity
The entity (service or resource) that was affected by this change event, including its key attributes.
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
hasEntity()
method.- Returns:
- The entity (service or resource) that was affected by this change event, including its key attributes.
-
changeEventType
The type of change event that occurred, such as
DEPLOYMENT
.If the service returns an enum value that is not available in the current SDK version,
changeEventType
will returnChangeEventType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchangeEventTypeAsString()
.- Returns:
- The type of change event that occurred, such as
DEPLOYMENT
. - See Also:
-
changeEventTypeAsString
The type of change event that occurred, such as
DEPLOYMENT
.If the service returns an enum value that is not available in the current SDK version,
changeEventType
will returnChangeEventType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchangeEventTypeAsString()
.- Returns:
- The type of change event that occurred, such as
DEPLOYMENT
. - See Also:
-
eventId
A unique identifier for this change event.
- Returns:
- A unique identifier for this change event.
-
userName
The name of the user who initiated this change event, if available.
- Returns:
- The name of the user who initiated this change event, if available.
-
eventName
The name or description of this change event.
- Returns:
- The name or description of this change event.
-
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<ChangeEvent.Builder,
ChangeEvent> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
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
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-