Interface ListMemoriesRequest.Builder

  • 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

      ListMemoriesRequest.Builder memoryStrategies(Collection<StrategySelector> memoryStrategies)

      The strategies to list, as selectors. A selector without memoryStrategyNames lists every strategy of its type, and omitting memoryStrategies lists every strategy in the space. A name that is not a declared strategy of that type fails with ValidationException.

      Parameters:
      memoryStrategies - The strategies to list, as selectors. A selector without memoryStrategyNames lists every strategy of its type, and omitting memoryStrategies lists every strategy in the space. A name that is not a declared strategy of that type fails with ValidationException.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • memoryStrategies

      ListMemoriesRequest.Builder memoryStrategies(StrategySelector... memoryStrategies)

      The strategies to list, as selectors. A selector without memoryStrategyNames lists every strategy of its type, and omitting memoryStrategies lists every strategy in the space. A name that is not a declared strategy of that type fails with ValidationException.

      Parameters:
      memoryStrategies - The strategies to list, as selectors. A selector without memoryStrategyNames lists every strategy of its type, and omitting memoryStrategies lists every strategy in the space. A name that is not a declared strategy of that type fails with ValidationException.
      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 memoryStrategyNames lists every strategy of its type, and omitting memoryStrategies lists every strategy in the space. A name that is not a declared strategy of that type fails with ValidationException.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to memoryStrategies(List<StrategySelector>).

      Parameters:
      memoryStrategies - a consumer that will call methods on StrategySelector.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 sessionIds by 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 with sessionIds by 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

      ListMemoriesRequest.Builder actorIds(String... actorIds)

      Lists only memories owned by one of these actors. Combined with sessionIds by 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 with sessionIds by 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 actorIds by 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 with actorIds by 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

      ListMemoriesRequest.Builder sessionIds(String... sessionIds)

      Lists only memories from one of these sessions. Combined with actorIds by 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 with actorIds by 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) or UPDATED_AT.

      Parameters:
      sortBy - The timestamp to sort by, as returned in systemMetadata: CREATED_AT (the default) or UPDATED_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) or UPDATED_AT.

      Parameters:
      sortBy - The timestamp to sort by, as returned in systemMetadata: CREATED_AT (the default) or UPDATED_AT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • sortOrder

      ListMemoriesRequest.Builder sortOrder(String sortOrder)

      The sort order: ASC or DESC. The default is DESC, most recent first.

      Parameters:
      sortOrder - The sort order: ASC or DESC. The default is DESC, most recent first.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • sortOrder

      ListMemoriesRequest.Builder sortOrder(SortOrder sortOrder)

      The sort order: ASC or DESC. The default is DESC, most recent first.

      Parameters:
      sortOrder - The sort order: ASC or DESC. The default is DESC, most recent first.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • maxResults

      ListMemoriesRequest.Builder maxResults(Integer 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

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

      ListMemoriesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.