Class InsightEvent

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

X-Ray reevaluates insights periodically until they are resolved, and records each intermediate state in an event. You can review incident events in the Impact Timeline on the Inspect page in the X-Ray console.

See Also:

  • Method Details

    • summary

      public final String summary()

      A brief description of the event.

      Returns:
      A brief description of the event.

    • eventTime

      public final Instant eventTime()

      The time, in Unix seconds, at which the event was recorded.

      Returns:
      The time, in Unix seconds, at which the event was recorded.

    • clientRequestImpactStatistics

      public final RequestImpactStatistics clientRequestImpactStatistics()

      The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay.

      Returns:
      The impact statistics of the client side service. This includes the number of requests to the client service and whether the requests were faults or okay.

    • rootCauseServiceRequestImpactStatistics

      public final RequestImpactStatistics rootCauseServiceRequestImpactStatistics()

      The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay.

      Returns:
      The impact statistics of the root cause service. This includes the number of requests to the client service and whether the requests were faults or okay.

    • hasTopAnomalousServices

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

    • topAnomalousServices

      public final List<AnomalousService> topAnomalousServices()

      The service during the event that is most impacted by the incident.

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

      Returns:
      The service during the event that is most impacted by the incident.

    • toBuilder

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

    • builder

      public static InsightEvent.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InsightEvent.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.