Class SystemMetadata

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

@Generated("software.amazon.awssdk:codegen") public final class SystemMetadata extends Object implements SdkPojo, Serializable, 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:
  • Method Details

    • actorId

      public final String actorId()

      The owning actor. Absent when none was recorded.

      Returns:
      The owning actor. Absent when none was recorded.
    • sessionId

      public final String sessionId()

      The owning session. Absent when none was recorded.

      Returns:
      The owning session. Absent when none was recorded.
    • createdAt

      public final Instant createdAt()

      When the record was created. Always present on ListMemories and GetMemory. It can be absent from search results.

      Returns:
      When the record was created. Always present on ListMemories and GetMemory. It can be absent from search results.
    • updatedAt

      public final Instant updatedAt()

      When the record was last updated. Equals createdAt for a record that has never been updated, and always for a SearchEvents result.

      Returns:
      When the record was last updated. Equals createdAt for a record that has never been updated, and always for a SearchEvents result.
    • toBuilder

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

      public static SystemMetadata.Builder builder()
    • serializableBuilderClass

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