Class SessionQueueApi

java.lang.Object

com.github.copilot.generated.rpc.SessionQueueApi

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

API methods for the queue namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<SessionQueueBeginDeferredIdleDrainResult>	beginDeferredIdleDrain(SessionQueueBeginDeferredIdleDrainParams params)	Inputs for starting a deferred-idle drain.
CompletableFuture<Void>	clear()	Identifies the target session.
CompletableFuture<SessionQueueConsumeSystemNotificationsResult>	consumeSystemNotifications(SessionQueueConsumeSystemNotificationsParams params)	Internal filter for consuming queued system notifications.
CompletableFuture<Void>	deferSessionIdle(SessionQueueDeferSessionIdleParams params)	Inputs for marking session.idle deferred in native state.
CompletableFuture<SessionQueueDuplicateAtResult>	duplicateAt(SessionQueueDuplicateAtParams params)	Parameters for duplicating a queued item.
CompletableFuture<SessionQueueEnqueueResumePendingResult>	enqueueResumePending()	Identifies the target session.
CompletableFuture<SessionQueueFinishDeferredIdleDrainResult>	finishDeferredIdleDrain(SessionQueueFinishDeferredIdleDrainParams params)	Inputs for completing a deferred-idle drain.
CompletableFuture<SessionQueueHasPendingResult>	hasPending()	Identifies the target session.
CompletableFuture<SessionQueueInsertAtResult>	insertAt(SessionQueueInsertAtParams params)	Parameters for inserting a queued message at a public visible position.
CompletableFuture<SessionQueueMoveItemResult>	moveItem(SessionQueueMoveItemParams params)	Parameters for moving a queued item by stable id.
CompletableFuture<SessionQueuePendingItemsResult>	pendingItems()	Identifies the target session.
CompletableFuture<Void>	process()	Identifies the target session.
CompletableFuture<SessionQueueRemoveAtResult>	removeAt(SessionQueueRemoveAtParams params)	Parameters for removing a queued item by stable id.
CompletableFuture<SessionQueueRemoveMostRecentResult>	removeMostRecent()	Identifies the target session.
CompletableFuture<SessionQueueSendNowResult>	sendNow(SessionQueueSendNowParams params)	Parameters for steering a queued message into a live turn.
CompletableFuture<Void>	setDrainPaused(SessionQueueSetDrainPausedParams params)	Parameters for acquiring or releasing the queued-lane drain pause.
CompletableFuture<SessionQueueSnapshotResult>	snapshot()	Identifies the target session.
CompletableFuture<SessionQueueUpdateTextResult>	updateText(SessionQueueUpdateTextParams params)	Parameters for editing a single queued message.

Methods inherited from class Object

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

Method Details

pendingItems

@CopilotExperimental
public CompletableFuture<SessionQueuePendingItemsResult> pendingItems()

Identifies the target session.

Since:

1.0.0

snapshot

@CopilotExperimental
public CompletableFuture<SessionQueueSnapshotResult> snapshot()

Identifies the target session.

Since:

1.0.0

moveItem

@CopilotExperimental
public CompletableFuture<SessionQueueMoveItemResult> moveItem(SessionQueueMoveItemParams params)

Parameters for moving a queued item by stable id.

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

Since:

1.0.0

insertAt

@CopilotExperimental
public CompletableFuture<SessionQueueInsertAtResult> insertAt(SessionQueueInsertAtParams params)

Parameters for inserting a queued message at a public visible position.

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

Since:

1.0.0

removeAt

@CopilotExperimental
public CompletableFuture<SessionQueueRemoveAtResult> removeAt(SessionQueueRemoveAtParams params)

Parameters for removing a queued item by stable id.

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

Since:

1.0.0

updateText

@CopilotExperimental
public CompletableFuture<SessionQueueUpdateTextResult> updateText(SessionQueueUpdateTextParams params)

Parameters for editing a single queued message.

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

Since:

1.0.0

duplicateAt

@CopilotExperimental
public CompletableFuture<SessionQueueDuplicateAtResult> duplicateAt(SessionQueueDuplicateAtParams params)

Parameters for duplicating a queued item.

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

Since:

1.0.0

setDrainPaused

@CopilotExperimental
public CompletableFuture<Void> setDrainPaused(SessionQueueSetDrainPausedParams params)

Parameters for acquiring or releasing the queued-lane drain pause. Acquisition is exclusive and non-idempotent: `paused: true` against an already-paused session fails with `queue_already_paused`. The pause is never released automatically — it is not tied to the caller's lifetime, so a client that exits without sending `paused: false` leaves the lane frozen. Release is unowned: `paused: false` clears the pause for any caller, including one that never acquired it.

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

Since:

1.0.0

sendNow

@CopilotExperimental
public CompletableFuture<SessionQueueSendNowResult> sendNow(SessionQueueSendNowParams params)

Parameters for steering a queued message into a live turn.

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

Since:

1.0.0

hasPending

@CopilotExperimental
public CompletableFuture<SessionQueueHasPendingResult> hasPending()

Identifies the target session.

Since:

1.0.0

beginDeferredIdleDrain

@CopilotExperimental
public CompletableFuture<SessionQueueBeginDeferredIdleDrainResult> beginDeferredIdleDrain(SessionQueueBeginDeferredIdleDrainParams params)

Inputs for starting a deferred-idle drain.

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

Since:

1.0.0

finishDeferredIdleDrain

@CopilotExperimental
public CompletableFuture<SessionQueueFinishDeferredIdleDrainResult> finishDeferredIdleDrain(SessionQueueFinishDeferredIdleDrainParams params)

Inputs for completing a deferred-idle drain.

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

Since:

1.0.0

deferSessionIdle

@CopilotExperimental
public CompletableFuture<Void> deferSessionIdle(SessionQueueDeferSessionIdleParams params)

Inputs for marking session.idle deferred in native state.

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

Since:

1.0.0

removeMostRecent

@CopilotExperimental
public CompletableFuture<SessionQueueRemoveMostRecentResult> removeMostRecent()

Identifies the target session.

Since:

1.0.0

clear

@CopilotExperimental
public CompletableFuture<Void> clear()

Identifies the target session.

Since:

1.0.0

consumeSystemNotifications

@CopilotExperimental
public CompletableFuture<SessionQueueConsumeSystemNotificationsResult> consumeSystemNotifications(SessionQueueConsumeSystemNotificationsParams params)

Internal filter for consuming queued system notifications.

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

Since:

1.0.0

enqueueResumePending

@CopilotExperimental
public CompletableFuture<SessionQueueEnqueueResumePendingResult> enqueueResumePending()

Identifies the target session.

Since:

1.0.0

process

@CopilotExperimental
public CompletableFuture<Void> process()

Identifies the target session.

Since:

1.0.0