Module com.github.copilot.java
Package com.github.copilot.generated.rpc

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 Details

    • auth

      public final SessionAuthApi auth
      API methods for the auth namespace.

    • canvas

      public final SessionCanvasApi canvas
      API methods for the canvas 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.

    • 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.

    • 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.

    • 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.

    • remote

      public final SessionRemoteApi remote
      API methods for the remote 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

      public CompletableFuture<Void> suspend()
      Identifies the target session.
      Since:
      1.0.0

    • send

      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

    • abort

      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

    • shutdown

      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

      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