Class SearchMemoriesRequest
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<SearchMemoriesRequest.Builder,SearchMemoriesRequest>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal StringactorId()The actor whose memories to search (exact match).builder()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 inthashCode()final booleanFor responses, this returns true if the service returned a value for the MemoryStrategies property.final IntegerThe maximum number of memories to return, from 1 to 100.final List<StrategySelector> The strategies to search, as a list of selectors.final StringThe token for the next set of results.final Documentquery()The query: a subset of the OpenSearch Query DSL (seeSearchQuery).static Class<? extends SearchMemoriesRequest.Builder> final Documentsort()The sort order (seeSearchSort).final StringspaceId()The space to search.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 to search. Use
actorIdto narrow the search within it.- Returns:
- The space to search. Use
actorIdto narrow the search within it.
-
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 search, as a list of selectors. Each selector names a memory type and, optionally, specific strategy names of that type. A space can hold several strategies of the same type. A selector without
memoryStrategyNamessearches every strategy of its type, and omittingmemoryStrategiessearches 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 search, as a list of selectors. Each selector names a memory type and, optionally,
specific strategy names of that type. A space can hold several strategies of the same type. A selector
without
memoryStrategyNamessearches every strategy of its type, and omittingmemoryStrategiessearches every strategy in the space. A name that is not a declared strategy of that type fails withValidationException.
-
actorId
The actor whose memories to search (exact match). Required: every search covers exactly one actor, and a memory stored without an actor is never returned. This is the only way to filter by actor: a query that references
system_metadata.actor_idfails withValidationException(reasonnonFilterableField).- Returns:
- The actor whose memories to search (exact match). Required: every search covers exactly one actor, and a
memory stored without an actor is never returned. This is the only way to filter by actor: a query that
references
system_metadata.actor_idfails withValidationException(reasonnonFilterableField).
-
query
The query: a subset of the OpenSearch Query DSL (see
SearchQuery). You can't use the actor and session fieldssystem_metadata.actor_idandsystem_metadata.session_idhere. Use the top-levelactorIdto filter by actor. Searching memories doesn't filter by session.- Returns:
- The query: a subset of the OpenSearch Query DSL (see
SearchQuery). You can't use the actor and session fieldssystem_metadata.actor_idandsystem_metadata.session_idhere. Use the top-levelactorIdto filter by actor. Searching memories doesn't filter by session.
-
sort
The sort order (see
SearchSort). Omit to return the most relevant memories first.- Returns:
- The sort order (see
SearchSort). Omit to return the most relevant memories first.
-
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<SearchMemoriesRequest.Builder,SearchMemoriesRequest> - 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.
-