Package software.amazon.awssdk.services.health.model

Class AffectedEntity

    • Method Detail

      • entityArn

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

        public final String entityValue()

        The ID of the affected entity.

        Returns:
        The ID of the affected entity.

      • entityUrl

        public final String entityUrl()

        The URL of the affected entity.

        Returns:
        The URL of the affected entity.

      • awsAccountId

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

        public final Instant lastUpdatedTime()

        The most recent time that the entity was updated.

        Returns:
        The most recent time that the entity was updated.

      • statusCode

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

      • 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 the isEmpty() 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

        public final Map<String,​String> 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.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • toString

        public final 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 final <T> Optional<T> getValueForField​(String fieldName,
                                              Class<T> clazz)