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

Interface RetrieveMemoryRecordsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BedrockAgentCoreRequest.Builder, Buildable, CopyableBuilder<RetrieveMemoryRecordsRequest.Builder,RetrieveMemoryRecordsRequest>, SdkBuilder<RetrieveMemoryRecordsRequest.Builder,RetrieveMemoryRecordsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
RetrieveMemoryRecordsRequest
@Mutable @NotThreadSafe public static interface RetrieveMemoryRecordsRequest.Builder extends BedrockAgentCoreRequest.Builder, SdkPojo, CopyableBuilder<RetrieveMemoryRecordsRequest.Builder,RetrieveMemoryRecordsRequest>

  • Method Details

    • memoryId

      RetrieveMemoryRecordsRequest.Builder memoryId(String memoryId)

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

      Parameters:
      memoryId - The identifier of the AgentCore Memory resource from which to retrieve memory records.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • namespace

      RetrieveMemoryRecordsRequest.Builder namespace(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • namespacePath

      RetrieveMemoryRecordsRequest.Builder namespacePath(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • searchCriteria

      RetrieveMemoryRecordsRequest.Builder searchCriteria(SearchCriteria searchCriteria)

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

      Parameters:
      searchCriteria - The search criteria to use for finding relevant memory records. This includes the search query, memory strategy ID, and other search parameters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchCriteria

      default RetrieveMemoryRecordsRequest.Builder searchCriteria(Consumer<SearchCriteria.Builder> searchCriteria)

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

      This is a convenience method that creates an instance of the SearchCriteria.Builder avoiding the need to create one manually via SearchCriteria.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to searchCriteria(SearchCriteria).

      Parameters:
      searchCriteria - a consumer that will call methods on SearchCriteria.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nextToken

      RetrieveMemoryRecordsRequest.Builder nextToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      RetrieveMemoryRecordsRequest.Builder maxResults(Integer maxResults)

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

      Parameters:
      maxResults - The maximum number of results to return in a single call. The default value is 20.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      RetrieveMemoryRecordsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder

    • overrideConfiguration

      RetrieveMemoryRecordsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder