Class EventSearchSummary

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

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

A SearchEvents result: the matching chunk of an event and its provenance. Unlike EventSummary from ListEvents, it has a relevance score and the matched content, but not the full payload.

See Also:
  • Method Details

    • eventId

      public final String eventId()

      The ID of the event that the chunk belongs to. Use it with GetEvent or DeleteEvent.

      Returns:
      The ID of the event that the chunk belongs to. Use it with GetEvent or DeleteEvent.
    • 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 chunk: the owning actor and session, and when it was created and last updated. It is the same block that ListMemories and SearchMemories return. Event chunks are never modified, so updatedAt always equals createdAt.

      Absent when the service has no provenance for the chunk.

      Returns:
      Provenance for the chunk: the owning actor and session, and when it was created and last updated. It is the same block that ListMemories and SearchMemories return. Event chunks are never modified, so updatedAt always equals createdAt.

      Absent when the service has no provenance for the chunk.

    • 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 event'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 event's metadata tags. All values are strings. In a query, filter on a tag as metadata.<key>.
    • matchedContent

      public final String matchedContent()

      The text of the matching chunk.

      Returns:
      The text of the matching chunk.
    • toBuilder

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

      public static EventSearchSummary.Builder builder()
    • serializableBuilderClass

      public static Class<? extends EventSearchSummary.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.