Class ListMemoriesRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<ListMemoriesRequest.Builder,ListMemoriesRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionactorIds()Lists only memories owned by one of these actors.static ListMemoriesRequest.Builderbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest.final booleanFor responses, this returns true if the service returned a value for the ActorIds property.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the MemoryStrategies property.final booleanFor responses, this returns true if the service returned a value for the SessionIds property.final IntegerThe maximum number of memories to return, from 1 to 100.final List<StrategySelector> The strategies to list, as selectors.final StringThe token for the next set of results.static Class<? extends ListMemoriesRequest.Builder> Lists only memories from one of these sessions.final MemorySortFieldsortBy()The timestamp to sort by, as returned insystemMetadata:CREATED_AT(the default) orUPDATED_AT.final StringThe timestamp to sort by, as returned insystemMetadata:CREATED_AT(the default) orUPDATED_AT.final SortOrderThe sort order:ASCorDESC.final StringThe sort order:ASCorDESC.final StringspaceId()The space whose memories to list.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfigurationMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()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
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.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
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.
-
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 theisEmpty()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
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.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
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.
-
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 theisEmpty()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
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.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
actorIdsby AND. Omit for no session filter. An empty list fails validation. A memory stored without a session never matches a session filter.
-
sortBy
The timestamp to sort by, as returned in
systemMetadata:CREATED_AT(the default) orUPDATED_AT.If the service returns an enum value that is not available in the current SDK version,
sortBywill returnMemorySortField.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsortByAsString().- Returns:
- The timestamp to sort by, as returned in
systemMetadata:CREATED_AT(the default) orUPDATED_AT. - See Also:
-
sortByAsString
The timestamp to sort by, as returned in
systemMetadata:CREATED_AT(the default) orUPDATED_AT.If the service returns an enum value that is not available in the current SDK version,
sortBywill returnMemorySortField.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsortByAsString().- Returns:
- The timestamp to sort by, as returned in
systemMetadata:CREATED_AT(the default) orUPDATED_AT. - See Also:
-
sortOrder
The sort order:
ASCorDESC. The default isDESC, most recent first.If the service returns an enum value that is not available in the current SDK version,
sortOrderwill returnSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsortOrderAsString().- Returns:
- The sort order:
ASCorDESC. The default isDESC, most recent first. - See Also:
-
sortOrderAsString
The sort order:
ASCorDESC. The default isDESC, most recent first.If the service returns an enum value that is not available in the current SDK version,
sortOrderwill returnSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromsortOrderAsString().- Returns:
- The sort order:
ASCorDESC. The default isDESC, most recent first. - See Also:
-
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
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
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<ListMemoriesRequest.Builder,ListMemoriesRequest> - Specified by:
toBuilderin classOpenSearchMemoryRequest- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCodein classAwsRequest
-
equals
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
Description copied from class:SdkRequestUsed to retrieve the value of a field from any class that extendsSdkRequest. 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, theSdkRequest.getValueForField(String, Class)method will again be available.- Overrides:
getValueForFieldin classSdkRequest- 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
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-