Class HealthEvent

java.lang.Object
software.amazon.awssdk.services.internetmonitor.model.HealthEvent
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<HealthEvent.Builder,HealthEvent>
@Generated("software.amazon.awssdk:codegen") public final class HealthEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HealthEvent.Builder,HealthEvent>

Information about a health event created in a monitor in Amazon CloudWatch Internet Monitor.

See Also:

  • Method Details

    • eventArn

      public final String eventArn()

      The Amazon Resource Name (ARN) of the event.

      Returns:
      The Amazon Resource Name (ARN) of the event.

    • eventId

      public final String eventId()

      The internally-generated identifier of a specific network traffic impairment health event.

      Returns:
      The internally-generated identifier of a specific network traffic impairment health event.

    • startedAt

      public final Instant startedAt()

      When a health event started.

      Returns:
      When a health event started.

    • endedAt

      public final Instant endedAt()

      The time when a health event ended. If the health event is still active, then the end time is not set.

      Returns:
      The time when a health event ended. If the health event is still active, then the end time is not set.

    • createdAt

      public final Instant createdAt()

      When the health event was created.

      Returns:
      When the health event was created.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      When the health event was last updated.

      Returns:
      When the health event was last updated.

    • hasImpactedLocations

      public final boolean hasImpactedLocations()
      For responses, this returns true if the service returned a value for the ImpactedLocations 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.

    • impactedLocations

      public final List<ImpactedLocation> impactedLocations()

      The locations impacted by the health event.

      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 hasImpactedLocations() method.

      Returns:
      The locations impacted by the health event.

    • status

      public final HealthEventStatus status()

      The status of a health event.

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

      Returns:
      The status of a health event.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of a health event.

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

      Returns:
      The status of a health event.
      See Also:

    • percentOfTotalTrafficImpacted

      public final Double percentOfTotalTrafficImpacted()

      The impact on total traffic that a health event has, in increased latency or reduced availability. This is the percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this client location to the Amazon Web Services location using this client network.

      Returns:
      The impact on total traffic that a health event has, in increased latency or reduced availability. This is the percentage of how much latency has increased or availability has decreased during the event, compared to what is typical for traffic from this client location to the Amazon Web Services location using this client network.

    • impactType

      public final HealthEventImpactType impactType()

      The type of impairment for a health event.

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

      Returns:
      The type of impairment for a health event.
      See Also:

    • impactTypeAsString

      public final String impactTypeAsString()

      The type of impairment for a health event.

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

      Returns:
      The type of impairment for a health event.
      See Also:

    • healthScoreThreshold

      public final Double healthScoreThreshold()

      The value of the threshold percentage for performance or availability that was configured when Amazon CloudWatch Internet Monitor created the health event.

      Returns:
      The value of the threshold percentage for performance or availability that was configured when Amazon CloudWatch Internet Monitor created the health event.

    • toBuilder

      public HealthEvent.Builder 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 interface ToCopyableBuilder<HealthEvent.Builder,HealthEvent>
      Returns:
      a builder for type T

    • builder

      public static HealthEvent.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.