Class SessionEventLogApi

java.lang.Object

com.github.copilot.generated.rpc.SessionEventLogApi

@Generated("copilot-sdk-codegen")
public final class SessionEventLogApi
extends Object

API methods for the eventLog namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<SessionEventLogReadResult>	read(SessionEventLogReadParams params)	Reads a batch of session events from a cursor, optionally waiting for new events.
CompletableFuture<SessionEventLogRegisterInterestResult>	registerInterest(SessionEventLogRegisterInterestParams params)	Registers consumer interest in an event type for runtime gating purposes.
CompletableFuture<SessionEventLogReleaseInterestResult>	releaseInterest(SessionEventLogReleaseInterestParams params)	Releases a consumer's previously-registered interest in an event type.
CompletableFuture<SessionEventLogTailResult>	tail()	Returns a snapshot of the current tail cursor without consuming events.

Methods inherited from class Object

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

Method Details

read

@CopilotExperimental
public CompletableFuture<SessionEventLogReadResult> read(SessionEventLogReadParams params)

Reads a batch of session events from a cursor, optionally waiting for new events. Supports tail-first reads via `direction: backward`.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

tail

@CopilotExperimental
public CompletableFuture<SessionEventLogTailResult> tail()

Returns a snapshot of the current tail cursor without consuming events.

Since:

1.0.0

registerInterest

@CopilotExperimental
public CompletableFuture<SessionEventLogRegisterInterestResult> registerInterest(SessionEventLogRegisterInterestParams params)

Registers consumer interest in an event type for runtime gating purposes.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0

releaseInterest

@CopilotExperimental
public CompletableFuture<SessionEventLogReleaseInterestResult> releaseInterest(SessionEventLogReleaseInterestParams params)

Releases a consumer's previously-registered interest in an event type.

Note: the sessionId field in the params record is overridden by the session-scoped wrapper; any value provided is ignored.

Since:

1.0.0