Class SessionFactoryApi

java.lang.Object

com.github.copilot.generated.rpc.SessionFactoryApi

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

API methods for the factory namespace.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
final SessionFactoryJournalApi	journal	API methods for the factory.journal sub-namespace.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<SessionFactoryAgentResult>	agent(SessionFactoryAgentParams params)	Parameters for one factory-scoped subagent call.
CompletableFuture<SessionFactoryCancelResult>	cancel(SessionFactoryCancelParams params)	Parameters for cancelling a factory run.
CompletableFuture<SessionFactoryGetRunResult>	getRun(SessionFactoryGetRunParams params)	Parameters for retrieving a factory run.
CompletableFuture<SessionFactoryGetRunDetailResult>	getRunDetail(SessionFactoryGetRunDetailParams params)	Parameters for retrieving a factory run.
CompletableFuture<SessionFactoryGetRunProgressResult>	getRunProgress(SessionFactoryGetRunProgressParams params)	Parameters for paging factory progress.
CompletableFuture<SessionFactoryListRunsResult>	listRuns()	Empty parameters for listing factory runs.
CompletableFuture<Void>	log(SessionFactoryLogParams params)	Parameters for recording factory progress.
CompletableFuture<SessionFactoryResumeResult>	resume(SessionFactoryResumeParams params)	Parameters for resuming a factory run from its persisted identity.
CompletableFuture<SessionFactoryRunResult>	run(SessionFactoryRunParams params)	Parameters for invoking a registered factory.

Methods inherited from class Object

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

Field Details

journal

public final SessionFactoryJournalApi journal

API methods for the factory.journal sub-namespace.

Method Details

run

@CopilotExperimental
public CompletableFuture<SessionFactoryRunResult> run(SessionFactoryRunParams params)

Parameters for invoking a registered factory.

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

Since:

1.0.0

resume

@CopilotExperimental
public CompletableFuture<SessionFactoryResumeResult> resume(SessionFactoryResumeParams params)

Parameters for resuming a factory run from its persisted identity.

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

Since:

1.0.0

getRun

@CopilotExperimental
public CompletableFuture<SessionFactoryGetRunResult> getRun(SessionFactoryGetRunParams params)

Parameters for retrieving a factory run.

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

Since:

1.0.0

listRuns

@CopilotExperimental
public CompletableFuture<SessionFactoryListRunsResult> listRuns()

Empty parameters for listing factory runs.

Since:

1.0.0

getRunDetail

@CopilotExperimental
public CompletableFuture<SessionFactoryGetRunDetailResult> getRunDetail(SessionFactoryGetRunDetailParams params)

Parameters for retrieving a factory run.

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

Since:

1.0.0

getRunProgress

@CopilotExperimental
public CompletableFuture<SessionFactoryGetRunProgressResult> getRunProgress(SessionFactoryGetRunProgressParams params)

Parameters for paging factory progress.

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

Since:

1.0.0

cancel

@CopilotExperimental
public CompletableFuture<SessionFactoryCancelResult> cancel(SessionFactoryCancelParams params)

Parameters for cancelling a factory run.

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<Void> log(SessionFactoryLogParams params)

Parameters for recording factory progress.

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

Since:

1.0.0

agent

@CopilotExperimental
public CompletableFuture<SessionFactoryAgentResult> agent(SessionFactoryAgentParams params)

Parameters for one factory-scoped subagent call.

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

Since:

1.0.0