Class AgentInsightSummary

java.lang.Object
software.amazon.awssdk.services.bedrockagentcore.model.AgentInsightSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AgentInsightSummary.Builder,AgentInsightSummary>

@Generated("software.amazon.awssdk:codegen") public final class AgentInsightSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AgentInsightSummary.Builder,AgentInsightSummary>

Contains summary information about an Amazon Bedrock AgentCore Agent Insight, including its label, description, and creation time. This structure is returned by ListAgentInsights; use GetAgentInsight to retrieve the sample sessions and root causes for a specific insight.

See Also:
  • Method Details

    • type

      public final InsightType type()
      Returns the value of the Type property for this object.

      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 value of the Type property for this object.
      See Also:
    • typeAsString

      public final String typeAsString()
      Returns the value of the Type property for this object.

      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 value of the Type property for this object.
      See Also:
    • name

      public final String name()

      A generated display label for the Agent Insight. This is a human-readable summary of the detected pattern, not an identifier.

      Returns:
      A generated display label for the Agent Insight. This is a human-readable summary of the detected pattern, not an identifier.
    • description

      public final String description()

      A generated description of the Agent Insight that explains the detected pattern and its observed behavior across sessions.

      Returns:
      A generated description of the Agent Insight that explains the detected pattern and its observed behavior across sessions.
    • createdAt

      public final Instant createdAt()

      The date and time when the Agent Insight was first created.

      Returns:
      The date and time when the Agent Insight was first created.
    • affectedSessionCount

      public final Integer affectedSessionCount()

      The number of sessions affected by the insight pattern.

      Returns:
      The number of sessions affected by the insight pattern.
    • agentInsightId

      public final String agentInsightId()

      The unique identifier of the Agent Insight.

      Returns:
      The unique identifier of the Agent Insight.
    • applicationName

      public final String applicationName()

      The application that the Agent Insight belongs to.

      Returns:
      The application that the Agent Insight belongs to.
    • batchEvaluationId

      public final String batchEvaluationId()

      The Batch Evaluation that produced this Insight, when applicable.

      Returns:
      The Batch Evaluation that produced this Insight, when applicable.
    • customerMetadataStatus

      public final AgentInsightCustomerMetadataStatus customerMetadataStatus()

      Specifies whether customer-encrypted metadata is available for the Agent Insight.

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

      Returns:
      Specifies whether customer-encrypted metadata is available for the Agent Insight.
      See Also:
    • customerMetadataStatusAsString

      public final String customerMetadataStatusAsString()

      Specifies whether customer-encrypted metadata is available for the Agent Insight.

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

      Returns:
      Specifies whether customer-encrypted metadata is available for the Agent Insight.
      See Also:
    • updatedAt

      public final Instant updatedAt()

      The date and time when the Agent Insight was last updated.

      Returns:
      The date and time when the Agent Insight was last updated.
    • archiveStatus

      public final AgentInsightArchiveStatus archiveStatus()

      Specifies whether the Agent Insight is active or archived. Valid values:

      • ACTIVE - The insight is currently active.

      • ARCHIVED - The insight has been archived.

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

      Returns:
      Specifies whether the Agent Insight is active or archived. Valid values:

      • ACTIVE - The insight is currently active.

      • ARCHIVED - The insight has been archived.

      See Also:
    • archiveStatusAsString

      public final String archiveStatusAsString()

      Specifies whether the Agent Insight is active or archived. Valid values:

      • ACTIVE - The insight is currently active.

      • ARCHIVED - The insight has been archived.

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

      Returns:
      Specifies whether the Agent Insight is active or archived. Valid values:

      • ACTIVE - The insight is currently active.

      • ARCHIVED - The insight has been archived.

      See Also:
    • lastSeenAt

      public final Instant lastSeenAt()

      The most recent date and time when the insight pattern was observed.

      Returns:
      The most recent date and time when the insight pattern was observed.
    • toBuilder

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

      public static AgentInsightSummary.Builder builder()
    • serializableBuilderClass

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