Insight (AWS Java SDK :: Services :: AWS X-Ray 2.16.76 API)

java.lang.Object
- software.amazon.awssdk.services.xray.model.Insight

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Insight.Builder,Insight>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Insight
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Insight.Builder,Insight>
```
When fault rates go outside of the expected range, X-Ray creates an insight. Insights tracks emergent issues within your applications.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Insight.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Insight.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Insight.Builder`	`builder()`
`List<InsightCategory>`	`categories()` The categories that label and describe the type of insight.
`List<String>`	`categoriesAsStrings()` The categories that label and describe the type of insight.
`RequestImpactStatistics`	`clientRequestImpactStatistics()` The impact statistics of the client side service.
`Instant`	`endTime()` The time, in Unix seconds, at which the insight ended.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`groupARN()` The Amazon Resource Name (ARN) of the group that the insight belongs to.
`String`	`groupName()` The name of the group that the insight belongs to.
`boolean`	`hasCategories()` Returns true if the Categories property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasTopAnomalousServices()` Returns true if the TopAnomalousServices property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`String`	`insightId()` The insights unique identifier.
`ServiceId`	`rootCauseServiceId()` Returns the value of the RootCauseServiceId property for this object.
`RequestImpactStatistics`	`rootCauseServiceRequestImpactStatistics()` The impact statistics of the root cause service.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Insight.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()` The time, in Unix seconds, at which the insight began.
`InsightState`	`state()` The current state of the insight.
`String`	`stateAsString()` The current state of the insight.
`String`	`summary()` A brief description of the insight.
`Insight.Builder`	`toBuilder()`
`List<AnomalousService>`	`topAnomalousServices()` The service within the insight 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
  - insightId
```
public final String insightId()
```
    The insights unique identifier.
    
    Returns:
    
    The insights unique identifier.
  - groupARN
```
public final String groupARN()
```
    The Amazon Resource Name (ARN) of the group that the insight belongs to.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the group that the insight belongs to.
  - groupName
```
public final String groupName()
```
    The name of the group that the insight belongs to.
    
    Returns:
    
    The name of the group that the insight belongs to.
  - rootCauseServiceId
```
public final ServiceId rootCauseServiceId()
```
    Returns the value of the RootCauseServiceId property for this object.
    
    Returns:
    
    The value of the RootCauseServiceId property for this object.
  - categories
```
public final List<InsightCategory> categories()
```
    The categories that label and describe the type of insight.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasCategories() to see if a value was sent in this field.
    
    Returns:
    
    The categories that label and describe the type of insight.
  - hasCategories
```
public final boolean hasCategories()
```
    Returns true if the Categories property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - categoriesAsStrings
```
public final List<String> categoriesAsStrings()
```
    The categories that label and describe the type of insight.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasCategories() to see if a value was sent in this field.
    
    Returns:
    
    The categories that label and describe the type of insight.
  - state
```
public final InsightState state()
```
    The current state of the insight.
    
    If the service returns an enum value that is not available in the current SDK version, state will return InsightState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The current state of the insight.
    
    See Also:
    
    InsightState
  - stateAsString
```
public final String stateAsString()
```
    The current state of the insight.
    
    If the service returns an enum value that is not available in the current SDK version, state will return InsightState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The current state of the insight.
    
    See Also:
    
    InsightState
  - startTime
```
public final Instant startTime()
```
    The time, in Unix seconds, at which the insight began.
    
    Returns:
    
    The time, in Unix seconds, at which the insight began.
  - endTime
```
public final Instant endTime()
```
    The time, in Unix seconds, at which the insight ended.
    
    Returns:
    
    The time, in Unix seconds, at which the insight ended.
  - summary
```
public final String summary()
```
    A brief description of the insight.
    
    Returns:
    
    A brief description of the insight.
  - 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()
```
    Returns true if the TopAnomalousServices property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - topAnomalousServices
```
public final List<AnomalousService> topAnomalousServices()
```
    The service within the insight that is most impacted by the incident.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTopAnomalousServices() to see if a value was sent in this field.
    
    Returns:
    
    The service within the insight that is most impacted by the incident.
  - toBuilder
```
public Insight.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Insight.Builder,Insight>
  - builder
```
public static Insight.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Insight.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

Class Insight

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

insightId

groupARN

groupName

rootCauseServiceId

categories

hasCategories

categoriesAsStrings

state

stateAsString

startTime

endTime

summary

clientRequestImpactStatistics

rootCauseServiceRequestImpactStatistics

hasTopAnomalousServices

topAnomalousServices

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields