Module com.github.copilot.java

Package com.github.copilot.generated.rpc

Class SessionWorkspacesApi

java.lang.Object

com.github.copilot.generated.rpc.SessionWorkspacesApi

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

API methods for the workspaces namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	createFile(SessionWorkspacesCreateFileParams params)	Relative path and UTF-8 content for the workspace file to create or overwrite.
CompletableFuture<SessionWorkspacesDiffResult>	diff(SessionWorkspacesDiffParams params)	Parameters for computing a workspace diff.
CompletableFuture<SessionWorkspacesGetWorkspaceResult>	getWorkspace()	Identifies the target session.
CompletableFuture<SessionWorkspacesListCheckpointsResult>	listCheckpoints()	Identifies the target session.
CompletableFuture<SessionWorkspacesListFilesResult>	listFiles()	Identifies the target session.
CompletableFuture<SessionWorkspacesReadCheckpointResult>	readCheckpoint(SessionWorkspacesReadCheckpointParams params)	Checkpoint number to read.
CompletableFuture<SessionWorkspacesReadFileResult>	readFile(SessionWorkspacesReadFileParams params)	Relative path of the workspace file to read.
CompletableFuture<SessionWorkspacesSaveLargePasteResult>	saveLargePaste(SessionWorkspacesSaveLargePasteParams params)	Pasted content to save as a UTF-8 file in the session workspace.

Methods inherited from class java.lang.Object

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

Method Details

getWorkspace

public CompletableFuture<SessionWorkspacesGetWorkspaceResult> getWorkspace()

Identifies the target session.

Since:

1.0.0

listFiles

public CompletableFuture<SessionWorkspacesListFilesResult> listFiles()

Identifies the target session.

Since:

1.0.0

readFile

public CompletableFuture<SessionWorkspacesReadFileResult> readFile(SessionWorkspacesReadFileParams params)

Relative path of the workspace file to read.

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

Since:

1.0.0

createFile

public CompletableFuture<Void> createFile(SessionWorkspacesCreateFileParams params)

Relative path and UTF-8 content for the workspace file to create or overwrite.

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

Since:

1.0.0

listCheckpoints

public CompletableFuture<SessionWorkspacesListCheckpointsResult> listCheckpoints()

Identifies the target session.

Since:

1.0.0

readCheckpoint

public CompletableFuture<SessionWorkspacesReadCheckpointResult> readCheckpoint(SessionWorkspacesReadCheckpointParams params)

Checkpoint number to read.

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

Since:

1.0.0

saveLargePaste

public CompletableFuture<SessionWorkspacesSaveLargePasteResult> saveLargePaste(SessionWorkspacesSaveLargePasteParams params)

Pasted content to save as a UTF-8 file in the session workspace.

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

Since:

1.0.0

diff

public CompletableFuture<SessionWorkspacesDiffResult> diff(SessionWorkspacesDiffParams params)

Parameters for computing a workspace diff.

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

Since:

1.0.0