Class AgenticRetrieveMemoryRetrievalConfig

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

The long-term memory namespace that the agent might retrieve memory records from, and the filters applied to that retrieval. You must specify either namespace or namespacePath.

See Also:

  • Method Details

    • hasMetadataFilters

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

    • metadataFilters

      public final List<AgenticRetrieveMemoryMetadataFilter> metadataFilters()

      The metadata filter expressions that restrict retrieval to matching memory records. You can specify a maximum of 5 expressions.

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

      Returns:
      The metadata filter expressions that restrict retrieval to matching memory records. You can specify a maximum of 5 expressions.

    • namespace

      public final String namespace()

      The namespace prefix to filter memory records by. The agent retrieves memory records in namespaces that start with the provided prefix. You must specify either namespace or namespacePath.

      Returns:
      The namespace prefix to filter memory records by. The agent retrieves memory records in namespaces that start with the provided prefix. You must specify either namespace or namespacePath.

    • namespacePath

      public final String namespacePath()

      The parent namespace to use for hierarchical retrievals. The agent retrieves all memory records whose namespace falls under the same parent hierarchy. You must specify either namespace or namespacePath.

      Returns:
      The parent namespace to use for hierarchical retrievals. The agent retrieves all memory records whose namespace falls under the same parent hierarchy. You must specify either namespace or namespacePath.

    • strategyId

      public final String strategyId()

      The extraction strategy ID that restricts retrieval to memory records produced by a single strategy. Omit this parameter to retrieve records from every strategy on the memory resource.

      Returns:
      The extraction strategy ID that restricts retrieval to memory records produced by a single strategy. Omit this parameter to retrieve records from every strategy on the memory resource.

    • toBuilder

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

    • builder

      public static AgenticRetrieveMemoryRetrievalConfig.Builder builder()

    • serializableBuilderClass

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