Class SessionRpc

java.lang.Object

com.github.copilot.generated.rpc.SessionRpc

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

Typed client for session-scoped RPC methods.

Provides strongly-typed access to all session-level API namespaces. The sessionId is injected automatically into every call.

Obtain an instance by calling new SessionRpc(caller, sessionId).

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
final SessionAgentApi	agent	API methods for the agent namespace.
final SessionCanvasApi	canvas	API methods for the canvas namespace.
final SessionCommandsApi	commands	API methods for the commands namespace.
final SessionCompletionsApi	completions	API methods for the completions namespace.
final SessionContentExclusionApi	contentExclusion	API methods for the contentExclusion namespace.
final SessionDebugApi	debug	API methods for the debug namespace.
final SessionEventLogApi	eventLog	API methods for the eventLog namespace.
final SessionExtensionsApi	extensions	API methods for the extensions namespace.
final SessionFactoryApi	factory	API methods for the factory namespace.
final SessionFleetApi	fleet	API methods for the fleet namespace.
final SessionGitHubAuthApi	gitHubAuth	API methods for the gitHubAuth namespace.
final SessionHistoryApi	history	API methods for the history namespace.
final SessionInstructionsApi	instructions	API methods for the instructions namespace.
final SessionLimitPredictionApi	limitPrediction	API methods for the limitPrediction namespace.
final SessionLspApi	lsp	API methods for the lsp namespace.
final SessionMcpApi	mcp	API methods for the mcp namespace.
final SessionMetadataApi	metadata	API methods for the metadata namespace.
final SessionModeApi	mode	API methods for the mode namespace.
final SessionModelApi	model	API methods for the model namespace.
final SessionNameApi	name	API methods for the name namespace.
final SessionOptionsApi	options	API methods for the options namespace.
final SessionPermissionsApi	permissions	API methods for the permissions namespace.
final SessionPlanApi	plan	API methods for the plan namespace.
final SessionPluginsApi	plugins	API methods for the plugins namespace.
final SessionProviderApi	provider	API methods for the provider namespace.
final SessionQueueApi	queue	API methods for the queue namespace.
final SessionRemoteApi	remote	API methods for the remote namespace.
final SessionScheduleApi	schedule	API methods for the schedule namespace.
final SessionSettingsApi	settings	API methods for the settings namespace.
final SessionShellApi	shell	API methods for the shell namespace.
final SessionSkillsApi	skills	API methods for the skills namespace.
final SessionTasksApi	tasks	API methods for the tasks namespace.
final SessionTelemetryApi	telemetry	API methods for the telemetry namespace.
final SessionToolsApi	tools	API methods for the tools namespace.
final SessionUiApi	ui	API methods for the ui namespace.
final SessionUsageApi	usage	API methods for the usage namespace.
final SessionVisibilityApi	visibility	API methods for the visibility namespace.
final SessionWorkspacesApi	workspaces	API methods for the workspaces namespace.

Constructor Summary

Constructors

Constructor	Description
SessionRpc(RpcCaller caller, String sessionId)	Creates a new session RPC client.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<SessionAbortResult>	abort(SessionAbortParams params)	Parameters for aborting the current turn
CompletableFuture<Void>	cancelAllBackgroundAgents()	Identifies the target session.
CompletableFuture<SessionInterruptMainTurnResult>	interruptMainTurn(SessionInterruptMainTurnParams params)	Parameters for interrupting the main agent turn.
CompletableFuture<SessionLogResult>	log(SessionLogParams params)	Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip.
CompletableFuture<SessionSendResult>	send(SessionSendParams params)	Parameters for sending a user message to the session
CompletableFuture<SessionSendMessagesResult>	sendMessages(SessionSendMessagesParams params)	Parameters for sending zero or more user messages to the session in a single turn.
CompletableFuture<Void>	sendSystemNotification(SessionSendSystemNotificationParams params)	Internal request for sending a system notification.
CompletableFuture<Void>	shutdown(SessionShutdownParams params)	Parameters for shutting down the session
CompletableFuture<Void>	suspend()	Identifies the target session.

Methods inherited from class Object

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

Field Details

gitHubAuth

public final SessionGitHubAuthApi gitHubAuth

API methods for the gitHubAuth namespace.

debug

public final SessionDebugApi debug

API methods for the debug namespace.

canvas

public final SessionCanvasApi canvas

API methods for the canvas namespace.

factory

public final SessionFactoryApi factory

API methods for the factory namespace.

model

public final SessionModelApi model

API methods for the model namespace.

mode

public final SessionModeApi mode

