Class GetHealthEventResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetHealthEventResponse.Builder,
GetHealthEventResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
The time when a health event was created.final Instant
endedAt()
The time when a health event was resolved.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
eventArn()
The Amazon Resource Name (ARN) of the event.final String
eventId()
The internally-generated identifier of a health event.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ImpactedLocations property.final Double
The threshold percentage for a health score that determines, along with other configuration information, when Internet Monitor creates a health event when there's an internet issue that affects your application end users.final List
<ImpactedLocation> The locations affected by a health event.final HealthEventImpactType
The type of impairment of a specific health event.final String
The type of impairment of a specific health event.final Instant
The time when a health event was last updated or recalculated.final Double
The impact on total traffic that a health event has, in increased latency or reduced availability.static Class
<? extends GetHealthEventResponse.Builder> final Instant
The time when a health event started.final HealthEventStatus
status()
The status of a health event.final String
The status of a health event.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 class software.amazon.awssdk.services.internetmonitor.model.InternetMonitorResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
eventArn
The Amazon Resource Name (ARN) of the event.
- Returns:
- The Amazon Resource Name (ARN) of the event.
-
eventId
The internally-generated identifier of a health event.
- Returns:
- The internally-generated identifier of a health event.
-
startedAt
The time when a health event started.
- Returns:
- The time when a health event started.
-
endedAt
The time when a health event was resolved. If the health event is still active, the end time is not set.
- Returns:
- The time when a health event was resolved. If the health event is still active, the end time is not set.
-
createdAt
The time when a health event was created.
- Returns:
- The time when a health event was created.
-
lastUpdatedAt
The time when a health event was last updated or recalculated.
- Returns:
- The time when a health event was last updated or recalculated.
-
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
The locations affected by a 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 affected by a health event.
-
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 returnHealthEventStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of a health event.
- See Also:
-
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 returnHealthEventStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of a health event.
- See Also:
-
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
The type of impairment of a specific health event.
If the service returns an enum value that is not available in the current SDK version,
impactType
will returnHealthEventImpactType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromimpactTypeAsString()
.- Returns:
- The type of impairment of a specific health event.
- See Also:
-
impactTypeAsString
The type of impairment of a specific health event.
If the service returns an enum value that is not available in the current SDK version,
impactType
will returnHealthEventImpactType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromimpactTypeAsString()
.- Returns:
- The type of impairment of a specific health event.
- See Also:
-
healthScoreThreshold
The threshold percentage for a health score that determines, along with other configuration information, when Internet Monitor creates a health event when there's an internet issue that affects your application end users.
- Returns:
- The threshold percentage for a health score that determines, along with other configuration information, when Internet Monitor creates a health event when there's an internet issue that affects your application end users.
-
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<GetHealthEventResponse.Builder,
GetHealthEventResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-