Package software.amazon.awssdk.services.bedrockagentcore.model

Class RetrieveMemoryRecordsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.bedrockagentcore.model.BedrockAgentCoreRequest
software.amazon.awssdk.services.bedrockagentcore.model.RetrieveMemoryRecordsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<RetrieveMemoryRecordsRequest.Builder,RetrieveMemoryRecordsRequest>
@Generated("software.amazon.awssdk:codegen") public final class RetrieveMemoryRecordsRequest extends BedrockAgentCoreRequest implements ToCopyableBuilder<RetrieveMemoryRecordsRequest.Builder,RetrieveMemoryRecordsRequest>

  • Method Details

    • memoryId

      public final String memoryId()

      The identifier of the AgentCore Memory resource from which to retrieve memory records.

      Returns:
      The identifier of the AgentCore Memory resource from which to retrieve memory records.

    • namespace

      public final String namespace()

      The namespace prefix to filter memory records by. Searches for memory records in namespaces that start with the provided prefix. Either namespace or namespacePath is required.

      Returns:
      The namespace prefix to filter memory records by. Searches for memory records in namespaces that start with the provided prefix. Either namespace or namespacePath is required.

    • namespacePath

      public final String namespacePath()

      Use namespacePath for hierarchical retrievals. Return all memory records where namespace falls under the same parent hierarchy. Either namespace or namespacePath is required.

      Returns:
      Use namespacePath for hierarchical retrievals. Return all memory records where namespace falls under the same parent hierarchy. Either namespace or namespacePath is required.

    • searchCriteria

      public final SearchCriteria searchCriteria()

      The search criteria to use for finding relevant memory records. This includes the search query, memory strategy ID, and other search parameters.

      Returns:
      The search criteria to use for finding relevant memory records. This includes the search query, memory strategy ID, and other search parameters.

    • nextToken

      public final String nextToken()

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

      Returns:
      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return in a single call. The default value is 20.

      Returns:
      The maximum number of results to return in a single call. The default value is 20.

    • toBuilder

      public RetrieveMemoryRecordsRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<RetrieveMemoryRecordsRequest.Builder,RetrieveMemoryRecordsRequest>
      Specified by:
      toBuilder in class BedrockAgentCoreRequest

    • builder

      public static RetrieveMemoryRecordsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RetrieveMemoryRecordsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo