Class InsightSummary

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

Information that describes an insight.

See Also:

  • Method Details

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

      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 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.

    • categoriesAsStrings

      public final List<String> 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

      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:

    • 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:

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

      public final Instant 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

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

    • builder

      public static InsightSummary.Builder builder()

    • serializableBuilderClass

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