Class AffectedEntity
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AffectedEntity.Builder,
AffectedEntity>
Information about an entity that is affected by a Health event.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The 12-digit Amazon Web Services account number that contains the affected entity.static AffectedEntity.Builder
builder()
final String
The unique identifier for the entity.final String
The URL of the affected entity.final String
The ID of the affected entity.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
eventArn()
The unique identifier for the event.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Instant
The most recent time that the entity was updated.static Class
<? extends AffectedEntity.Builder> final EntityStatusCode
The most recent status of the entity affected by the event.final String
The most recent status of the entity affected by the event.tags()
A map of entity tags attached to the affected entity.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
entityArn
The unique identifier for the entity. Format:
arn:aws:health:entity-region:aws-account:entity/entity-id
. Example:arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K
- Returns:
- The unique identifier for the entity. Format:
arn:aws:health:entity-region:aws-account:entity/entity-id
. Example:arn:aws:health:us-east-1:111222333444:entity/AVh5GGT7ul1arKr1sE1K
-
eventArn
The unique identifier for the event. The event ARN has the
arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
format.For example, an event ARN might look like the following:
arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
- Returns:
- The unique identifier for the event. The event ARN has the
arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID
format.For example, an event ARN might look like the following:
arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456
-
entityValue
The ID of the affected entity.
- Returns:
- The ID of the affected entity.
-
entityUrl
The URL of the affected entity.
- Returns:
- The URL of the affected entity.
-
awsAccountId
The 12-digit Amazon Web Services account number that contains the affected entity.
- Returns:
- The 12-digit Amazon Web Services account number that contains the affected entity.
-
lastUpdatedTime
The most recent time that the entity was updated.
- Returns:
- The most recent time that the entity was updated.
-
statusCode
The most recent status of the entity affected by the event. The possible values are
IMPAIRED
,UNIMPAIRED
, andUNKNOWN
.If the service returns an enum value that is not available in the current SDK version,
statusCode()
will returnEntityStatusCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusCodeAsString()
.- Returns:
- The most recent status of the entity affected by the event. The possible values are
IMPAIRED
,UNIMPAIRED
, andUNKNOWN
. - See Also:
-
statusCodeAsString
The most recent status of the entity affected by the event. The possible values are
IMPAIRED
,UNIMPAIRED
, andUNKNOWN
.If the service returns an enum value that is not available in the current SDK version,
statusCode()
will returnEntityStatusCode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusCodeAsString()
.- Returns:
- The most recent status of the entity affected by the event. The possible values are
IMPAIRED
,UNIMPAIRED
, andUNKNOWN
. - See Also:
-
hasTags
public final boolean hasTags()For responses, this returns true if the service returned a value for the Tags 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. -
tags
A map of entity tags attached to the affected entity.
Currently, the
tags
property isn't supported.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
hasTags()
method.- Returns:
- A map of entity tags attached to the affected entity.
Currently, the
tags
property isn't supported.
-
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<AffectedEntity.Builder,
AffectedEntity> - 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
-