Class ListMemoriesRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListMemoriesRequest.Builder,ListMemoriesRequest>

@Generated("software.amazon.awssdk:codegen") public final class ListMemoriesRequest extends OpenSearchMemoryRequest implements ToCopyableBuilder<ListMemoriesRequest.Builder,ListMemoriesRequest>
  • Method Details

    • spaceId

      public final String spaceId()

      The space whose memories to list.

      Returns:
      The space whose memories to list.
    • hasMemoryStrategies

      public final boolean hasMemoryStrategies()
      For responses, this returns true if the service returned a value for the MemoryStrategies 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.
    • memoryStrategies

      public final List<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.

      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 hasMemoryStrategies() method.

      Returns:
      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.
    • hasActorIds

      public final boolean hasActorIds()
      For responses, this returns true if the service returned a value for the ActorIds 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.
    • actorIds

      public final List<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.

      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 hasActorIds() method.

      Returns:
      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.
    • hasSessionIds

      public final boolean hasSessionIds()
      For responses, this returns true if the service returned a value for the SessionIds 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.
    • sessionIds

      public final List<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.

      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 hasSessionIds() method.

      Returns:
      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.
    • sortBy

      public final MemorySortField sortBy()

      The timestamp to sort by, as returned in systemMetadata: CREATED_AT (the default) or UPDATED_AT.

      If the service returns an enum value that is not available in the current SDK version, sortBy will return MemorySortField.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

      Returns:
      The timestamp to sort by, as returned in systemMetadata: CREATED_AT (the default) or UPDATED_AT.
      See Also:
    • sortByAsString

      public final String sortByAsString()

      The timestamp to sort by, as returned in systemMetadata: CREATED_AT (the default) or UPDATED_AT.

      If the service returns an enum value that is not available in the current SDK version, sortBy will return MemorySortField.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

      Returns:
      The timestamp to sort by, as returned in systemMetadata: CREATED_AT (the default) or UPDATED_AT.
      See Also:
    • sortOrder

      public final SortOrder sortOrder()

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

      If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

      Returns:
      The sort order: ASC or DESC. The default is DESC, most recent first.
      See Also:
    • sortOrderAsString

      public final String sortOrderAsString()

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

      If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

      Returns:
      The sort order: ASC or DESC. The default is DESC, most recent first.
      See Also:
    • maxResults

      public final Integer maxResults()

      The maximum number of memories to return, from 1 to 100. The default is 20.

      Returns:
      The maximum number of memories to return, from 1 to 100. The default 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.
    • toBuilder

      public ListMemoriesRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ListMemoriesRequest.Builder,ListMemoriesRequest>
      Specified by:
      toBuilder in class OpenSearchMemoryRequest
      Returns:
      a builder for type T
    • builder

      public static ListMemoriesRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends ListMemoriesRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.