Class EventSearchSummary
- All Implemented Interfaces:
Serializable,SdkPojo,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:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic EventSearchSummary.Builderbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final StringeventId()The ID of the event that the chunk belongs to.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final booleanFor responses, this returns true if the service returned a value for the Metadata property.final StringThe text of the matching chunk.metadata()The event's metadata tags.final Doublescore()The relevance score of the result.static Class<? extends EventSearchSummary.Builder> final SystemMetadataProvenance for the chunk: the owning actor and session, and when it was created and last updated.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
eventId
The ID of the event that the chunk belongs to. Use it with
GetEventorDeleteEvent.- Returns:
- The ID of the event that the chunk belongs to. Use it with
GetEventorDeleteEvent.
-
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
Provenance for the chunk: the owning actor and session, and when it was created and last updated. It is the same block that
ListMemoriesandSearchMemoriesreturn. Event chunks are never modified, soupdatedAtalways equalscreatedAt.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
ListMemoriesandSearchMemoriesreturn. Event chunks are never modified, soupdatedAtalways equalscreatedAt.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 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. -
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
The text of the matching chunk.
- Returns:
- The text of the matching chunk.
-
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<EventSearchSummary.Builder,EventSearchSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
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
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-