Class InsightResult

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

An insight that groups related failures found across the sessions in a batch evaluation.

See Also:

  • Method Details

    • type

      public final InsightType type()

      The type of insight. FAILURE indicates a group of related failures.

      If the service returns an enum value that is not available in the current SDK version, type will return InsightType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of insight. FAILURE indicates a group of related failures.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of insight. FAILURE indicates a group of related failures.

      If the service returns an enum value that is not available in the current SDK version, type will return InsightType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The type of insight. FAILURE indicates a group of related failures.
      See Also:

    • name

      public final String name()

      A generated label for the insight. The name is not an identifier and can differ between batch evaluations.

      Returns:
      A generated label for the insight. The name is not an identifier and can differ between batch evaluations.

    • description

      public final String description()

      A description of the failure pattern that the insight represents.

      Returns:
      A description of the failure pattern that the insight represents.

    • createdAt

      public final Instant createdAt()

      The timestamp when the insight was generated.

      Returns:
      The timestamp when the insight was generated.

    • affectedSessionCount

      public final Integer affectedSessionCount()

      The number of distinct sessions affected by the insight.

      Returns:
      The number of distinct sessions affected by the insight.

    • hasSampleSessions

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

    • sampleSessions

      public final List<SampleSession> sampleSessions()

      A sample of up to 10 sessions affected by the insight. Returned only when the insight has no root causes. Otherwise, sample sessions are returned for each root cause.

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

      Returns:
      A sample of up to 10 sessions affected by the insight. Returned only when the insight has no root causes. Otherwise, sample sessions are returned for each root cause.

    • hasRootCauses

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

    • rootCauses

      public final List<InsightRootCause> rootCauses()

      The root causes identified for the 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 hasRootCauses() method.

      Returns:
      The root causes identified for the insight.

    • toBuilder

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

    • builder

      public static InsightResult.Builder builder()

    • serializableBuilderClass

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