Class SessionWorkflowApi

java.lang.Object

com.github.copilot.generated.rpc.SessionWorkflowApi

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

API methods for the workflow namespace.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field	Description
final SessionWorkflowJournalApi	journal	API methods for the workflow.journal sub-namespace.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<SessionWorkflowAgentResult>	agent(SessionWorkflowAgentParams params)	Parameters for one workflow-scoped subagent call.
CompletableFuture<SessionWorkflowCancelResult>	cancel(SessionWorkflowCancelParams params)	Parameters for cancelling a workflow run.
CompletableFuture<SessionWorkflowGetRunResult>	getRun(SessionWorkflowGetRunParams params)	Parameters for retrieving a workflow run.
CompletableFuture<SessionWorkflowGetRunDetailResult>	getRunDetail(SessionWorkflowGetRunDetailParams params)	Parameters for retrieving a workflow run.
CompletableFuture<SessionWorkflowGetRunProgressResult>	getRunProgress(SessionWorkflowGetRunProgressParams params)	Parameters for paging workflow progress.
CompletableFuture<SessionWorkflowListRunsResult>	listRuns(SessionWorkflowListRunsParams params)	Parameters for paging workflow runs.
CompletableFuture<Void>	log(SessionWorkflowLogParams params)	Parameters for recording workflow progress.
CompletableFuture<SessionWorkflowPauseResult>	pause(SessionWorkflowPauseParams params)	Parameters for pausing a running workflow.
CompletableFuture<SessionWorkflowPauseAtCheckpointResult>	pauseAtCheckpoint(SessionWorkflowPauseAtCheckpointParams params)	Parameters for an owned durable pause checkpoint.
CompletableFuture<SessionWorkflowResumeResult>	resume(SessionWorkflowResumeParams params)	Parameters for resuming a workflow run from its persisted identity.
CompletableFuture<SessionWorkflowResumeFromToolResult>	resumeFromTool(SessionWorkflowResumeFromToolParams params)	Internal parameters for resuming a workflow run from a tool.
CompletableFuture<SessionWorkflowRunResult>	run(SessionWorkflowRunParams params)	Parameters for invoking a registered workflow.
CompletableFuture<SessionWorkflowRunFromToolResult>	runFromTool(SessionWorkflowRunFromToolParams params)	Internal parameters for invoking a registered workflow from a tool.

Methods inherited from class Object

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

Field Details

journal

public final SessionWorkflowJournalApi journal

API methods for the workflow.journal sub-namespace.

Method Details

run

@CopilotExperimental
public CompletableFuture<SessionWorkflowRunResult> run(SessionWorkflowRunParams params)

Parameters for invoking a registered workflow.

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<SessionWorkflowResumeResult> resume(SessionWorkflowResumeParams params)

Parameters for resuming a workflow 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

runFromTool

@CopilotExperimental
public CompletableFuture<SessionWorkflowRunFromToolResult> runFromTool(SessionWorkflowRunFromToolParams params)

Internal parameters for invoking a registered workflow from a tool.

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

Since:

1.0.0

resumeFromTool

@CopilotExperimental
public CompletableFuture<SessionWorkflowResumeFromToolResult> resumeFromTool(SessionWorkflowResumeFromToolParams params)

Internal parameters for resuming a workflow run from a tool.

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<SessionWorkflowGetRunResult> getRun(SessionWorkflowGetRunParams params)

Parameters for retrieving a workflow 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<SessionWorkflowListRunsResult> listRuns(SessionWorkflowListRunsParams params)

Parameters for paging workflow runs.

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

Since:

1.0.0

getRunDetail

@CopilotExperimental
public CompletableFuture<SessionWorkflowGetRunDetailResult> getRunDetail(SessionWorkflowGetRunDetailParams params)

Parameters for retrieving a workflow 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<SessionWorkflowGetRunProgressResult> getRunProgress(SessionWorkflowGetRunProgressParams params)

Parameters for paging workflow 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<SessionWorkflowCancelResult> cancel(SessionWorkflowCancelParams params)

Parameters for cancelling a workflow 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

pause

@CopilotExperimental
public CompletableFuture<SessionWorkflowPauseResult> pause(SessionWorkflowPauseParams params)

Parameters for pausing a running workflow.

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

Since:

1.0.0

pauseAtCheckpoint

@CopilotExperimental
public CompletableFuture<SessionWorkflowPauseAtCheckpointResult> pauseAtCheckpoint(SessionWorkflowPauseAtCheckpointParams params)

Parameters for an owned durable pause checkpoint.

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(SessionWorkflowLogParams params)

Parameters for recording workflow 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<SessionWorkflowAgentResult> agent(SessionWorkflowAgentParams params)

Parameters for one workflow-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