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>

  • 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 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 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 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, 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 of a specific 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 of a specific health event.
      See Also:

    • 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, impactType will return HealthEventImpactType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from impactTypeAsString().

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

    • 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()
      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<GetHealthEventResponse.Builder,GetHealthEventResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetHealthEventResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      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.