Class: Aws::OpenSearchMemory::Types::SystemMetadata

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opensearchmemory/lib/aws-sdk-opensearchmemory/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#actor_id ⇒ String

The owning actor. Absent when none was recorded.

Returns:

  • (String)


1941
1942
1943
1944
1945
1946
1947
1948
# File 'gems/aws-sdk-opensearchmemory/lib/aws-sdk-opensearchmemory/types.rb', line 1941

class SystemMetadata < Struct.new(
  :actor_id,
  :session_id,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

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

Returns:

  • (Time)


1941
1942
1943
1944
1945
1946
1947
1948
# File 'gems/aws-sdk-opensearchmemory/lib/aws-sdk-opensearchmemory/types.rb', line 1941

class SystemMetadata < Struct.new(
  :actor_id,
  :session_id,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#session_id ⇒ String

The owning session. Absent when none was recorded.

Returns:

  • (String)


1941
1942
1943
1944
1945
1946
1947
1948
# File 'gems/aws-sdk-opensearchmemory/lib/aws-sdk-opensearchmemory/types.rb', line 1941

class SystemMetadata < Struct.new(
  :actor_id,
  :session_id,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

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

Returns:

  • (Time)


1941
1942
1943
1944
1945
1946
1947
1948
# File 'gems/aws-sdk-opensearchmemory/lib/aws-sdk-opensearchmemory/types.rb', line 1941

class SystemMetadata < Struct.new(
  :actor_id,
  :session_id,
  :created_at,
  :updated_at)
  SENSITIVE = []
  include Aws::Structure
end