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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceHealthEvent.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static HealthEvent.Builderbuilder()InstantcreatedAt()When the health event was created.InstantendedAt()The time when a health event ended.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringeventArn()The Amazon Resource Name (ARN) of the event.StringeventId()The internally-generated identifier of a specific network traffic impairment health event.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasImpactedLocations()For responses, this returns true if the service returned a value for the ImpactedLocations property.DoublehealthScoreThreshold()The value of the threshold percentage for performance or availability that was configured when Amazon CloudWatch Internet Monitor created the health event.List<ImpactedLocation>impactedLocations()The locations impacted by the health event.HealthEventImpactTypeimpactType()The type of impairment for a health event.StringimpactTypeAsString()The type of impairment for a health event.InstantlastUpdatedAt()When the health event was last updated.DoublepercentOfTotalTrafficImpacted()The impact on total traffic that a health event has, in increased latency or reduced availability.List<SdkField<?>>sdkFields()static Class<? extends HealthEvent.Builder>serializableBuilderClass()InstantstartedAt()When a health event started.HealthEventStatusstatus()Health event list member.StringstatusAsString()Health event list member.HealthEvent.BuildertoBuilder()StringtoString()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
-
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 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.
-
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()
Health event list member.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnHealthEventStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- Health event list member.
- See Also:
HealthEventStatus
-
statusAsString
public final String statusAsString()
Health event list member.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnHealthEventStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- Health event list member.
- See Also:
HealthEventStatus
-
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,
impactTypewill returnHealthEventImpactType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromimpactTypeAsString().- Returns:
- The type of impairment for a health event.
- See Also:
HealthEventImpactType
-
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,
impactTypewill returnHealthEventImpactType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromimpactTypeAsString().- Returns:
- The type of impairment for a health event.
- See Also:
HealthEventImpactType
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<HealthEvent.Builder,HealthEvent>
-
builder
public static HealthEvent.Builder builder()
-
serializableBuilderClass
public static Class<? extends HealthEvent.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-