Class InsightSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<InsightSummary.Builder,
InsightSummary>
Information that describes an insight.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic InsightSummary.Builder
builder()
final List
<InsightCategory> Categories The categories that label and describe the type of insight.Categories The categories that label and describe the type of insight.final RequestImpactStatistics
The impact statistics of the client side service.final Instant
endTime()
The time, in Unix seconds, at which the insight ended.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final String
groupARN()
The Amazon Resource Name (ARN) of the group that the insight belongs to.final String
The name of the group that the insight belongs to.final boolean
For responses, this returns true if the service returned a value for the Categories property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the TopAnomalousServices property.final String
The insights unique identifier.final Instant
The time, in Unix seconds, that the insight was last updated.final ServiceId
Returns the value of the RootCauseServiceId property for this object.final RequestImpactStatistics
The impact statistics of the root cause service.static Class
<? extends InsightSummary.Builder> final Instant
The time, in Unix seconds, at which the insight began.final InsightState
state()
The current state of the insight.final String
The current state of the insight.final String
summary()
A brief description of the insight.Take this object and create a builder that contains all of the current property values of this object.final List
<AnomalousService> The service within the insight that is most impacted by the incident.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
insightId
The insights unique identifier.
- Returns:
- The insights unique identifier.
-
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
The name of the group that the insight belongs to.
- Returns:
- The name of the group that the insight belongs to.
-
rootCauseServiceId
Returns the value of the RootCauseServiceId property for this object.- Returns:
- The value of the RootCauseServiceId property for this object.
-
categories
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.
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
hasCategories()
method.- Returns:
- Categories The categories that label and describe the type of insight.
-
hasCategories
public final boolean hasCategories()For responses, this returns true if the service returned a value for the Categories 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. -
categoriesAsStrings
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.
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
hasCategories()
method.- Returns:
- Categories The categories that label and describe the type of insight.
-
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 returnInsightState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the insight.
- See Also:
-
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 returnInsightState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The current state of the insight.
- See Also:
-
startTime
The time, in Unix seconds, at which the insight began.
- Returns:
- The time, in Unix seconds, at which the insight began.
-
endTime
The time, in Unix seconds, at which the insight ended.
- Returns:
- The time, in Unix seconds, at which the insight ended.
-
summary
A brief description of the insight.
- Returns:
- A brief description of the insight.
-
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
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 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. -
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.
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 within the insight that is most impacted by the incident.
-
lastUpdateTime
The time, in Unix seconds, that the insight was last updated.
- Returns:
- The time, in Unix seconds, that the insight was last updated.
-
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 interfaceToCopyableBuilder<InsightSummary.Builder,
InsightSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
-
sdkFields
-