Interface ListMemoriesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<ListMemoriesRequest.Builder,,ListMemoriesRequest> OpenSearchMemoryRequest.Builder,SdkBuilder<ListMemoriesRequest.Builder,,ListMemoriesRequest> SdkPojo,SdkRequest.Builder
- Enclosing class:
ListMemoriesRequest
-
Method Summary
Modifier and TypeMethodDescriptionLists only memories owned by one of these actors.actorIds(Collection<String> actorIds) Lists only memories owned by one of these actors.maxResults(Integer maxResults) The maximum number of memories to return, from 1 to 100.memoryStrategies(Collection<StrategySelector> memoryStrategies) The strategies to list, as selectors.memoryStrategies(Consumer<StrategySelector.Builder>... memoryStrategies) The strategies to list, as selectors.memoryStrategies(StrategySelector... memoryStrategies) The strategies to list, as selectors.The token for the next set of results.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.sessionIds(String... sessionIds) Lists only memories from one of these sessions.sessionIds(Collection<String> sessionIds) Lists only memories from one of these sessions.The timestamp to sort by, as returned insystemMetadata:CREATED_AT(the default) orUPDATED_AT.sortBy(MemorySortField sortBy) The timestamp to sort by, as returned insystemMetadata:CREATED_AT(the default) orUPDATED_AT.The sort order:ASCorDESC.The sort order:ASCorDESC.The space whose memories to list.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copyMethods inherited from interface software.amazon.awssdk.services.opensearchmemory.model.OpenSearchMemoryRequest.Builder
buildMethods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, buildMethods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
Method Details
-
spaceId
The space whose memories to list.
- Parameters:
spaceId- The space whose memories to list.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
memoryStrategies
The strategies to list, as selectors. A selector without
memoryStrategyNameslists every strategy of its type, and omittingmemoryStrategieslists every strategy in the space. A name that is not a declared strategy of that type fails withValidationException.- Parameters:
memoryStrategies- The strategies to list, as selectors. A selector withoutmemoryStrategyNameslists every strategy of its type, and omittingmemoryStrategieslists every strategy in the space. A name that is not a declared strategy of that type fails withValidationException.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
memoryStrategies
The strategies to list, as selectors. A selector without
memoryStrategyNameslists every strategy of its type, and omittingmemoryStrategieslists every strategy in the space. A name that is not a declared strategy of that type fails withValidationException.- Parameters:
memoryStrategies- The strategies to list, as selectors. A selector withoutmemoryStrategyNameslists every strategy of its type, and omittingmemoryStrategieslists every strategy in the space. A name that is not a declared strategy of that type fails withValidationException.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
memoryStrategies
ListMemoriesRequest.Builder memoryStrategies(Consumer<StrategySelector.Builder>... memoryStrategies) The strategies to list, as selectors. A selector without
This is a convenience method that creates an instance of thememoryStrategyNameslists every strategy of its type, and omittingmemoryStrategieslists every strategy in the space. A name that is not a declared strategy of that type fails withValidationException.StrategySelector.Builderavoiding the need to create one manually viaStrategySelector.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tomemoryStrategies(List<StrategySelector>).- Parameters:
memoryStrategies- a consumer that will call methods onStrategySelector.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
actorIds
Lists only memories owned by one of these actors. Combined with
sessionIdsby AND: a memory must match both filters when both are given. Omit for no actor filter. An empty list fails validation. A memory stored without an actor never matches an actor filter.- Parameters:
actorIds- Lists only memories owned by one of these actors. Combined withsessionIdsby AND: a memory must match both filters when both are given. Omit for no actor filter. An empty list fails validation. A memory stored without an actor never matches an actor filter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
actorIds
Lists only memories owned by one of these actors. Combined with
sessionIdsby AND: a memory must match both filters when both are given. Omit for no actor filter. An empty list fails validation. A memory stored without an actor never matches an actor filter.- Parameters:
actorIds- Lists only memories owned by one of these actors. Combined withsessionIdsby AND: a memory must match both filters when both are given. Omit for no actor filter. An empty list fails validation. A memory stored without an actor never matches an actor filter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sessionIds
Lists only memories from one of these sessions. Combined with
actorIdsby AND. Omit for no session filter. An empty list fails validation. A memory stored without a session never matches a session filter.- Parameters:
sessionIds- Lists only memories from one of these sessions. Combined withactorIdsby AND. Omit for no session filter. An empty list fails validation. A memory stored without a session never matches a session filter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sessionIds
Lists only memories from one of these sessions. Combined with
actorIdsby AND. Omit for no session filter. An empty list fails validation. A memory stored without a session never matches a session filter.- Parameters:
sessionIds- Lists only memories from one of these sessions. Combined withactorIdsby AND. Omit for no session filter. An empty list fails validation. A memory stored without a session never matches a session filter.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sortBy
The timestamp to sort by, as returned in
systemMetadata:CREATED_AT(the default) orUPDATED_AT.- Parameters:
sortBy- The timestamp to sort by, as returned insystemMetadata:CREATED_AT(the default) orUPDATED_AT.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sortBy
The timestamp to sort by, as returned in
systemMetadata:CREATED_AT(the default) orUPDATED_AT.- Parameters:
sortBy- The timestamp to sort by, as returned insystemMetadata:CREATED_AT(the default) orUPDATED_AT.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sortOrder
The sort order:
ASCorDESC. The default isDESC, most recent first.- Parameters:
sortOrder- The sort order:ASCorDESC. The default isDESC, most recent first.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sortOrder
The sort order:
ASCorDESC. The default isDESC, most recent first.- Parameters:
sortOrder- The sort order:ASCorDESC. The default isDESC, most recent first.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
maxResults
The maximum number of memories to return, from 1 to 100. The default is 20.
- Parameters:
maxResults- The maximum number of memories to return, from 1 to 100. The default is 20.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
overrideConfiguration
ListMemoriesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
overrideConfiguration- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ListMemoriesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.BuilderAdd an optional request override configuration.- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder- Parameters:
builderConsumer- AConsumerto which an emptyAwsRequestOverrideConfiguration.Builderwill be given.- Returns:
- This object for method chaining.
-