software.amazon.awssdk.services.health.model

Class AffectedEntity

java.lang.Object

software.amazon.awssdk.services.health.model.AffectedEntity

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AffectedEntity.Builder,AffectedEntity>

@Generated(value="software.amazon.awssdk:codegen")
public final class AffectedEntity
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AffectedEntity.Builder,AffectedEntity>

Information about an entity that is affected by a Health event.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AffectedEntity.Builder

Method Summary

Modifier and Type	Method and Description
String	awsAccountId() The 12-digit AWS account number that contains the affected entity.
static AffectedEntity.Builder	builder()
String	entityArn() The unique identifier for the entity.
String	entityUrl() Returns the value of the EntityUrl property for this object.
String	entityValue() The ID of the affected entity.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	eventArn() The unique identifier for the event.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastUpdatedTime() The most recent time that the entity was updated.
List<SdkField<?>>	sdkFields()
static Class<? extends AffectedEntity.Builder>	serializableBuilderClass()
EntityStatusCode	statusCode() The most recent status of the entity affected by the event.
String	statusCodeAsString() The most recent status of the entity affected by the event.
Map<String,String>	tags() A map of entity tags attached to the affected entity.
AffectedEntity.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

entityArn

public String 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

public String eventArn()

The unique identifier for the event. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: 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. Format: arn:aws:health:event-region::event/SERVICE/EVENT_TYPE_CODE/EVENT_TYPE_PLUS_ID . Example: Example: arn:aws:health:us-east-1::event/EC2/EC2_INSTANCE_RETIREMENT_SCHEDULED/EC2_INSTANCE_RETIREMENT_SCHEDULED_ABC123-DEF456

entityValue

public String entityValue()

The ID of the affected entity.

Returns:

The ID of the affected entity.

entityUrl

public String entityUrl()

Returns the value of the EntityUrl property for this object.

Returns:

The value of the EntityUrl property for this object.

awsAccountId

public String awsAccountId()

The 12-digit AWS account number that contains the affected entity.

Returns:

The 12-digit AWS account number that contains the affected entity.

lastUpdatedTime

public Instant lastUpdatedTime()

The most recent time that the entity was updated.

Returns:

The most recent time that the entity was updated.

statusCode

public EntityStatusCode statusCode()

The most recent status of the entity affected by the event. The possible values are IMPAIRED, UNIMPAIRED, and UNKNOWN.

If the service returns an enum value that is not available in the current SDK version, statusCode() will return EntityStatusCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusCodeAsString().

Returns:

The most recent status of the entity affected by the event. The possible values are IMPAIRED , UNIMPAIRED, and UNKNOWN.

See Also:

EntityStatusCode

statusCodeAsString

public String statusCodeAsString()

The most recent status of the entity affected by the event. The possible values are IMPAIRED, UNIMPAIRED, and UNKNOWN.

If the service returns an enum value that is not available in the current SDK version, statusCode() will return EntityStatusCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusCodeAsString().

Returns:

The most recent status of the entity affected by the event. The possible values are IMPAIRED , UNIMPAIRED, and UNKNOWN.

See Also:

EntityStatusCode

tags

public Map<String,String> tags()

A map of entity tags attached to the affected entity.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

A map of entity tags attached to the affected entity.

toBuilder

public AffectedEntity.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AffectedEntity.Builder,AffectedEntity>

builder

public static AffectedEntity.Builder builder()

serializableBuilderClass

public static Class<? extends AffectedEntity.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String 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.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo