Class SessionShellApi

java.lang.Object

com.github.copilot.generated.rpc.SessionShellApi

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

API methods for the shell namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<SessionShellCancelUserRequestedResult>	cancelUserRequested(SessionShellCancelUserRequestedParams params)	User-requested shell execution cancellation handle.
CompletableFuture<SessionShellExecResult>	exec(SessionShellExecParams params)	Shell command to run, with optional working directory and timeout in milliseconds.
CompletableFuture<SessionShellExecuteUserRequestedResult>	executeUserRequested(SessionShellExecuteUserRequestedParams params)	User-requested shell command and cancellation handle.
CompletableFuture<SessionShellKillResult>	kill(SessionShellKillParams params)	Identifier of a process previously returned by "shell.exec" and the signal to send.

Methods inherited from class Object

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

Method Details

exec

@CopilotExperimental
public CompletableFuture<SessionShellExecResult> exec(SessionShellExecParams params)

Shell command to run, with optional working directory and timeout in milliseconds.

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

Since:

1.0.0

kill

@CopilotExperimental
public CompletableFuture<SessionShellKillResult> kill(SessionShellKillParams params)

Identifier of a process previously returned by "shell.exec" and the signal to send.

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

Since:

1.0.0

executeUserRequested

@CopilotExperimental
public CompletableFuture<SessionShellExecuteUserRequestedResult> executeUserRequested(SessionShellExecuteUserRequestedParams params)

User-requested shell command and cancellation handle.

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

Since:

1.0.0

cancelUserRequested

@CopilotExperimental
public CompletableFuture<SessionShellCancelUserRequestedResult> cancelUserRequested(SessionShellCancelUserRequestedParams params)

User-requested shell execution cancellation handle.

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

Since:

1.0.0