Class SessionConnectorsApi

java.lang.Object

com.github.copilot.generated.rpc.SessionConnectorsApi

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

API methods for the connectors namespace.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
CompletableFuture<ConnectorConnectResult>	connect(SessionConnectorsConnectParams params)	Initiates an idempotent Connector connection request without opening a browser.
CompletableFuture<ConnectorConnectResult>	continueConnection(SessionConnectorsContinueConnectionParams params)	Continues a pending Connector connection with caller-supplied attempt, interval, and deadline bounds.
CompletableFuture<SessionConnectorsDisconnectResult>	disconnect(SessionConnectorsDisconnectParams params)	Disconnects one Connector for the pinned opaque account selection, refreshes the authoritative catalog, and removes its session-owned MCP projection.
CompletableFuture<ConnectorSessionAccount>	getAccount()	Returns the session account selection, or null.
CompletableFuture<SessionConnectorsGetCapabilitiesResult>	getCapabilities()	Returns feature availability and bounded polling limits for the EXPERIMENTAL session connector API.
CompletableFuture<SessionConnectorsGetStatusResult>	getStatus()	Returns authoritative session Connector state from current availability, pinned account selection, cached catalog, and live MCP projection without performing a Connector service request.
CompletableFuture<SessionConnectorsListResult>	list(SessionConnectorsListParams params)	Returns the cached Connector catalog for the pinned opaque account selection, fetching it only when this session has no cached catalog.
CompletableFuture<SessionConnectorsReconcileResult>	reconcile(SessionConnectorsReconcileParams params)	Reconciles the authoritative cached or freshly requested Connector catalog into the session Connector MCP projection and returns live status.
CompletableFuture<SessionConnectorsReconcileResult>	reconcile(SessionConnectorsReconcileRequest request)	Reconciles the authoritative cached or freshly requested Connector catalog into the session Connector MCP projection and returns live status.
CompletableFuture<ConnectorConnectResult>	reconnect(SessionConnectorsReconnectParams params)	Re-initiates an idempotent Connector connection request without browser or UI effects, with the same typed outcomes as connect.
CompletableFuture<SessionConnectorsRefreshResult>	refresh(SessionConnectorsRefreshParams params)	Refreshes and validates the Connector catalog for the pinned opaque account selection.

Methods inherited from class Object

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

Method Details

getCapabilities

@CopilotExperimental
public CompletableFuture<SessionConnectorsGetCapabilitiesResult> getCapabilities()

Returns feature availability and bounded polling limits for the EXPERIMENTAL session connector API. This method never performs a Connector service request.

Since:

1.0.0

getAccount

@CopilotExperimental
public CompletableFuture<ConnectorSessionAccount> getAccount()

Returns the session account selection, or null.

Returns:

a future that completes with the ConnectorSessionAccount value, or null when the result is absent. Callers must handle the null completion value.

Since:

1.0.0

getStatus

@CopilotExperimental
public CompletableFuture<SessionConnectorsGetStatusResult> getStatus()

Returns authoritative session Connector state from current availability, pinned account selection, cached catalog, and live MCP projection without performing a Connector service request.

Since:

1.0.0

list

@CopilotExperimental
public CompletableFuture<SessionConnectorsListResult> list(SessionConnectorsListParams params)

Returns the cached Connector catalog for the pinned opaque account selection, fetching it only when this session has no cached catalog.

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

Since:

1.0.0

refresh

@CopilotExperimental
public CompletableFuture<SessionConnectorsRefreshResult> refresh(SessionConnectorsRefreshParams params)

Refreshes and validates the Connector catalog for the pinned opaque account selection.

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

Since:

1.0.0

connect

@CopilotExperimental
public CompletableFuture<ConnectorConnectResult> connect(SessionConnectorsConnectParams params)

Initiates an idempotent Connector connection request without opening a browser. Returns connected when the service is immediately authoritative, consent_required with a validated URL, or pending with an opaque continuation 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

reconnect

@CopilotExperimental
public CompletableFuture<ConnectorConnectResult> reconnect(SessionConnectorsReconnectParams params)

Re-initiates an idempotent Connector connection request without browser or UI effects, with the same typed outcomes as connect.

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

Since:

1.0.0

continueConnection

@CopilotExperimental
public CompletableFuture<ConnectorConnectResult> continueConnection(SessionConnectorsContinueConnectionParams params)

Continues a pending Connector connection with caller-supplied attempt, interval, and deadline bounds. The runtime never opens the returned consent URL.

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

Since:

1.0.0

disconnect

@CopilotExperimental
public CompletableFuture<SessionConnectorsDisconnectResult> disconnect(SessionConnectorsDisconnectParams params)

Disconnects one Connector for the pinned opaque account selection, refreshes the authoritative catalog, and removes its session-owned MCP projection.

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

Since:

1.0.0

reconcile

@CopilotExperimental
public CompletableFuture<SessionConnectorsReconcileResult> reconcile(SessionConnectorsReconcileParams params)

Reconciles the authoritative cached or freshly requested Connector catalog into the session Connector MCP projection and returns live status.

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

Since:

1.0.0

reconcile

@CopilotExperimental
public CompletableFuture<SessionConnectorsReconcileResult> reconcile(SessionConnectorsReconcileRequest request)

Reconciles the authoritative cached or freshly requested Connector catalog into the session Connector MCP projection and returns live status.

Accepts the extensible request, including inputs added after the params record.

Since:

1.0.0