Class SystemMetadata
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<SystemMetadata.Builder,SystemMetadata>
System-generated provenance for a memory or event: the owning actor and session, and the creation and last-update
timestamps. SearchMemories, SearchEvents, ListMemories, and
GetMemory return the same block.
ListMemories and GetMemory always return createdAt and updatedAt.
The search operations return what is recorded and omit the block when nothing is.
In a query, the timestamps are system_metadata.created_at and system_metadata.updated_at.
Scope by owner with the top-level parameters (actorId on the search operations, actorIds on
ListMemories) and sessionIds (SearchEvents and ListMemories). The
search operations reject actor and session fields inside the query or sort.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal StringactorId()The owning actor.static SystemMetadata.Builderbuilder()final InstantWhen the record was created.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) final inthashCode()static Class<? extends SystemMetadata.Builder> final StringThe owning session.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.final InstantWhen the record was last updated.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
actorId
The owning actor. Absent when none was recorded.
- Returns:
- The owning actor. Absent when none was recorded.
-
sessionId
The owning session. Absent when none was recorded.
- Returns:
- The owning session. Absent when none was recorded.
-
createdAt
When the record was created. Always present on
ListMemoriesandGetMemory. It can be absent from search results.- Returns:
- When the record was created. Always present on
ListMemoriesandGetMemory. It can be absent from search results.
-
updatedAt
When the record was last updated. Equals
createdAtfor a record that has never been updated, and always for aSearchEventsresult.- Returns:
- When the record was last updated. Equals
createdAtfor a record that has never been updated, and always for aSearchEventsresult.
-
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<SystemMetadata.Builder,SystemMetadata> - 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.
-