Class GetHealthEventResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.internetmonitor.model.InternetMonitorResponse
-
- software.amazon.awssdk.services.internetmonitor.model.GetHealthEventResponse
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<GetHealthEventResponse.Builder,GetHealthEventResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetHealthEventResponse extends InternetMonitorResponse implements ToCopyableBuilder<GetHealthEventResponse.Builder,GetHealthEventResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetHealthEventResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GetHealthEventResponse.Builderbuilder()InstantcreatedAt()The time when a health event was created.InstantendedAt()The time when a health event was resolved.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)StringeventArn()The Amazon Resource Name (ARN) of the event.StringeventId()The internally-generated identifier of a 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 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.List<ImpactedLocation>impactedLocations()The locations affected by a health event.HealthEventImpactTypeimpactType()The type of impairment of a specific health event.StringimpactTypeAsString()The type of impairment of a specific health event.InstantlastUpdatedAt()The time when a health event was last updated or recalculated.DoublepercentOfTotalTrafficImpacted()The impact on total traffic that a health event has, in increased latency or reduced availability.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends GetHealthEventResponse.Builder>serializableBuilderClass()InstantstartedAt()The time when a health event started.HealthEventStatusstatus()The status of a health event.StringstatusAsString()The status of a health event.GetHealthEventResponse.BuildertoBuilder()StringtoString()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 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 health event.
- Returns:
- The internally-generated identifier of a health event.
-
startedAt
public final Instant startedAt()
The time when a health event started.
- Returns:
- The time when a health event started.
-
endedAt
public final Instant 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
public final Instant createdAt()
The time when a health event was created.
- Returns:
- The time when a health event was created.
-
lastUpdatedAt
public final Instant 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
public final List<ImpactedLocation> 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
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,
statuswill returnHealthEventStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of a health event.
- See Also:
HealthEventStatus
-
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,
statuswill returnHealthEventStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of a health event.
- 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 of a specific 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 of a specific health event.
- See Also:
HealthEventImpactType
-
impactTypeAsString
public final String 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,
impactTypewill 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:
HealthEventImpactType
-
healthScoreThreshold
public final Double 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
public GetHealthEventResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GetHealthEventResponse.Builder,GetHealthEventResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static GetHealthEventResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetHealthEventResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-