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.
Auto-generated RPC parameter and result 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 abortedWhat the agent was doing when the user interrupted it.Where the interruption landed relative to the first streamed token.Data payload forAgentInterruptedEvent.Whether configured models are advisory preferences or required constraintsWhether the accumulated numeric AI-credit subtotal covers the observed calls.Data payload forAssistantFusionPhaseActivityEvent.Data payload forAssistantFusionPhaseCompletedEvent.Data payload forAssistantFusionPhaseFailedEvent.Data payload forAssistantFusionPhaseStartedEvent.Data payload forAssistantIdleEvent.Data payload forAssistantIntentEvent.Data payload forAssistantMessageDeltaEvent.Data payload forAssistantMessageEvent.Neutral provider-tagged reasoning content blocks preserved verbatim for round-trippingNeutral provider-tagged server-side tool-use payload (tool search, advisor) for verbatim round-trippingData payload forAssistantMessageStartEvent.A tool invocation request from the assistantHosted program that requested this client tool callHosted program caller typeTool call type: "function" for standard tool calls, "custom" for grammar-based tool calls.Data payload forAssistantReasoningDeltaEvent.Data payload forAssistantReasoningEvent.Data payload forAssistantServerToolProgressEvent.Data payload forAssistantStreamingDeltaEvent.Data payload forAssistantToolCallDeltaEvent.Data payload forAssistantTurnEndEvent.Data payload forAssistantTurnRetryEvent.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.Internal per-quota snapshot for assistant usage, including entitlement, consumed requests, overage, reset date, and remaining quota.Transport used for a successful model callCoarse request-difficulty bucket for UX explainabilityData 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 existsExtensible routing preference for the virtual `auto` model.Terminal reason an Auto preference activation failed.Binary asset type discriminator.A single canvas declaration in `session.canvas.registry_changed`, including provider IDs, display metadata, input schema, and actions.A single action within a canvas declaration, with its name, optional description, and optional input schema.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.A single slash command available in the session, as listed by the `commands.changed` event.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 categoryWhat initiated a conversation compactionInclusive durable event range summarized by a completion receipt.Final structured tool completion in the covered event range.Runtime reason the completion decision was accepted.Structured terminal status from a tool completion event.Allowed values for the `ContextTier` enumeration.A single loaded custom agent in `session.custom_agents_updated`, with identity, source, tools, invocability, and authored model configuration.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.A single extension discovered by `session.extensions_loaded`, including qualified ID, source, and current status.Discovery sourceCurrent status: running, disabled, failed, or startingData payload forExternalToolCompletedEvent.Data payload forExternalToolRequestedEvent.Experimental attribution linking an ordinary event to the HydraFusion turn, phase, and concrete source that produced it.Conversation scope in which a HydraFusion phase executes.Data typeFusionCritic.Server-recommended routing behavior for a later HydraFusion turn.Durable server recommendation for subsequent HydraFusion turns.Validated HydraFusion execution pattern.Content-safe activity observed while a HydraFusion phase is running.HydraFusion phase kind.Presentation-neutral phase planned for a HydraFusion turn.Durable outcome status of a HydraFusion phase.Aggregate concrete-model usage for one HydraFusion phase.How a durable phase checkpoint contributes its exact message to canonical root history.Validated HydraFusion routing capability scores.Internal durable terminal request staged by a HydraFusion phase until an idempotent final commit selects it.Kind of turn for which HydraFusion routing is running.Per-session configuration for the built-in GitHub MCP serverRepository context for the handed-off sessionOrigin type of the session being handed offSingle HTTP header entry as a name/value pair.Error details when the hook failedData payload forHookEndEvent.Data payload forHookProgressEvent.Data payload forHookStartEvent.Controlled provenance for a typed runtime response.Data payload forHumanResponseRecordedEvent.Exact runtime-owned question or reviewed plan paired with the typed response that settled it.The category of runtime action that enterprise managed settings governed (blocked or capped)For a `bypass_permissions_blocked` action, which permission-mode or escalation primitive was refusedSummary of which managed-settings channels contributed to the effective session policy.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.MCP App tool `_meta.ui` resource URI and SEP-1865 visibility captured with an `mcp_app.tool_call_complete` result.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 completedRaw HTTP response details from the OAuth auth challenge, as observed by the runtime.Reason 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 challengeData payload forMcpPromptsListChangedEvent.Data payload forMcpResourcesListChangedEvent.Server-advertised metadata learned through modern discovery or legacy initialization.A single MCP server status summary in `session.mcp_servers_loaded`, including name, status, source, transport, and plugin metadata.Configuration source: user, workspace, plugin, builtin, managed, or accountConnection status: connected, failed, needs-auth, pending, disabled, stopped, or not_configuredTransport mechanism: stdio, http, sse (deprecated), or memory (in-process MCP server)Data payload forMcpToolsListChangedEvent.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.Boundary that produced a model call failureContent-free structural summary of the failing request for diagnosing malformed 4xx callsWhere the failed model call originatedTransport used for a failed model callFinal bounded result of one logical model operation after its internal retry loop settlesData payload forModelCallFinalResultEvent.Data payload forModelCallFinishedEvent.Final outcome of one logical model dispatch after response acceptance processingData payload forModelCallStartEvent.Why a WebSocket-capable model call was carried by the HTTP fallbackOrigin of an effective session model change.Why the session no longer has an explicitly selected model.The neutral kind of a model provider — the model analog of `AccountKind`.A neutral reference to the model provider that produced a model: an opaque id, a human-readable label, and the provider kind.Data payload forPendingMessagesModifiedEvent.Data payload forPermissionAssentDetectedEvent.Data payload forPermissionCarriedForwardEvent.Data payload forPermissionCompletedEvent.Data payload forPermissionContextualAuthorizationEvent.Controlled reason or actor responsible for a permission response.Data payload forPermissionMessageAuthorizationDegradedEvent.Data payload forPermissionMessageAuthorizationEvent.Direction stored in a historical extractor claim.Data payload forPermissionMessageAuthorizationReadEvent.Permission mode for the session.Runtime handling applied to a recovery attemptControlled reason for an individual attempt dispositionRelationship of an attempt to earlier permission requestsAuthoritative snapshot of an Autopilot permission-recovery episodeAction selected when autonomous recovery cannot continueControlled reason for a permission-recovery episode transitionLifecycle state of a permission-recovery episodeData payload forPermissionRequestedEvent.The type of operation performed on the plan fileData payload forPromptCacheBreakEvent.Access policy reported by the quota service.Acquisition state, independent of the service's business access/capacity verdict.Authoritative budget measurements and policy metadata, independent of provider.Capacity is independent of whether a numeric balance was supplied.Timing and purpose of a provider quota observation.Interpretation permitted for independently reported quantities.An account quota reading.Units explicitly reported by a quota provider.Reasoning summary mode used for model calls, if applicable (e.g.Enabled Auto preferences that Copilot API can recommend.What the user must do to recover from a failure, named as an action rather than as one client's affordance.Original request-level and effective conversation reasoning effort for a provider history boundary; the historical type name is retained for compatibilityData payload forSamplingCompletedEvent.Data payload forSamplingRequestedEvent.Raw union payload forSandboxDecisionEvent, preserving every variant's fields.Who created the schedule: `user` (an explicit user action such as `/every` or `/after`) or `model` (the agent via the `manage_schedule` tool).Data payload forSessionAutoModeResolvedEvent.Data payload forSessionAutopilotObjectiveChangedEvent.Data payload forSessionAutoTierRecommendationEvent.Data payload forSessionAutoTierSwitchFailedEvent.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 forSessionCompletionReceiptEvent.Data payload forSessionContextChangedEvent.Data payload forSessionContextClearedEvent.Data payload forSessionCustomAgentsUpdatedEvent.Data payload forSessionCustomNotificationEvent.Data payload forSessionErrorEvent.Base class for all generated session events.Data payload forSessionExtensionsAttachmentsPushedEvent.Data payload forSessionExtensionsLoadedEvent.Data payload forSessionFusionCompletedEvent.Data payload forSessionFusionResolvedEvent.Data payload forSessionFusionRouteFailedEvent.Data payload forSessionFusionRouteStartedEvent.Data payload forSessionHandoffEvent.Data payload forSessionIdleEvent.Raw union payload forSessionIndexedSearchEvent, preserving every variant's fields.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 forSessionManagedSettingsEnforcedEvent.Data payload forSessionManagedSettingsResolvedEvent.Data payload forSessionMcpServerNeedsReconnectEvent.Data payload forSessionMcpServerRemovedEvent.Data payload forSessionMcpServersLoadedEvent.Data payload forSessionMcpServerStatusChangedEvent.The session mode the agent is operating inData payload forSessionModeChangedEvent.Data payload forSessionModelChangeEvent.Data payload forSessionModelDeselectedEvent.Data payload forSessionModeNoticeDeliveredEvent.Data payload forSessionPermissionRecoveryEvent.Data payload forSessionPermissionsChangedEvent.Data payload forSessionPlanChangedEvent.Data payload forSessionQuotaObservationEvent.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.Usage attributed to one agent instance at session shutdown.Aggregate code change metrics for the sessionPer-model shutdown metrics with request counts, token usage, nano-AI units, and token details.Request count and cost metricsA token-type entry in a shutdown model metric, storing the accumulated token count.Token usage breakdownA session-wide shutdown token-type entry storing the accumulated token count.Whether the session ended normally ("routine") or due to a crash/fatal error ("error")Data payload forSkillContextDeliveredEvent.Data payload forSkillContextDeliveredRefEvent.Data payload forSkillInvokedEvent.Data payload forSkillInvokedRefEvent.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)A single resolved skill in `session.skills_loaded`, including source, invocability, enabled state, path, and argument hint.Source location type (e.g., project, personal-copilot, plugin, builtin, sdk)Data payload forSubagentCompletedEvent.Data payload forSubagentConfiguredEvent.Data payload forSubagentDeselectedEvent.Data payload forSubagentFailedEvent.Authority or runtime mechanism responsible for sub-agent model selection.Data payload forSubagentSelectedEvent.Data payload forSubagentStartedEvent.Where the model input for a task-tool sub-agent came from.One persisted structured system-message block and its cache intentData payload forSystemMessageEvent.Metadata about the prompt template and its constructionMessage role: "system" for system prompts, "developer" for developer-injected instructionsData payload forSystemNotificationEvent.Structured reason that the task cannot continue without interventionCategory of structured task blockerSemantic result of evaluating a task completion requestError details when the tool execution failedData payload forToolExecutionCompleteEvent.A file mutation that was actually committed by a built-in file editing tool.Kind of file mutation committed by a built-in editing tool.Tool execution result on successExperimental shell completion facts retained independently of the full tool result.Tool definition metadata, present for MCP tools with MCP Apps supportMCP Apps metadata for UI resource associationMCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_complete`.Allowed values for the `ToolExecutionCompleteToolDescriptionMetaUIVisibility` enumeration.MCP Apps UI resource content for rendering in a sandboxed iframeResource-level UI metadata (CSP, permissions, visual preferences)MCP Apps UI resource metadata for a completed tool result, including CSP, permissions, domain, and border preference.CSP domain allowlists for an MCP Apps UI resource, including connect, resource, frame, and base URI domains.Browser permission metadata for an MCP Apps UI resource, including camera, microphone, geolocation, and clipboard-write.Marker object for camera permission on an MCP Apps UI resource.Marker object for clipboard-write permission on an MCP Apps UI resource.Marker object for geolocation permission on an MCP Apps UI resource.Marker object for microphone permission on an MCP Apps UI resource.Deprecated.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 associationMCP Apps tool `_meta.ui` resource URI and visibility captured on `tool.execution_start`.Allowed values for the `ToolExecutionStartToolDescriptionMetaUIVisibility` enumeration.Data payload forToolSearchActivatedEvent.Data payload forToolShellOutputEvent.Shell output source.Data payload forToolUserRequestedEvent.Data payload forUiEphemeralQueryEvent.Lifecycle phase for a Rust-owned ephemeral query stream.Ordered accounting identity assigned under the source session's emission lock.Internal prompt-cache expiration state for one modelAccumulated session usage metrics, including premium request cost, token counts, model breakdown, and code-change totals.Usage attributed to one agent instance, including its identity, API duration, AI units, and per-model breakdown.Aggregated code change metricsPer-model usage metrics, including request counts/costs, token usage, nano-AI units, and per-token-type details.Request count and cost metrics for this modelPer-model token-detail entry containing the accumulated token count for one token type.Token usage metrics for this modelUsage for one recorded provider and model, without merging identical model IDs across providers.Session-wide token-detail entry containing the accumulated token count for one token type.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.Output verbosity level used for supported model calls (e.g.Data payload forWorkflowRunSettledEvent.Terminal status a workflow run committed.Data payload forWorkflowRunStartedEvent.Data payload forWorkflowRunUpdatedEvent.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.generated.rpcClassDescriptionRaw HTTP response details from the OAuth auth challenge, as observed by the runtime.OAuth WWW-Authenticate parameters parsed from an MCP auth challengeBase class for all generated session events.
-
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.