Package org.springframework.ai.session

Class SessionEvent.Builder

java.lang.Object

org.springframework.ai.session.SessionEvent.Builder

Enclosing class:

SessionEvent

public static final class SessionEvent.Builder
extends Object

Builds a SessionEvent. The id is a random UUID, the timestamp Instant.now(), the payload and the metadata empty, unless set; the session id is required. The type is EventType.MESSAGE when a message is set, which that type requires and no other type allows.

Method Summary

Modifier and Type	Method	Description
SessionEvent	build()	Builds the event, checking that the type and the message agree.
SessionEvent.Builder	id(String id)	The event id; a random UUID by default.
SessionEvent.Builder	message(Message message)	The message a EventType.MESSAGE event wraps; required for that type, not allowed for any other.
SessionEvent.Builder	metadata(String key, Object value)	Adds one metadata entry.
SessionEvent.Builder	metadata(Map<String,Object> metadata)	Replaces the metadata.
SessionEvent.Builder	payload(String key, Object value)	Adds one payload entry.
SessionEvent.Builder	payload(Map<String,Object> payload)	Replaces the payload of an event that is not a message.
SessionEvent.Builder	sessionId(String sessionId)	The session the event belongs to; required.
SessionEvent.Builder	timestamp(Instant timestamp)	When the event was recorded; Instant.now() by default.
SessionEvent.Builder	type(EventType type)	What the event records; EventType.MESSAGE by default when a message is set.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

id

public SessionEvent.Builder id(String id)

The event id; a random UUID by default.

sessionId

public SessionEvent.Builder sessionId(String sessionId)

The session the event belongs to; required.

timestamp

public SessionEvent.Builder timestamp(Instant timestamp)

When the event was recorded; Instant.now() by default.

type

public SessionEvent.Builder type(EventType type)

What the event records; EventType.MESSAGE by default when a message is set.

message

public SessionEvent.Builder message(Message message)

The message a EventType.MESSAGE event wraps; required for that type, not allowed for any other.

payload

public SessionEvent.Builder payload(Map<String,Object> payload)

Replaces the payload of an event that is not a message.

payload

public SessionEvent.Builder payload(String key,
 Object value)

Adds one payload entry.

metadata

public SessionEvent.Builder metadata(Map<String,Object> metadata)

Replaces the metadata.

metadata

public SessionEvent.Builder metadata(String key,
 Object value)

Adds one metadata entry.

build

public SessionEvent build()

Builds the event, checking that the type and the message agree.