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)	Runs one dynamic-workflow-scoped subagent and returns its result.
CompletableFuture<SessionWorkflowCancelResult>	cancel(SessionWorkflowCancelParams params)	Requests cancellation of a dynamic workflow run and returns its run envelope.
CompletableFuture<SessionWorkflowGetRunResult>	getRun(SessionWorkflowGetRunParams params)	Gets the current or settled envelope for a dynamic workflow run.
CompletableFuture<SessionWorkflowGetRunDetailResult>	getRunDetail(SessionWorkflowGetRunDetailParams params)	Gets durable and live observability detail for one dynamic workflow run.
CompletableFuture<SessionWorkflowGetRunProgressResult>	getRunProgress(SessionWorkflowGetRunProgressParams params)	Pages durable progress for one dynamic workflow run.
CompletableFuture<SessionWorkflowListRunsResult>	listRuns(SessionWorkflowListRunsParams params)	Lists durable dynamic workflow runs for this session in creation order.
CompletableFuture<Void>	log(SessionWorkflowLogParams params)	Records a batch of ordered dynamic workflow progress lines.
CompletableFuture<SessionWorkflowPauseResult>	pause(SessionWorkflowPauseParams params)	Pauses a running dynamic workflow and returns its settled run envelope.
CompletableFuture<SessionWorkflowResumeResult>	resume(SessionWorkflowResumeParams params)	Resumes a dynamic workflow run using its persisted name, arguments, journal, and accounting.
CompletableFuture<SessionWorkflowRunResult>	run(SessionWorkflowRunParams params)	Runs a registered dynamic workflow by name at the top level.

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)

Runs a registered dynamic workflow by name at the top level.

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)

Resumes a dynamic workflow run using its persisted name, arguments, journal, and accounting.

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)

Gets the current or settled envelope for a dynamic 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)

Lists durable dynamic workflow runs for this session in creation order.

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)

Gets durable and live observability detail for one dynamic 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)

Pages durable progress for one dynamic 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

cancel

@CopilotExperimental
public CompletableFuture<SessionWorkflowCancelResult> cancel(SessionWorkflowCancelParams params)

Requests cancellation of a dynamic workflow run and returns its run envelope.

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)

Pauses a running dynamic workflow and returns its settled run envelope.

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)

Records a batch of ordered dynamic workflow progress lines.

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)

Runs one dynamic-workflow-scoped subagent and returns its result.

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

Since:

1.0.0