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<SessionWorkspacesAddSummaryResult>	addSummary(SessionWorkspacesAddSummaryParams params)	Compaction summary checkpoint to persist.
CompletableFuture<SessionWorkspacesAutopilotObjectiveExistsResult>	autopilotObjectiveExists()	Identifies the target session.
CompletableFuture<Void>	createDirectory(SessionWorkspacesCreateDirectoryParams params)	Directory to create within the session workspace files directory.
CompletableFuture<Void>	createFile(SessionWorkspacesCreateFileParams params)	Relative path and UTF-8 content for the workspace file to create or overwrite.
CompletableFuture<SessionWorkspacesDeleteAutopilotObjectiveResult>	deleteAutopilotObjective()	Identifies the target session.
CompletableFuture<SessionWorkspacesDiffResult>	diff(SessionWorkspacesDiffParams params)	Parameters for computing a workspace diff.
CompletableFuture<SessionWorkspacesEnsureResult>	ensure(SessionWorkspacesEnsureParams params)	Optional session context used when creating a local workspace.
CompletableFuture<SessionWorkspacesGetWorkspaceResult>	getWorkspace()	Identifies the target session.
CompletableFuture<SessionWorkspacesListCheckpointsResult>	listCheckpoints()	Identifies the target session.
CompletableFuture<SessionWorkspacesListFilesResult>	listFiles()	Identifies the target session.
CompletableFuture<SessionWorkspacesReadAutopilotObjectiveResult>	readAutopilotObjective()	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<Void>	removePath(SessionWorkspacesRemovePathParams params)	File or directory to remove from the session workspace files directory.
CompletableFuture<Void>	renamePath(SessionWorkspacesRenamePathParams params)	Source and destination paths for a rename within the session workspace files directory.
CompletableFuture<SessionWorkspacesSaveLargePasteResult>	saveLargePaste(SessionWorkspacesSaveLargePasteParams params)	Pasted content to save as a UTF-8 file in the session workspace.
CompletableFuture<SessionWorkspacesStatFileResult>	statFile(SessionWorkspacesStatFileParams params)	Relative path of the workspace file or directory to inspect.
CompletableFuture<SessionWorkspacesTruncateSummariesResult>	truncateSummaries(SessionWorkspacesTruncateSummariesParams params)	Rollback point for local workspace summaries.
CompletableFuture<SessionWorkspacesUpdateMetadataResult>	updateMetadata(SessionWorkspacesUpdateMetadataParams params)	Workspace metadata fields to update.
CompletableFuture<SessionWorkspacesWriteAutopilotObjectiveResult>	writeAutopilotObjective(SessionWorkspacesWriteAutopilotObjectiveParams params)	Autopilot objective file content to persist.

Methods inherited from class Object

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

Method Details

getWorkspace

@CopilotExperimental
public CompletableFuture<SessionWorkspacesGetWorkspaceResult> getWorkspace()

Identifies the target session.

Since:

1.0.0

updateMetadata

@CopilotExperimental
public CompletableFuture<SessionWorkspacesUpdateMetadataResult> updateMetadata(SessionWorkspacesUpdateMetadataParams params)

Workspace metadata fields to update.

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

Since:

1.0.0

ensure

@CopilotExperimental
public CompletableFuture<SessionWorkspacesEnsureResult> ensure(SessionWorkspacesEnsureParams params)

Optional session context used when creating a local 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

listFiles

@CopilotExperimental
public CompletableFuture<SessionWorkspacesListFilesResult> listFiles()

Identifies the target session.

Since:

1.0.0

readFile

@CopilotExperimental
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

@CopilotExperimental
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

statFile

@CopilotExperimental
public CompletableFuture<SessionWorkspacesStatFileResult> statFile(SessionWorkspacesStatFileParams params)

Relative path of the workspace file or directory to inspect.

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

Since:

1.0.0

createDirectory

@CopilotExperimental
public CompletableFuture<Void> createDirectory(SessionWorkspacesCreateDirectoryParams params)

Directory to create within the session workspace files directory.

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

Since:

1.0.0

removePath

@CopilotExperimental
public CompletableFuture<Void> removePath(SessionWorkspacesRemovePathParams params)

File or directory to remove from the session workspace files directory.

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

Since:

1.0.0

renamePath

@CopilotExperimental
public CompletableFuture<Void> renamePath(SessionWorkspacesRenamePathParams params)

Source and destination paths for a rename within the session workspace files directory.

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

@CopilotExperimental
public CompletableFuture<SessionWorkspacesListCheckpointsResult> listCheckpoints()

Identifies the target session.

Since:

1.0.0

readCheckpoint

@CopilotExperimental
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

addSummary

@CopilotExperimental
public CompletableFuture<SessionWorkspacesAddSummaryResult> addSummary(SessionWorkspacesAddSummaryParams params)

Compaction summary checkpoint to persist.

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

Since:

1.0.0

truncateSummaries

@CopilotExperimental
public CompletableFuture<SessionWorkspacesTruncateSummariesResult> truncateSummaries(SessionWorkspacesTruncateSummariesParams params)

Rollback point for local workspace summaries.

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

Since:

1.0.0

readAutopilotObjective

@CopilotExperimental
public CompletableFuture<SessionWorkspacesReadAutopilotObjectiveResult> readAutopilotObjective()

Identifies the target session.

Since:

1.0.0

writeAutopilotObjective

@CopilotExperimental
public CompletableFuture<SessionWorkspacesWriteAutopilotObjectiveResult> writeAutopilotObjective(SessionWorkspacesWriteAutopilotObjectiveParams params)

Autopilot objective file content to persist.

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

Since:

1.0.0

deleteAutopilotObjective

@CopilotExperimental
public CompletableFuture<SessionWorkspacesDeleteAutopilotObjectiveResult> deleteAutopilotObjective()

Identifies the target session.

Since:

1.0.0

autopilotObjectiveExists

@CopilotExperimental
public CompletableFuture<SessionWorkspacesAutopilotObjectiveExistsResult> autopilotObjectiveExists()

Identifies the target session.

Since:

1.0.0

saveLargePaste

@CopilotExperimental
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

@CopilotExperimental
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