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

Class ListMemoryRecordsRequest

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.ListMemoryRecordsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListMemoryRecordsRequest.Builder,ListMemoryRecordsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListMemoryRecordsRequest extends BedrockAgentCoreRequest implements ToCopyableBuilder<ListMemoryRecordsRequest.Builder,ListMemoryRecordsRequest>

  • Method Details

    • memoryId

      public final String memoryId()

      The identifier of the AgentCore Memory resource for which to list memory records.

      Returns:
      The identifier of the AgentCore Memory resource for which to list memory records.

    • namespace

      public final String namespace()

      The namespace prefix to filter memory records by. Returns all 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. Returns all 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.

    • memoryStrategyId

      public final String memoryStrategyId()

      The memory strategy identifier to filter memory records by. If specified, only memory records with this strategy ID are returned.

      Returns:
      The memory strategy identifier to filter memory records by. If specified, only memory records with this strategy ID are returned.

    • 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.

    • 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.

    • 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<MemoryMetadataFilterExpression> metadataFilters()

      A list of metadata filter expressions to scope the returned memory records.

      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:
      A list of metadata filter expressions to scope the returned memory records.

    • toBuilder

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

    • builder

      public static ListMemoryRecordsRequest.Builder builder()

    • serializableBuilderClass

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