API methods for the mode namespace.

name

public final SessionNameApi name

API methods for the name namespace.

plan

public final SessionPlanApi plan

API methods for the plan namespace.

workspaces

public final SessionWorkspacesApi workspaces

API methods for the workspaces namespace.

completions

public final SessionCompletionsApi completions

API methods for the completions namespace.

instructions

public final SessionInstructionsApi instructions

API methods for the instructions namespace.

fleet

public final SessionFleetApi fleet

API methods for the fleet namespace.

agent

public final SessionAgentApi agent

API methods for the agent namespace.

tasks

public final SessionTasksApi tasks

API methods for the tasks namespace.

skills

public final SessionSkillsApi skills

API methods for the skills namespace.

mcp

public final SessionMcpApi mcp

API methods for the mcp namespace.

plugins

public final SessionPluginsApi plugins

API methods for the plugins namespace.

provider

public final SessionProviderApi provider

API methods for the provider namespace.

options

public final SessionOptionsApi options

API methods for the options namespace.

lsp

public final SessionLspApi lsp

API methods for the lsp namespace.

extensions

public final SessionExtensionsApi extensions

API methods for the extensions namespace.

tools

public final SessionToolsApi tools

API methods for the tools namespace.

commands

public final SessionCommandsApi commands

API methods for the commands namespace.

telemetry

public final SessionTelemetryApi telemetry

API methods for the telemetry namespace.

ui

public final SessionUiApi ui

API methods for the ui namespace.

permissions

public final SessionPermissionsApi permissions

API methods for the permissions namespace.

metadata

public final SessionMetadataApi metadata

API methods for the metadata namespace.

settings

public final SessionSettingsApi settings

API methods for the settings namespace.

contentExclusion

public final SessionContentExclusionApi contentExclusion

API methods for the contentExclusion namespace.

shell

public final SessionShellApi shell

API methods for the shell namespace.

history

public final SessionHistoryApi history

API methods for the history namespace.

queue

public final SessionQueueApi queue

API methods for the queue namespace.

eventLog

public final SessionEventLogApi eventLog

API methods for the eventLog namespace.

usage

public final SessionUsageApi usage

API methods for the usage namespace.

limitPrediction

public final SessionLimitPredictionApi limitPrediction

API methods for the limitPrediction namespace.

remote

public final SessionRemoteApi remote

API methods for the remote namespace.

visibility

public final SessionVisibilityApi visibility

API methods for the visibility namespace.

schedule

public final SessionScheduleApi schedule

API methods for the schedule namespace.

Constructor Details

SessionRpc

public SessionRpc(RpcCaller caller,
 String sessionId)

Creates a new session RPC client.

Parameters:

caller - the RPC transport function (e.g., jsonRpcClient::invoke)

sessionId - the session ID to inject into every request

Method Details

suspend

@CopilotExperimental
public CompletableFuture<Void> suspend()

Identifies the target session.

Since:

1.0.0

send

@CopilotExperimental
public CompletableFuture<SessionSendResult> send(SessionSendParams params)

Parameters for sending a user message to the session

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

Since:

1.0.0

sendMessages

@CopilotExperimental
public CompletableFuture<SessionSendMessagesResult> sendMessages(SessionSendMessagesParams params)

Parameters for sending zero or more user messages to the session in a single turn. Remote-backed (Mission Control) sessions do not support this method and will return an error.

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

Since:

1.0.0

sendSystemNotification

@CopilotExperimental
public CompletableFuture<Void> sendSystemNotification(SessionSendSystemNotificationParams params)

Internal request for sending a system notification.

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

Since:

1.0.0

abort

@CopilotExperimental
public CompletableFuture<SessionAbortResult> abort(SessionAbortParams params)

Parameters for aborting the current turn

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

Since:

1.0.0

interruptMainTurn

@CopilotExperimental
public CompletableFuture<SessionInterruptMainTurnResult> interruptMainTurn(SessionInterruptMainTurnParams params)

Parameters for interrupting the main agent turn.

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

Since:

1.0.0

cancelAllBackgroundAgents

@CopilotExperimental
public CompletableFuture<Void> cancelAllBackgroundAgents()

Identifies the target session.

Since:

1.0.0

shutdown

@CopilotExperimental
public CompletableFuture<Void> shutdown(SessionShutdownParams params)

Parameters for shutting down the session

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

Since:

1.0.0

log

@CopilotExperimental
public CompletableFuture<SessionLogResult> log(SessionLogParams params)

Message text, optional severity level, persistence flag, optional follow-up URL, and optional tip.

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

Since:

1.0.0