Uses of Package
com.github.copilot.generated
Packages that use com.github.copilot.generated
Package
Description
Core classes for the GitHub Copilot SDK for Java.
Auto-generated session event types for the GitHub Copilot SDK.
Configuration classes and data transfer objects for the Copilot SDK.
-
Classes in com.github.copilot.generated used by com.github.copilotClassDescriptionSession event "assistant.message".Base class for all generated session events.
-
Classes in com.github.copilot.generated used by com.github.copilot.generatedClassDescriptionData payload for
AbortEvent.Finite reason code describing why the current turn was abortedData payload forAssistantIdleEvent.Data payload forAssistantIntentEvent.Data payload forAssistantMessageDeltaEvent.Data payload forAssistantMessageEvent.Neutral provider-tagged server-side tool-use payload (tool search, advisor) for verbatim round-trippingData payload forAssistantMessageStartEvent.A tool invocation request from the assistantTool call type: "function" for standard tool calls, "custom" for grammar-based tool calls.Data payload forAssistantReasoningDeltaEvent.Data payload forAssistantReasoningEvent.Data payload forAssistantStreamingDeltaEvent.Data payload forAssistantTurnEndEvent.Data payload forAssistantTurnStartEvent.API endpoint used for this model call, matching CAPI supported_endpoints vocabularyPer-request cost and usage data from the CAPI copilot_usage response fieldToken usage detail for a single billing categoryData payload forAssistantUsageEvent.Schema for the `AssistantUsageQuotaSnapshot` type.Data payload forAutoModeSwitchCompletedEvent.Data payload forAutoModeSwitchRequestedEvent.The user's auto-mode-switch choiceThe type of operation performed on the autopilot objective state fileCurrent autopilot objective status, if one existsBinary asset type discriminator.Schema for the `CanvasRegistryChangedCanvas` type.Schema for the `CanvasRegistryChangedCanvasAction` type.Data payload forCapabilitiesChangedEvent.UI capability changesA source supplied by a tool that should be made available to the model as citable content.The system that produced a citation.A single citation occurrence linking a span of generated text to a supporting source.Provider-agnostic citations linking spans of the assistant's response to their supporting sources.A source that backs one or more cited spans in the assistant's response.A contiguous span of generated assistant text and the source references that support it.Data payload forCommandCompletedEvent.Data payload forCommandExecuteEvent.Data payload forCommandQueuedEvent.Schema for the `CommandsChangedCommand` type.Data payload forCommandsChangedEvent.Token usage breakdown for the compaction LLM call (aligned with assistant.usage format)Per-request cost and usage data from the CAPI copilot_usage response fieldToken usage detail for a single billing categoryAllowed values for the `ContextTier` enumeration.Schema for the `CustomAgentsUpdatedAgent` type.The user action: "accept" (submitted form), "decline" (explicitly refused), or "cancel" (dismissed)Data payload forElicitationCompletedEvent.Data payload forElicitationRequestedEvent.Elicitation mode; "form" for structured input, "url" for browser-based.JSON Schema describing the form fields to present to the user (form mode only)Exit plan mode actionData payload forExitPlanModeCompletedEvent.Data payload forExitPlanModeRequestedEvent.Schema for the `ExtensionsLoadedExtension` type.Discovery sourceCurrent status: running, disabled, failed, or startingData payload forExternalToolCompletedEvent.Data payload forExternalToolRequestedEvent.Repository context for the handed-off sessionOrigin type of the session being handed offError details when the hook failedData payload forHookEndEvent.Data payload forHookProgressEvent.Data payload forHookStartEvent.Set when the underlying tools/call threw an error before returning a CallToolResultData payload forMcpAppToolCallCompleteEvent.The tool's `_meta.ui` block at the time of the call, so consumers can decide whether to forward the result to the model without re-listing tools.Schema for the `McpAppToolCallCompleteToolMetaUI` type.Data payload forMcpHeadersRefreshCompletedEvent.How the pending MCP headers refresh request resolved.Data payload forMcpHeadersRefreshRequiredEvent.Why dynamic headers are being requested.Data payload forMcpOauthCompletedEvent.How the pending MCP OAuth request was completedReason the runtime is requesting host-provided MCP OAuth credentialsData payload forMcpOauthRequiredEvent.Static OAuth client configuration, if the server specifies oneOAuth WWW-Authenticate parameters parsed from an MCP auth challengeSchema for the `McpServersLoadedServer` type.Configuration source: user, workspace, plugin, or builtinConnection status: connected, failed, needs-auth, pending, disabled, or not_configuredTransport mechanism: stdio, http, sse (deprecated), or memory (in-process MCP server)For HTTP 400 failures only: whether the response carried a structured CAPI error envelope (structured_error, a deterministic validation failure) or no error body (bodyless, the transient gateway/proxy signature).Data payload forModelCallFailureEvent.Content-free structural summary of the failing request for diagnosing malformed 4xx callsWhere the failed model call originatedData payload forPendingMessagesModifiedEvent.Data payload forPermissionCompletedEvent.Data payload forPermissionRequestedEvent.The type of operation performed on the plan fileReasoning summary mode used for model calls, if applicable (e.g.Data payload forSamplingCompletedEvent.Data payload forSamplingRequestedEvent.Data payload forSessionAutopilotObjectiveChangedEvent.Data payload forSessionBackgroundTasksChangedEvent.Data payload forSessionBinaryAssetEvent.Data payload forSessionCanvasClosedEvent.Data payload forSessionCanvasOpenedEvent.Data payload forSessionCanvasRecordedEvent.Data payload forSessionCanvasRegistryChangedEvent.Data payload forSessionCanvasRemovedEvent.Data payload forSessionCanvasUnavailableEvent.Data payload forSessionCompactionCompleteEvent.Data payload forSessionCompactionStartEvent.Data payload forSessionContextChangedEvent.Data payload forSessionCustomAgentsUpdatedEvent.Data payload forSessionCustomNotificationEvent.Data payload forSessionErrorEvent.Base class for all generated session events.Data payload forSessionExtensionsAttachmentsPushedEvent.Data payload forSessionExtensionsLoadedEvent.Data payload forSessionHandoffEvent.Data payload forSessionIdleEvent.Data payload forSessionInfoEvent.Optional session limits.Data payload forSessionLimitsExhaustedCompletedEvent.Data payload forSessionLimitsExhaustedRequestedEvent.The user's selected action for an exhausted session limit.User action selected for an exhausted session limit.Data payload forSessionMcpServersLoadedEvent.Data payload forSessionMcpServerStatusChangedEvent.The session mode the agent is operating inData payload forSessionModeChangedEvent.Data payload forSessionModelChangeEvent.Data payload forSessionPermissionsChangedEvent.Data payload forSessionPlanChangedEvent.Data payload forSessionRemoteSteerableChangedEvent.Data payload forSessionResumeEvent.Data payload forSessionScheduleCancelledEvent.Data payload forSessionScheduleCreatedEvent.Data payload forSessionScheduleRearmedEvent.Data payload forSessionSessionLimitsChangedEvent.Data payload forSessionShutdownEvent.Data payload forSessionSkillsLoadedEvent.Data payload forSessionSnapshotRewindEvent.Data payload forSessionStartEvent.Data payload forSessionTaskCompleteEvent.Data payload forSessionTitleChangedEvent.Data payload forSessionTodosChangedEvent.Data payload forSessionToolsUpdatedEvent.Data payload forSessionTruncationEvent.Data payload forSessionUsageCheckpointEvent.Data payload forSessionUsageInfoEvent.Data payload forSessionWarningEvent.Data payload forSessionWorkspaceFileChangedEvent.Aggregate code change metrics for the sessionSchema for the `ShutdownModelMetric` type.Request count and cost metricsSchema for the `ShutdownModelMetricTokenDetail` type.Token usage breakdownSchema for the `ShutdownTokenDetail` type.Whether the session ended normally ("routine") or due to a crash/fatal error ("error")Data payload forSkillInvokedEvent.What triggered the skill invocation: `user-invoked` (explicit user action, such as via a slash command or UI affordance), `agent-invoked` (agent requested the skill), or `context-load` (loaded as part of another context, such as preloading skills configured on a custom agent or subagent)Schema for the `SkillsLoadedSkill` type.Source location type (e.g., project, personal-copilot, plugin, builtin)Data payload forSubagentCompletedEvent.Data payload forSubagentDeselectedEvent.Data payload forSubagentFailedEvent.Data payload forSubagentSelectedEvent.Data payload forSubagentStartedEvent.Data payload forSystemMessageEvent.Metadata about the prompt template and its constructionMessage role: "system" for system prompts, "developer" for developer-injected instructionsData payload forSystemNotificationEvent.Error details when the tool execution failedData payload forToolExecutionCompleteEvent.Tool execution result on successTool definition metadata, present for MCP tools with MCP Apps supportMCP Apps metadata for UI resource associationSchema for the `ToolExecutionCompleteToolDescriptionMetaUI` type.Allowed values for the `ToolExecutionCompleteToolDescriptionMetaUIVisibility` enumeration.MCP Apps UI resource content for rendering in a sandboxed iframeResource-level UI metadata (CSP, permissions, visual preferences)Schema for the `ToolExecutionCompleteUIResourceMetaUI` type.Schema for the `ToolExecutionCompleteUIResourceMetaUICsp` type.Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissions` type.Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsCamera` type.Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite` type.Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation` type.Schema for the `ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone` type.Data payload forToolExecutionPartialResultEvent.Data payload forToolExecutionProgressEvent.Data payload forToolExecutionStartEvent.Shell-aware path hints for a shell tool's command, captured at start time so consumers can snapshot a file's pre-image before the tool runs.Tool definition metadata, present for MCP tools with MCP Apps supportMCP Apps metadata for UI resource associationSchema for the `ToolExecutionStartToolDescriptionMetaUI` type.Allowed values for the `ToolExecutionStartToolDescriptionMetaUIVisibility` enumeration.Data payload forToolUserRequestedEvent.Data payload forUserInputCompletedEvent.Data payload forUserInputRequestedEvent.The agent mode that was active when this message was sentHow this user message was delivered to the agentic loop, relative to whether the loop was already running.Data payload forUserMessageEvent.Working directory and git context at session startHosting platform type of the repository (github or ado)Whether the file was newly created or updated -
Classes in com.github.copilot.generated used by com.github.copilot.rpcClassDescriptionReason the runtime is requesting host-provided MCP OAuth credentialsStatic OAuth client configuration, if the server specifies oneOAuth WWW-Authenticate parameters parsed from an MCP auth challengeBase class for all generated session events.