Class MemorySearchSummary

java.lang.Object
software.amazon.awssdk.services.opensearchmemory.model.MemorySearchSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<MemorySearchSummary.Builder,MemorySearchSummary>

@Generated("software.amazon.awssdk:codegen") public final class MemorySearchSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MemorySearchSummary.Builder,MemorySearchSummary>

A SearchMemories result: a matching memory and its relevance score.

See Also:
  • Method Details

    • memoryId

      public final String memoryId()

      The memory's ID, assigned by the service. Always present.

      Returns:
      The memory's ID, assigned by the service. Always present.
    • memoryType

      public final MemoryType memoryType()

      The memory type of the result.

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

      Returns:
      The memory type of the result.
      See Also:
    • memoryTypeAsString

      public final String memoryTypeAsString()

      The memory type of the result.

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

      Returns:
      The memory type of the result.
      See Also:
    • strategyName

      public final String strategyName()

      The name of the strategy the memory belongs to, for example user-facts: the strategy memoryStrategies selects on in SearchMemories. Absent when the memory's strategy is no longer declared on the space, for example right after the strategy is deleted.

      Returns:
      The name of the strategy the memory belongs to, for example user-facts: the strategy memoryStrategies selects on in SearchMemories. Absent when the memory's strategy is no longer declared on the space, for example right after the strategy is deleted.
    • content

      public final String content()

      The memory text.

      Returns:
      The memory text.
    • score

      public final Double score()

      The relevance score of the result. A higher score is more relevant. Scores aren't normalized to a fixed range and can be greater than 1, so use them only to order results.

      Returns:
      The relevance score of the result. A higher score is more relevant. Scores aren't normalized to a fixed range and can be greater than 1, so use them only to order results.
    • systemMetadata

      public final SystemMetadata systemMetadata()

      Provenance for the memory: the actor and session that own it, and when it was created and last updated. It is the same block that ListMemories, GetMemory, and SearchEvents return.

      In a query, filter or sort on the timestamps as system_metadata.created_at and system_metadata.updated_at. Scope by owner with the top-level actorId, not in the query. Searching memories doesn't filter by session.

      Absent when the service has no provenance for the memory.

      Returns:
      Provenance for the memory: the actor and session that own it, and when it was created and last updated. It is the same block that ListMemories, GetMemory, and SearchEvents return.

      In a query, filter or sort on the timestamps as system_metadata.created_at and system_metadata.updated_at. Scope by owner with the top-level actorId, not in the query. Searching memories doesn't filter by session.

      Absent when the service has no provenance for the memory.

    • hasMetadata

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

      public final Map<String,String> metadata()

      The memory's metadata tags. All values are strings. In a query, filter on a tag as metadata.<key>.

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

      Returns:
      The memory's metadata tags. All values are strings. In a query, filter on a tag as metadata.<key>.
    • hasSourceEventIds

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

      public final List<String> sourceEventIds()

      The IDs of the events the memory was derived from, without duplicates. Use them with GetEvent or BatchGetEvent, or to search those events' content with SearchEvents by filtering on event_ids in the query. Absent for a memory created directly with CreateMemory. A memory can be derived from several events. The service sets this value.

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

      Returns:
      The IDs of the events the memory was derived from, without duplicates. Use them with GetEvent or BatchGetEvent, or to search those events' content with SearchEvents by filtering on event_ids in the query. Absent for a memory created directly with CreateMemory. A memory can be derived from several events. The service sets this value.
    • toBuilder

      public MemorySearchSummary.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<MemorySearchSummary.Builder,MemorySearchSummary>
      Returns:
      a builder for type T
    • builder

      public static MemorySearchSummary.Builder builder()
    • serializableBuilderClass

      public static Class<? extends MemorySearchSummary.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • 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)
    • 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.