software.amazon.awssdk.services.xray.model

Class InsightEvent

java.lang.Object

software.amazon.awssdk.services.xray.model.InsightEvent

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InsightEvent.Builder,InsightEvent>

@Generated(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InsightEvent.Builder

Method Summary

Modifier and Type	Method and Description
static InsightEvent.Builder	builder()
RequestImpactStatistics	clientRequestImpactStatistics() The impact statistics of the client side service.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Instant	eventTime() The time, in Unix seconds, at which the event was recorded.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTopAnomalousServices() For responses, this returns true if the service returned a value for the TopAnomalousServices property.
RequestImpactStatistics	rootCauseServiceRequestImpactStatistics() The impact statistics of the root cause service.
List<SdkField<?>>	sdkFields()
static Class<? extends InsightEvent.Builder>	serializableBuilderClass()
String	summary() A brief description of the event.
InsightEvent.Builder	toBuilder()
List<AnomalousService>	topAnomalousServices() The service during the event that is most impacted by the incident.
String	toString() 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

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()

Specified by:

toBuilder in interface ToCopyableBuilder<InsightEvent.Builder,InsightEvent>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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