Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- abort() - Method in class com.github.copilot.sdk.CopilotSession
-
Aborts the currently processing message in this session.
- aborted() - Method in record class com.github.copilot.sdk.generated.SessionIdleEvent.SessionIdleEventData
-
Returns the value of the
abortedrecord component. - AbortEvent - Class in com.github.copilot.sdk.generated
-
The
abortsession event. - AbortEvent() - Constructor for class com.github.copilot.sdk.generated.AbortEvent
- AbortEvent.AbortEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
AbortEvent. - AbortEventData(String) - Constructor for record class com.github.copilot.sdk.generated.AbortEvent.AbortEventData
-
Creates an instance of a
AbortEventDatarecord class. - ACCEPT - Enum constant in enum class com.github.copilot.sdk.generated.ElicitationCompletedAction
-
The
acceptvariant. - ACCEPT - Enum constant in enum class com.github.copilot.sdk.generated.rpc.UIElicitationResponseAction
-
The
acceptvariant. - ACCEPT - Enum constant in enum class com.github.copilot.sdk.json.ElicitationResultAction
-
The user submitted the form (accepted).
- account - Variable in class com.github.copilot.sdk.generated.rpc.ServerRpc
-
API methods for the
accountnamespace. - AccountGetQuotaResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
account.getQuotaRPC method. - AccountGetQuotaResult(Map<String, AccountQuotaSnapshot>) - Constructor for record class com.github.copilot.sdk.generated.rpc.AccountGetQuotaResult
-
Creates an instance of a
AccountGetQuotaResultrecord class. - AccountQuotaSnapshot - Record Class in com.github.copilot.sdk.generated.rpc
- AccountQuotaSnapshot(Boolean, Long, Long, Boolean, Double, Double, Boolean, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.AccountQuotaSnapshot
-
Creates an instance of a
AccountQuotaSnapshotrecord class. - action() - Method in record class com.github.copilot.sdk.generated.ElicitationCompletedEvent.ElicitationCompletedEventData
-
Returns the value of the
actionrecord component. - action() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUiElicitationResult
-
Returns the value of the
actionrecord component. - action() - Method in record class com.github.copilot.sdk.generated.rpc.UIElicitationResponse
-
Returns the value of the
actionrecord component. - actions() - Method in record class com.github.copilot.sdk.generated.ExitPlanModeRequestedEvent.ExitPlanModeRequestedEventData
-
Returns the value of the
actionsrecord component. - add(McpConfigAddParams) - Method in class com.github.copilot.sdk.generated.rpc.ServerMcpConfigApi
-
Invokes
mcp.config.add. - additionalContext() - Method in record class com.github.copilot.sdk.json.PostToolUseHookOutput
-
Returns the value of the
additionalContextrecord component. - additionalContext() - Method in record class com.github.copilot.sdk.json.PreToolUseHookOutput
-
Returns the value of the
additionalContextrecord component. - additionalContext() - Method in record class com.github.copilot.sdk.json.SessionStartHookOutput
-
Returns the value of the
additionalContextrecord component. - additionalContext() - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookOutput
-
Returns the value of the
additionalContextrecord component. - ADO - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace.SessionWorkspacesGetWorkspaceResultWorkspaceHostType
-
The
adovariant. - ADO - Enum constant in enum class com.github.copilot.sdk.generated.WorkingDirectoryContextHostType
-
The
adovariant. - agent - Variable in class com.github.copilot.sdk.generated.rpc.SessionRpc
-
API methods for the
agentnamespace. - agent() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentGetCurrentResult
-
Returns the value of the
agentrecord component. - agent() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentSelectResult
-
Returns the value of the
agentrecord component. - agentDescription() - Method in record class com.github.copilot.sdk.generated.SubagentStartedEvent.SubagentStartedEventData
-
Returns the value of the
agentDescriptionrecord component. - agentDisplayName() - Method in record class com.github.copilot.sdk.generated.SubagentCompletedEvent.SubagentCompletedEventData
-
Returns the value of the
agentDisplayNamerecord component. - agentDisplayName() - Method in record class com.github.copilot.sdk.generated.SubagentFailedEvent.SubagentFailedEventData
-
Returns the value of the
agentDisplayNamerecord component. - agentDisplayName() - Method in record class com.github.copilot.sdk.generated.SubagentSelectedEvent.SubagentSelectedEventData
-
Returns the value of the
agentDisplayNamerecord component. - agentDisplayName() - Method in record class com.github.copilot.sdk.generated.SubagentStartedEvent.SubagentStartedEventData
-
Returns the value of the
agentDisplayNamerecord component. - AgentInfo - Class in com.github.copilot.sdk.json
-
Represents a custom agent available for selection in a session.
- AgentInfo - Record Class in com.github.copilot.sdk.generated.rpc
- AgentInfo() - Constructor for class com.github.copilot.sdk.json.AgentInfo
- AgentInfo(String, String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.AgentInfo
-
Creates an instance of a
AgentInforecord class. - agentMode() - Method in record class com.github.copilot.sdk.generated.UserMessageEvent.UserMessageEventData
-
Returns the value of the
agentModerecord component. - agentName() - Method in record class com.github.copilot.sdk.generated.SubagentCompletedEvent.SubagentCompletedEventData
-
Returns the value of the
agentNamerecord component. - agentName() - Method in record class com.github.copilot.sdk.generated.SubagentFailedEvent.SubagentFailedEventData
-
Returns the value of the
agentNamerecord component. - agentName() - Method in record class com.github.copilot.sdk.generated.SubagentSelectedEvent.SubagentSelectedEventData
-
Returns the value of the
agentNamerecord component. - agentName() - Method in record class com.github.copilot.sdk.generated.SubagentStartedEvent.SubagentStartedEventData
-
Returns the value of the
agentNamerecord component. - agents() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentListResult
-
Returns the value of the
agentsrecord component. - agents() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentReloadResult
-
Returns the value of the
agentsrecord component. - agents() - Method in record class com.github.copilot.sdk.generated.SessionCustomAgentsUpdatedEvent.SessionCustomAgentsUpdatedEventData
-
Returns the value of the
agentsrecord component. - allow() - Static method in record class com.github.copilot.sdk.json.PreToolUseHookOutput
-
Creates an output that allows the tool to execute.
- allowedTools() - Method in record class com.github.copilot.sdk.generated.SkillInvokedEvent.SkillInvokedEventData
-
Returns the value of the
allowedToolsrecord component. - allowFreeform() - Method in record class com.github.copilot.sdk.generated.UserInputRequestedEvent.UserInputRequestedEventData
-
Returns the value of the
allowFreeformrecord component. - alreadyInUse() - Method in record class com.github.copilot.sdk.generated.SessionResumeEvent.SessionResumeEventData
-
Returns the value of the
alreadyInUserecord component. - alreadyInUse() - Method in record class com.github.copilot.sdk.generated.SessionStartEvent.SessionStartEventData
-
Returns the value of the
alreadyInUserecord component. - answer() - Method in record class com.github.copilot.sdk.generated.UserInputCompletedEvent.UserInputCompletedEventData
-
Returns the value of the
answerrecord component. - API_KEY - Enum constant in enum class com.github.copilot.sdk.generated.rpc.AuthInfoType
-
The
api-keyvariant. - apiCallId() - Method in record class com.github.copilot.sdk.generated.AssistantUsageEvent.AssistantUsageEventData
-
Returns the value of the
apiCallIdrecord component. - APPEND - Enum constant in enum class com.github.copilot.sdk.json.SectionOverrideAction
-
Append content after the existing section.
- APPEND - Enum constant in enum class com.github.copilot.sdk.SystemMessageMode
-
Append the custom content to the default system message.
- applyTo() - Method in record class com.github.copilot.sdk.generated.rpc.InstructionsSources
-
Returns the value of the
applyTorecord component. - APPROVE_ALL - Static variable in interface com.github.copilot.sdk.json.PermissionHandler
-
A pre-built handler that approves all permission requests.
- approved() - Method in record class com.github.copilot.sdk.generated.ExitPlanModeCompletedEvent.ExitPlanModeCompletedEventData
-
Returns the value of the
approvedrecord component. - APPROVED - Enum constant in enum class com.github.copilot.sdk.generated.PermissionCompletedKind
-
The
approvedvariant. - APPROVED - Static variable in class com.github.copilot.sdk.json.PermissionRequestResultKind
-
The permission was approved for this one instance.
- APPROVED_FOR_LOCATION - Enum constant in enum class com.github.copilot.sdk.generated.PermissionCompletedKind
-
The
approved-for-locationvariant. - APPROVED_FOR_SESSION - Enum constant in enum class com.github.copilot.sdk.generated.PermissionCompletedKind
-
The
approved-for-sessionvariant. - args() - Method in record class com.github.copilot.sdk.generated.CommandExecuteEvent.CommandExecuteEventData
-
Returns the value of the
argsrecord component. - arguments() - Method in record class com.github.copilot.sdk.generated.AssistantMessageToolRequest
-
Returns the value of the
argumentsrecord component. - arguments() - Method in record class com.github.copilot.sdk.generated.ExternalToolRequestedEvent.ExternalToolRequestedEventData
-
Returns the value of the
argumentsrecord component. - arguments() - Method in record class com.github.copilot.sdk.generated.ToolExecutionStartEvent.ToolExecutionStartEventData
-
Returns the value of the
argumentsrecord component. - arguments() - Method in record class com.github.copilot.sdk.generated.ToolUserRequestedEvent.ToolUserRequestedEventData
-
Returns the value of the
argumentsrecord component. - ask() - Static method in record class com.github.copilot.sdk.json.PreToolUseHookOutput
-
Creates an output that asks for user confirmation before executing the tool.
- AssistantIntentEvent - Class in com.github.copilot.sdk.generated
-
The
assistant.intentsession event. - AssistantIntentEvent() - Constructor for class com.github.copilot.sdk.generated.AssistantIntentEvent
- AssistantIntentEvent.AssistantIntentEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
AssistantIntentEvent. - AssistantIntentEventData(String) - Constructor for record class com.github.copilot.sdk.generated.AssistantIntentEvent.AssistantIntentEventData
-
Creates an instance of a
AssistantIntentEventDatarecord class. - AssistantMessageDeltaEvent - Class in com.github.copilot.sdk.generated
-
The
assistant.message_deltasession event. - AssistantMessageDeltaEvent() - Constructor for class com.github.copilot.sdk.generated.AssistantMessageDeltaEvent
- AssistantMessageDeltaEvent.AssistantMessageDeltaEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
AssistantMessageDeltaEvent. - AssistantMessageDeltaEventData(String, String, String) - Constructor for record class com.github.copilot.sdk.generated.AssistantMessageDeltaEvent.AssistantMessageDeltaEventData
-
Creates an instance of a
AssistantMessageDeltaEventDatarecord class. - AssistantMessageEvent - Class in com.github.copilot.sdk.generated
-
The
assistant.messagesession event. - AssistantMessageEvent() - Constructor for class com.github.copilot.sdk.generated.AssistantMessageEvent
- AssistantMessageEvent.AssistantMessageEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
AssistantMessageEvent. - AssistantMessageEventData(String, String, List<AssistantMessageToolRequest>, String, String, String, String, Double, String, String, String) - Constructor for record class com.github.copilot.sdk.generated.AssistantMessageEvent.AssistantMessageEventData
-
Creates an instance of a
AssistantMessageEventDatarecord class. - AssistantMessageToolRequest - Record Class in com.github.copilot.sdk.generated
-
A tool invocation request from the assistant
- AssistantMessageToolRequest(String, String, Object, AssistantMessageToolRequestType, String, String, String) - Constructor for record class com.github.copilot.sdk.generated.AssistantMessageToolRequest
-
Creates an instance of a
AssistantMessageToolRequestrecord class. - AssistantMessageToolRequestType - Enum Class in com.github.copilot.sdk.generated
-
Tool call type: "function" for standard tool calls, "custom" for grammar-based tool calls.
- AssistantReasoningDeltaEvent - Class in com.github.copilot.sdk.generated
-
The
assistant.reasoning_deltasession event. - AssistantReasoningDeltaEvent() - Constructor for class com.github.copilot.sdk.generated.AssistantReasoningDeltaEvent
- AssistantReasoningDeltaEvent.AssistantReasoningDeltaEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
AssistantReasoningDeltaEvent. - AssistantReasoningDeltaEventData(String, String) - Constructor for record class com.github.copilot.sdk.generated.AssistantReasoningDeltaEvent.AssistantReasoningDeltaEventData
-
Creates an instance of a
AssistantReasoningDeltaEventDatarecord class. - AssistantReasoningEvent - Class in com.github.copilot.sdk.generated
-
The
assistant.reasoningsession event. - AssistantReasoningEvent() - Constructor for class com.github.copilot.sdk.generated.AssistantReasoningEvent
- AssistantReasoningEvent.AssistantReasoningEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
AssistantReasoningEvent. - AssistantReasoningEventData(String, String) - Constructor for record class com.github.copilot.sdk.generated.AssistantReasoningEvent.AssistantReasoningEventData
-
Creates an instance of a
AssistantReasoningEventDatarecord class. - AssistantStreamingDeltaEvent - Class in com.github.copilot.sdk.generated
-
The
assistant.streaming_deltasession event. - AssistantStreamingDeltaEvent() - Constructor for class com.github.copilot.sdk.generated.AssistantStreamingDeltaEvent
- AssistantStreamingDeltaEvent.AssistantStreamingDeltaEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
AssistantStreamingDeltaEvent. - AssistantStreamingDeltaEventData(Double) - Constructor for record class com.github.copilot.sdk.generated.AssistantStreamingDeltaEvent.AssistantStreamingDeltaEventData
-
Creates an instance of a
AssistantStreamingDeltaEventDatarecord class. - AssistantTurnEndEvent - Class in com.github.copilot.sdk.generated
-
The
assistant.turn_endsession event. - AssistantTurnEndEvent() - Constructor for class com.github.copilot.sdk.generated.AssistantTurnEndEvent
- AssistantTurnEndEvent.AssistantTurnEndEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
AssistantTurnEndEvent. - AssistantTurnEndEventData(String) - Constructor for record class com.github.copilot.sdk.generated.AssistantTurnEndEvent.AssistantTurnEndEventData
-
Creates an instance of a
AssistantTurnEndEventDatarecord class. - AssistantTurnStartEvent - Class in com.github.copilot.sdk.generated
-
The
assistant.turn_startsession event. - AssistantTurnStartEvent() - Constructor for class com.github.copilot.sdk.generated.AssistantTurnStartEvent
- AssistantTurnStartEvent.AssistantTurnStartEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
AssistantTurnStartEvent. - AssistantTurnStartEventData(String, String) - Constructor for record class com.github.copilot.sdk.generated.AssistantTurnStartEvent.AssistantTurnStartEventData
-
Creates an instance of a
AssistantTurnStartEventDatarecord class. - AssistantUsageCopilotUsage - Record Class in com.github.copilot.sdk.generated
-
Per-request cost and usage data from the CAPI copilot_usage response field
- AssistantUsageCopilotUsage(List<AssistantUsageCopilotUsageTokenDetail>, Double) - Constructor for record class com.github.copilot.sdk.generated.AssistantUsageCopilotUsage
-
Creates an instance of a
AssistantUsageCopilotUsagerecord class. - AssistantUsageCopilotUsageTokenDetail - Record Class in com.github.copilot.sdk.generated
-
Token usage detail for a single billing category
- AssistantUsageCopilotUsageTokenDetail(Double, Double, Double, String) - Constructor for record class com.github.copilot.sdk.generated.AssistantUsageCopilotUsageTokenDetail
-
Creates an instance of a
AssistantUsageCopilotUsageTokenDetailrecord class. - AssistantUsageEvent - Class in com.github.copilot.sdk.generated
-
The
assistant.usagesession event. - AssistantUsageEvent() - Constructor for class com.github.copilot.sdk.generated.AssistantUsageEvent
- AssistantUsageEvent.AssistantUsageEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
AssistantUsageEvent. - AssistantUsageEventData(String, Double, Double, Double, Double, Double, Double, Double, Double, Double, String, String, String, String, Map<String, AssistantUsageQuotaSnapshot>, AssistantUsageCopilotUsage, String) - Constructor for record class com.github.copilot.sdk.generated.AssistantUsageEvent.AssistantUsageEventData
-
Creates an instance of a
AssistantUsageEventDatarecord class. - AssistantUsageQuotaSnapshot - Record Class in com.github.copilot.sdk.generated
- AssistantUsageQuotaSnapshot(Boolean, Double, Double, Boolean, Double, Boolean, Double, OffsetDateTime) - Constructor for record class com.github.copilot.sdk.generated.AssistantUsageQuotaSnapshot
-
Creates an instance of a
AssistantUsageQuotaSnapshotrecord class. - Attachment - Record Class in com.github.copilot.sdk.json
-
Represents a file attachment to include with a message.
- Attachment(String, String, String) - Constructor for record class com.github.copilot.sdk.json.Attachment
-
Creates an instance of a
Attachmentrecord class. - attachments() - Method in record class com.github.copilot.sdk.generated.UserMessageEvent.UserMessageEventData
-
Returns the value of the
attachmentsrecord component. - auth - Variable in class com.github.copilot.sdk.generated.rpc.SessionRpc
-
API methods for the
authnamespace. - AuthInfoType - Enum Class in com.github.copilot.sdk.generated.rpc
-
Authentication type
- authorizationUrl() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpOauthLoginResult
-
Returns the value of the
authorizationUrlrecord component. - authType() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAuthGetStatusResult
-
Returns the value of the
authTyperecord component. - autoApproveEdits() - Method in record class com.github.copilot.sdk.generated.ExitPlanModeCompletedEvent.ExitPlanModeCompletedEventData
-
Returns the value of the
autoApproveEditsrecord component. - AUTOCLOSEABLE_TIMEOUT_SECONDS - Static variable in class com.github.copilot.sdk.CopilotClient
-
Timeout, in seconds, used by
CopilotClient.close()when waiting for graceful shutdown viaCopilotClient.stop(). - AutoModeSwitchCompletedEvent - Class in com.github.copilot.sdk.generated
-
The
auto_mode_switch.completedsession event. - AutoModeSwitchCompletedEvent() - Constructor for class com.github.copilot.sdk.generated.AutoModeSwitchCompletedEvent
- AutoModeSwitchCompletedEvent.AutoModeSwitchCompletedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
AutoModeSwitchCompletedEvent. - AutoModeSwitchCompletedEventData(String, String) - Constructor for record class com.github.copilot.sdk.generated.AutoModeSwitchCompletedEvent.AutoModeSwitchCompletedEventData
-
Creates an instance of a
AutoModeSwitchCompletedEventDatarecord class. - AutoModeSwitchRequestedEvent - Class in com.github.copilot.sdk.generated
-
The
auto_mode_switch.requestedsession event. - AutoModeSwitchRequestedEvent() - Constructor for class com.github.copilot.sdk.generated.AutoModeSwitchRequestedEvent
- AutoModeSwitchRequestedEvent.AutoModeSwitchRequestedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
AutoModeSwitchRequestedEvent. - AutoModeSwitchRequestedEventData(String, String) - Constructor for record class com.github.copilot.sdk.generated.AutoModeSwitchRequestedEvent.AutoModeSwitchRequestedEventData
-
Creates an instance of a
AutoModeSwitchRequestedEventDatarecord class. - AUTOPILOT - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionMode
-
The
autopilotvariant. - AUTOPILOT - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionModeGetResult.SessionModeGetResultMode
-
The
autopilotvariant. - AUTOPILOT - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionModeSetResult.SessionModeSetResultMode
-
The
autopilotvariant. - AUTOPILOT - Enum constant in enum class com.github.copilot.sdk.generated.UserMessageAgentMode
-
The
autopilotvariant. - AzureOptions - Class in com.github.copilot.sdk.json
-
Azure OpenAI-specific configuration options.
- AzureOptions() - Constructor for class com.github.copilot.sdk.json.AzureOptions
B
- BACKGROUND - Static variable in class com.github.copilot.sdk.json.SessionLifecycleEventTypes
-
Event fired when a session moves to background (TUI+server mode).
- baseCommit() - Method in record class com.github.copilot.sdk.generated.SessionContextChangedEvent.SessionContextChangedEventData
-
Returns the value of the
baseCommitrecord component. - baseCommit() - Method in record class com.github.copilot.sdk.generated.WorkingDirectoryContext
-
Returns the value of the
baseCommitrecord component. - batchSize() - Method in record class com.github.copilot.sdk.generated.AssistantUsageCopilotUsageTokenDetail
-
Returns the value of the
batchSizerecord component. - batchSize() - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail
-
Returns the value of the
batchSizerecord component. - billing() - Method in record class com.github.copilot.sdk.generated.rpc.Model
-
Returns the value of the
billingrecord component. - binaryResultsForLlm() - Method in record class com.github.copilot.sdk.json.ToolResultObject
-
Returns the value of the
binaryResultsForLlmrecord component. - birthtime() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsStatResult
-
Returns the value of the
birthtimerecord component. - BlobAttachment - Class in com.github.copilot.sdk.json
-
Represents an inline base64-encoded binary attachment (blob) for messages.
- BlobAttachment() - Constructor for class com.github.copilot.sdk.json.BlobAttachment
- branch() - Method in record class com.github.copilot.sdk.generated.HandoffRepository
-
Returns the value of the
branchrecord component. - branch() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
-
Returns the value of the
branchrecord component. - branch() - Method in record class com.github.copilot.sdk.generated.SessionContextChangedEvent.SessionContextChangedEventData
-
Returns the value of the
branchrecord component. - branch() - Method in record class com.github.copilot.sdk.generated.WorkingDirectoryContext
-
Returns the value of the
branchrecord component. - BUILTIN - Enum constant in enum class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServerSource
-
The
builtinvariant. - BUILTIN - Enum constant in enum class com.github.copilot.sdk.generated.rpc.McpServerSource
-
The
builtinvariant.
C
- cacheReadTokens() - Method in record class com.github.copilot.sdk.generated.AssistantUsageEvent.AssistantUsageEventData
-
Returns the value of the
cacheReadTokensrecord component. - cacheReadTokens() - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsed
-
Returns the value of the
cacheReadTokensrecord component. - cacheReadTokens() - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsModelMetricUsage
-
Returns the value of the
cacheReadTokensrecord component. - cacheReadTokens() - Method in record class com.github.copilot.sdk.generated.ShutdownModelMetricUsage
-
Returns the value of the
cacheReadTokensrecord component. - cacheWriteTokens() - Method in record class com.github.copilot.sdk.generated.AssistantUsageEvent.AssistantUsageEventData
-
Returns the value of the
cacheWriteTokensrecord component. - cacheWriteTokens() - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsed
-
Returns the value of the
cacheWriteTokensrecord component. - cacheWriteTokens() - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsModelMetricUsage
-
Returns the value of the
cacheWriteTokensrecord component. - cacheWriteTokens() - Method in record class com.github.copilot.sdk.generated.ShutdownModelMetricUsage
-
Returns the value of the
cacheWriteTokensrecord component. - callbackSuccessMessage() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpOauthLoginParams
-
Returns the value of the
callbackSuccessMessagerecord component. - CANCEL - Enum constant in enum class com.github.copilot.sdk.generated.ElicitationCompletedAction
-
The
cancelvariant. - CANCEL - Enum constant in enum class com.github.copilot.sdk.generated.rpc.UIElicitationResponseAction
-
The
cancelvariant. - CANCEL - Enum constant in enum class com.github.copilot.sdk.json.ElicitationResultAction
-
The user dismissed the dialog without responding.
- capabilities() - Method in record class com.github.copilot.sdk.generated.rpc.Model
-
Returns the value of the
capabilitiesrecord component. - capabilities() - Method in record class com.github.copilot.sdk.json.CreateSessionResponse
-
Returns the value of the
capabilitiesrecord component. - capabilities() - Method in record class com.github.copilot.sdk.json.ResumeSessionResponse
-
Returns the value of the
capabilitiesrecord component. - CapabilitiesChangedEvent - Class in com.github.copilot.sdk.generated
-
The
capabilities.changedsession event. - CapabilitiesChangedEvent() - Constructor for class com.github.copilot.sdk.generated.CapabilitiesChangedEvent
- CapabilitiesChangedEvent.CapabilitiesChangedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
CapabilitiesChangedEvent. - CapabilitiesChangedEventData(CapabilitiesChangedUI) - Constructor for record class com.github.copilot.sdk.generated.CapabilitiesChangedEvent.CapabilitiesChangedEventData
-
Creates an instance of a
CapabilitiesChangedEventDatarecord class. - CapabilitiesChangedUI - Record Class in com.github.copilot.sdk.generated
-
UI capability changes
- CapabilitiesChangedUI(Boolean) - Constructor for record class com.github.copilot.sdk.generated.CapabilitiesChangedUI
-
Creates an instance of a
CapabilitiesChangedUIrecord class. - checkpointNumber() - Method in record class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent.SessionCompactionCompleteEventData
-
Returns the value of the
checkpointNumberrecord component. - checkpointPath() - Method in record class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent.SessionCompactionCompleteEventData
-
Returns the value of the
checkpointPathrecord component. - CHILD_INSTRUCTIONS - Enum constant in enum class com.github.copilot.sdk.generated.rpc.InstructionsSourcesType
-
The
child-instructionsvariant. - choices() - Method in record class com.github.copilot.sdk.generated.UserInputRequestedEvent.UserInputRequestedEventData
-
Returns the value of the
choicesrecord component. - chronicleSyncDismissed() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
-
Returns the value of the
chronicleSyncDismissedrecord component. - cleanupActions() - Method in record class com.github.copilot.sdk.json.SessionEndHookOutput
-
Returns the value of the
cleanupActionsrecord component. - clientId() - Method in record class com.github.copilot.sdk.generated.McpOauthRequiredStaticClientConfig
-
Returns the value of the
clientIdrecord component. - clientName() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpOauthLoginParams
-
Returns the value of the
clientNamerecord component. - clone() - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Creates a shallow clone of this
CopilotClientOptionsinstance. - clone() - Method in class com.github.copilot.sdk.json.MessageOptions
-
Creates a shallow clone of this
MessageOptionsinstance. - clone() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Creates a shallow clone of this
ResumeSessionConfiginstance. - clone() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Creates a shallow clone of this
SessionConfiginstance. - close() - Method in class com.github.copilot.sdk.CopilotClient
-
Closes this client using graceful shutdown semantics.
- close() - Method in class com.github.copilot.sdk.CopilotSession
-
Disposes the session and releases all associated resources.
- code() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsError
-
Returns the value of the
coderecord component. - code() - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteError
-
Returns the value of the
coderecord component. - CODE_CHANGE_RULES - Static variable in class com.github.copilot.sdk.json.SystemPromptSections
-
Coding rules, linting/testing, ecosystem tools, style.
- codeChanges() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUsageGetMetricsResult
-
Returns the value of the
codeChangesrecord component. - codeChanges() - Method in record class com.github.copilot.sdk.generated.SessionShutdownEvent.SessionShutdownEventData
-
Returns the value of the
codeChangesrecord component. - com.github.copilot.sdk - package com.github.copilot.sdk
-
Core classes for the GitHub Copilot SDK for Java.
- com.github.copilot.sdk.generated - package com.github.copilot.sdk.generated
- com.github.copilot.sdk.generated.rpc - package com.github.copilot.sdk.generated.rpc
- com.github.copilot.sdk.json - package com.github.copilot.sdk.json
-
Configuration classes and data transfer objects for the Copilot SDK.
- command() - Method in record class com.github.copilot.sdk.generated.CommandExecuteEvent.CommandExecuteEventData
-
Returns the value of the
commandrecord component. - command() - Method in record class com.github.copilot.sdk.generated.CommandQueuedEvent.CommandQueuedEventData
-
Returns the value of the
commandrecord component. - command() - Method in record class com.github.copilot.sdk.generated.rpc.SessionShellExecParams
-
Returns the value of the
commandrecord component. - CommandCompletedEvent - Class in com.github.copilot.sdk.generated
-
The
command.completedsession event. - CommandCompletedEvent() - Constructor for class com.github.copilot.sdk.generated.CommandCompletedEvent
- CommandCompletedEvent.CommandCompletedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
CommandCompletedEvent. - CommandCompletedEventData(String) - Constructor for record class com.github.copilot.sdk.generated.CommandCompletedEvent.CommandCompletedEventData
-
Creates an instance of a
CommandCompletedEventDatarecord class. - CommandContext - Class in com.github.copilot.sdk.json
-
Context passed to a
CommandHandlerwhen a slash command is executed. - CommandContext() - Constructor for class com.github.copilot.sdk.json.CommandContext
- CommandDefinition - Class in com.github.copilot.sdk.json
-
Defines a slash command that users can invoke from the CLI TUI.
- CommandDefinition() - Constructor for class com.github.copilot.sdk.json.CommandDefinition
- CommandExecuteEvent - Class in com.github.copilot.sdk.generated
-
The
command.executesession event. - CommandExecuteEvent() - Constructor for class com.github.copilot.sdk.generated.CommandExecuteEvent
- CommandExecuteEvent.CommandExecuteEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
CommandExecuteEvent. - CommandExecuteEventData(String, String, String, String) - Constructor for record class com.github.copilot.sdk.generated.CommandExecuteEvent.CommandExecuteEventData
-
Creates an instance of a
CommandExecuteEventDatarecord class. - CommandHandler - Interface in com.github.copilot.sdk.json
-
Functional interface for handling slash-command executions.
- commandName() - Method in record class com.github.copilot.sdk.generated.CommandExecuteEvent.CommandExecuteEventData
-
Returns the value of the
commandNamerecord component. - CommandQueuedEvent - Class in com.github.copilot.sdk.generated
-
The
command.queuedsession event. - CommandQueuedEvent() - Constructor for class com.github.copilot.sdk.generated.CommandQueuedEvent
- CommandQueuedEvent.CommandQueuedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
CommandQueuedEvent. - CommandQueuedEventData(String, String) - Constructor for record class com.github.copilot.sdk.generated.CommandQueuedEvent.CommandQueuedEventData
-
Creates an instance of a
CommandQueuedEventDatarecord class. - commands - Variable in class com.github.copilot.sdk.generated.rpc.SessionRpc
-
API methods for the
commandsnamespace. - commands() - Method in record class com.github.copilot.sdk.generated.CommandsChangedEvent.CommandsChangedEventData
-
Returns the value of the
commandsrecord component. - CommandsChangedCommand - Record Class in com.github.copilot.sdk.generated
- CommandsChangedCommand(String, String) - Constructor for record class com.github.copilot.sdk.generated.CommandsChangedCommand
-
Creates an instance of a
CommandsChangedCommandrecord class. - CommandsChangedEvent - Class in com.github.copilot.sdk.generated
-
The
commands.changedsession event. - CommandsChangedEvent() - Constructor for class com.github.copilot.sdk.generated.CommandsChangedEvent
- CommandsChangedEvent.CommandsChangedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
CommandsChangedEvent. - CommandsChangedEventData(List<CommandsChangedCommand>) - Constructor for record class com.github.copilot.sdk.generated.CommandsChangedEvent.CommandsChangedEventData
-
Creates an instance of a
CommandsChangedEventDatarecord class. - CommandWireDefinition - Class in com.github.copilot.sdk.json
-
Wire-format representation of a command definition for RPC serialization.
- CommandWireDefinition() - Constructor for class com.github.copilot.sdk.json.CommandWireDefinition
-
Creates an empty definition.
- CommandWireDefinition(String, String) - Constructor for class com.github.copilot.sdk.json.CommandWireDefinition
-
Creates a definition with name and description.
- compact() - Method in class com.github.copilot.sdk.CopilotSession
-
Compacts the session context to reduce token usage.
- compact() - Method in class com.github.copilot.sdk.generated.rpc.SessionHistoryApi
-
Invokes
session.history.compact. - CompactionCompleteCompactionTokensUsed - Record Class in com.github.copilot.sdk.generated
-
Token usage breakdown for the compaction LLM call (aligned with assistant.usage format)
- CompactionCompleteCompactionTokensUsed(Double, Double, Double, Double, CompactionCompleteCompactionTokensUsedCopilotUsage, Double, String) - Constructor for record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsed
-
Creates an instance of a
CompactionCompleteCompactionTokensUsedrecord class. - CompactionCompleteCompactionTokensUsedCopilotUsage - Record Class in com.github.copilot.sdk.generated
-
Per-request cost and usage data from the CAPI copilot_usage response field
- CompactionCompleteCompactionTokensUsedCopilotUsage(List<CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail>, Double) - Constructor for record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsedCopilotUsage
-
Creates an instance of a
CompactionCompleteCompactionTokensUsedCopilotUsagerecord class. - CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail - Record Class in com.github.copilot.sdk.generated
-
Token usage detail for a single billing category
- CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail(Double, Double, Double, String) - Constructor for record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail
-
Creates an instance of a
CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetailrecord class. - compactionTokensUsed() - Method in record class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent.SessionCompactionCompleteEventData
-
Returns the value of the
compactionTokensUsedrecord component. - config - Variable in class com.github.copilot.sdk.generated.rpc.ServerMcpApi
-
API methods for the
mcp.configsub-namespace. - config - Variable in class com.github.copilot.sdk.generated.rpc.ServerSkillsApi
-
API methods for the
skills.configsub-namespace. - config() - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigAddParams
-
Returns the value of the
configrecord component. - config() - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigUpdateParams
-
Returns the value of the
configrecord component. - confirm(String) - Method in interface com.github.copilot.sdk.json.SessionUiApi
-
Shows a confirmation dialog and returns the user's boolean answer.
- CONNECTED - Enum constant in enum class com.github.copilot.sdk.ConnectionState
-
The client is connected and ready to accept requests.
- CONNECTED - Enum constant in enum class com.github.copilot.sdk.generated.McpServersLoadedServerStatus
-
The
connectedvariant. - CONNECTED - Enum constant in enum class com.github.copilot.sdk.generated.McpServerStatusChangedStatus
-
The
connectedvariant. - CONNECTED - Enum constant in enum class com.github.copilot.sdk.generated.rpc.McpServerStatus
-
The
connectedvariant. - CONNECTING - Enum constant in enum class com.github.copilot.sdk.ConnectionState
-
The client is in the process of connecting to the server.
- ConnectionState - Enum Class in com.github.copilot.sdk
-
Represents the connection state of a
CopilotClient. - content() - Method in record class com.github.copilot.sdk.generated.AssistantMessageEvent.AssistantMessageEventData
-
Returns the value of the
contentrecord component. - content() - Method in record class com.github.copilot.sdk.generated.AssistantReasoningEvent.AssistantReasoningEventData
-
Returns the value of the
contentrecord component. - content() - Method in record class com.github.copilot.sdk.generated.ElicitationCompletedEvent.ElicitationCompletedEventData
-
Returns the value of the
contentrecord component. - content() - Method in record class com.github.copilot.sdk.generated.rpc.InstructionsSources
-
Returns the value of the
contentrecord component. - content() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsAppendFileParams
-
Returns the value of the
contentrecord component. - content() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReadFileResult
-
Returns the value of the
contentrecord component. - content() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsWriteFileParams
-
Returns the value of the
contentrecord component. - content() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanReadResult
-
Returns the value of the
contentrecord component. - content() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanUpdateParams
-
Returns the value of the
contentrecord component. - content() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUiElicitationResult
-
Returns the value of the
contentrecord component. - content() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceCreateFileParams
-
Returns the value of the
contentrecord component. - content() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceReadFileResult
-
Returns the value of the
contentrecord component. - content() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesCreateFileParams
-
Returns the value of the
contentrecord component. - content() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesReadFileResult
-
Returns the value of the
contentrecord component. - content() - Method in record class com.github.copilot.sdk.generated.rpc.UIElicitationResponse
-
Returns the value of the
contentrecord component. - content() - Method in record class com.github.copilot.sdk.generated.SkillInvokedEvent.SkillInvokedEventData
-
Returns the value of the
contentrecord component. - content() - Method in record class com.github.copilot.sdk.generated.SystemMessageEvent.SystemMessageEventData
-
Returns the value of the
contentrecord component. - content() - Method in record class com.github.copilot.sdk.generated.SystemNotificationEvent.SystemNotificationEventData
-
Returns the value of the
contentrecord component. - content() - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteResult
-
Returns the value of the
contentrecord component. - content() - Method in record class com.github.copilot.sdk.generated.UserMessageEvent.UserMessageEventData
-
Returns the value of the
contentrecord component. - contents() - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteResult
-
Returns the value of the
contentsrecord component. - context() - Method in record class com.github.copilot.sdk.generated.SessionHandoffEvent.SessionHandoffEventData
-
Returns the value of the
contextrecord component. - context() - Method in record class com.github.copilot.sdk.generated.SessionResumeEvent.SessionResumeEventData
-
Returns the value of the
contextrecord component. - context() - Method in record class com.github.copilot.sdk.generated.SessionStartEvent.SessionStartEventData
-
Returns the value of the
contextrecord component. - contextWindow() - Method in record class com.github.copilot.sdk.generated.rpc.SessionHistoryCompactResult
-
Returns the value of the
contextWindowrecord component. - conventions() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsSetProviderParams
-
Returns the value of the
conventionsrecord component. - conversationTokens() - Method in record class com.github.copilot.sdk.generated.rpc.HistoryCompactContextWindow
-
Returns the value of the
conversationTokensrecord component. - conversationTokens() - Method in record class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent.SessionCompactionCompleteEventData
-
Returns the value of the
conversationTokensrecord component. - conversationTokens() - Method in record class com.github.copilot.sdk.generated.SessionCompactionStartEvent.SessionCompactionStartEventData
-
Returns the value of the
conversationTokensrecord component. - conversationTokens() - Method in record class com.github.copilot.sdk.generated.SessionShutdownEvent.SessionShutdownEventData
-
Returns the value of the
conversationTokensrecord component. - conversationTokens() - Method in record class com.github.copilot.sdk.generated.SessionUsageInfoEvent.SessionUsageInfoEventData
-
Returns the value of the
conversationTokensrecord component. - COPILOT_API_TOKEN - Enum constant in enum class com.github.copilot.sdk.generated.rpc.AuthInfoType
-
The
copilot-api-tokenvariant. - CopilotClient - Class in com.github.copilot.sdk
-
Provides a client for interacting with the Copilot CLI server.
- CopilotClient() - Constructor for class com.github.copilot.sdk.CopilotClient
-
Creates a new CopilotClient with default options.
- CopilotClient(CopilotClientOptions) - Constructor for class com.github.copilot.sdk.CopilotClient
-
Creates a new CopilotClient with the specified options.
- CopilotClientOptions - Class in com.github.copilot.sdk.json
-
Configuration options for creating a
CopilotClient. - CopilotClientOptions() - Constructor for class com.github.copilot.sdk.json.CopilotClientOptions
- copilotPlan() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAuthGetStatusResult
-
Returns the value of the
copilotPlanrecord component. - CopilotSession - Class in com.github.copilot.sdk
-
Represents a single conversation session with the Copilot CLI.
- copilotUsage() - Method in record class com.github.copilot.sdk.generated.AssistantUsageEvent.AssistantUsageEventData
-
Returns the value of the
copilotUsagerecord component. - copilotUsage() - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsed
-
Returns the value of the
copilotUsagerecord component. - copilotVersion() - Method in record class com.github.copilot.sdk.generated.SessionStartEvent.SessionStartEventData
-
Returns the value of the
copilotVersionrecord component. - cost() - Method in record class com.github.copilot.sdk.generated.AssistantUsageEvent.AssistantUsageEventData
-
Returns the value of the
costrecord component. - cost() - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsModelMetricRequests
-
Returns the value of the
costrecord component. - cost() - Method in record class com.github.copilot.sdk.generated.ShutdownModelMetricRequests
-
Returns the value of the
costrecord component. - costPerBatch() - Method in record class com.github.copilot.sdk.generated.AssistantUsageCopilotUsageTokenDetail
-
Returns the value of the
costPerBatchrecord component. - costPerBatch() - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail
-
Returns the value of the
costPerBatchrecord component. - count() - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsModelMetricRequests
-
Returns the value of the
countrecord component. - count() - Method in record class com.github.copilot.sdk.generated.ShutdownModelMetricRequests
-
Returns the value of the
countrecord component. - create(String, String, Map<String, Object>, ToolHandler) - Static method in record class com.github.copilot.sdk.json.ToolDefinition
-
Creates a tool definition with a JSON schema for parameters.
- CREATE - Enum constant in enum class com.github.copilot.sdk.generated.PlanChangedOperation
-
The
createvariant. - CREATE - Enum constant in enum class com.github.copilot.sdk.generated.WorkspaceFileChangedOperation
-
The
createvariant. - CREATED - Static variable in class com.github.copilot.sdk.json.SessionLifecycleEventTypes
-
Event fired when a session is created.
- createdAt() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
-
Returns the value of the
createdAtrecord component. - createFile(SessionWorkspaceCreateFileParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionWorkspaceApi
-
Invokes
session.workspace.createFile. - createFile(SessionWorkspacesCreateFileParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionWorkspacesApi
-
Invokes
session.workspaces.createFile. - createOverride(String, String, Map<String, Object>, ToolHandler) - Static method in record class com.github.copilot.sdk.json.ToolDefinition
-
Creates a tool definition that overrides a built-in CLI tool.
- createSession(SessionConfig) - Method in class com.github.copilot.sdk.CopilotClient
-
Creates a new Copilot session with the specified configuration.
- CreateSessionRequest - Class in com.github.copilot.sdk.json
-
Internal request object for creating a new session.
- CreateSessionRequest() - Constructor for class com.github.copilot.sdk.json.CreateSessionRequest
- CreateSessionResponse - Record Class in com.github.copilot.sdk.json
-
Internal response object from creating a session.
- CreateSessionResponse(String, String, SessionCapabilities) - Constructor for record class com.github.copilot.sdk.json.CreateSessionResponse
-
Creates an instance of a
CreateSessionResponserecord class. - createSkipPermission(String, String, Map<String, Object>, ToolHandler) - Static method in record class com.github.copilot.sdk.json.ToolDefinition
-
Creates a tool definition that skips the permission request.
- currentModel() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUsageGetMetricsResult
-
Returns the value of the
currentModelrecord component. - currentModel() - Method in record class com.github.copilot.sdk.generated.SessionShutdownEvent.SessionShutdownEventData
-
Returns the value of the
currentModelrecord component. - currentTokens() - Method in record class com.github.copilot.sdk.generated.rpc.HistoryCompactContextWindow
-
Returns the value of the
currentTokensrecord component. - currentTokens() - Method in record class com.github.copilot.sdk.generated.SessionShutdownEvent.SessionShutdownEventData
-
Returns the value of the
currentTokensrecord component. - currentTokens() - Method in record class com.github.copilot.sdk.generated.SessionUsageInfoEvent.SessionUsageInfoEventData
-
Returns the value of the
currentTokensrecord component. - CUSTOM - Enum constant in enum class com.github.copilot.sdk.generated.AssistantMessageToolRequestType
-
The
customvariant. - CUSTOM_INSTRUCTIONS - Static variable in class com.github.copilot.sdk.json.SystemPromptSections
-
Repository and organization custom instructions.
- CustomAgentConfig - Class in com.github.copilot.sdk.json
-
Configuration for a custom agent in a Copilot session.
- CustomAgentConfig() - Constructor for class com.github.copilot.sdk.json.CustomAgentConfig
- CustomAgentsUpdatedAgent - Record Class in com.github.copilot.sdk.generated
- CustomAgentsUpdatedAgent(String, String, String, String, String, List<String>, Boolean, String) - Constructor for record class com.github.copilot.sdk.generated.CustomAgentsUpdatedAgent
-
Creates an instance of a
CustomAgentsUpdatedAgentrecord class. - CUSTOMIZE - Enum constant in enum class com.github.copilot.sdk.SystemMessageMode
-
Override individual sections of the system prompt.
- cwd() - Method in record class com.github.copilot.sdk.generated.rpc.SessionShellExecParams
-
Returns the value of the
cwdrecord component. - cwd() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
-
Returns the value of the
cwdrecord component. - cwd() - Method in record class com.github.copilot.sdk.generated.SessionContextChangedEvent.SessionContextChangedEventData
-
Returns the value of the
cwdrecord component. - cwd() - Method in record class com.github.copilot.sdk.generated.WorkingDirectoryContext
-
Returns the value of the
cwdrecord component. - cwd() - Method in record class com.github.copilot.sdk.json.SessionEndHookInput
-
Returns the value of the
cwdrecord component. - cwd() - Method in record class com.github.copilot.sdk.json.SessionStartHookInput
-
Returns the value of the
cwdrecord component. - cwd() - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookInput
-
Returns the value of the
cwdrecord component.
D
- data() - Method in record class com.github.copilot.sdk.json.ToolBinaryResult
-
Returns the value of the
datarecord component. - DECLINE - Enum constant in enum class com.github.copilot.sdk.generated.ElicitationCompletedAction
-
The
declinevariant. - DECLINE - Enum constant in enum class com.github.copilot.sdk.generated.rpc.UIElicitationResponseAction
-
The
declinevariant. - DECLINE - Enum constant in enum class com.github.copilot.sdk.json.ElicitationResultAction
-
The user explicitly rejected the request.
- DefaultAgentConfig - Class in com.github.copilot.sdk.json
-
Configuration for the default agent (the built-in agent that handles turns when no custom agent is selected).
- DefaultAgentConfig() - Constructor for class com.github.copilot.sdk.json.DefaultAgentConfig
- defaultReasoningEffort() - Method in record class com.github.copilot.sdk.generated.rpc.Model
-
Returns the value of the
defaultReasoningEffortrecord component. - delete() - Method in class com.github.copilot.sdk.generated.rpc.SessionPlanApi
-
Invokes
session.plan.delete. - DELETE - Enum constant in enum class com.github.copilot.sdk.generated.PlanChangedOperation
-
The
deletevariant. - DELETED - Static variable in class com.github.copilot.sdk.json.SessionLifecycleEventTypes
-
Event fired when a session is deleted.
- deleteSession(String) - Method in class com.github.copilot.sdk.CopilotClient
-
Permanently deletes a session and all its data from disk, including conversation history, planning state, and artifacts.
- DeleteSessionResponse - Record Class in com.github.copilot.sdk.json
-
Internal response object from deleting a session.
- DeleteSessionResponse(boolean, String) - Constructor for record class com.github.copilot.sdk.json.DeleteSessionResponse
-
Creates an instance of a
DeleteSessionResponserecord class. - deltaContent() - Method in record class com.github.copilot.sdk.generated.AssistantMessageDeltaEvent.AssistantMessageDeltaEventData
-
Returns the value of the
deltaContentrecord component. - deltaContent() - Method in record class com.github.copilot.sdk.generated.AssistantReasoningDeltaEvent.AssistantReasoningDeltaEventData
-
Returns the value of the
deltaContentrecord component. - DENIED_BY_CONTENT_EXCLUSION_POLICY - Enum constant in enum class com.github.copilot.sdk.generated.PermissionCompletedKind
-
The
denied-by-content-exclusion-policyvariant. - DENIED_BY_PERMISSION_REQUEST_HOOK - Enum constant in enum class com.github.copilot.sdk.generated.PermissionCompletedKind
-
The
denied-by-permission-request-hookvariant. - DENIED_BY_RULES - Enum constant in enum class com.github.copilot.sdk.generated.PermissionCompletedKind
-
The
denied-by-rulesvariant. - DENIED_BY_RULES - Static variable in class com.github.copilot.sdk.json.PermissionRequestResultKind
-
Deprecated.
- DENIED_COULD_NOT_REQUEST_FROM_USER - Static variable in class com.github.copilot.sdk.json.PermissionRequestResultKind
-
Deprecated.Use
PermissionRequestResultKind.USER_NOT_AVAILABLEinstead. - DENIED_INTERACTIVELY_BY_USER - Enum constant in enum class com.github.copilot.sdk.generated.PermissionCompletedKind
-
The
denied-interactively-by-uservariant. - DENIED_INTERACTIVELY_BY_USER - Static variable in class com.github.copilot.sdk.json.PermissionRequestResultKind
-
Deprecated.Use
PermissionRequestResultKind.REJECTEDinstead. - DENIED_NO_APPROVAL_RULE_AND_COULD_NOT_REQUEST_FROM_USER - Enum constant in enum class com.github.copilot.sdk.generated.PermissionCompletedKind
-
The
denied-no-approval-rule-and-could-not-request-from-uservariant. - deny() - Static method in record class com.github.copilot.sdk.json.PreToolUseHookOutput
-
Creates an output that denies the tool execution.
- deny(String) - Static method in record class com.github.copilot.sdk.json.PreToolUseHookOutput
-
Creates an output that denies the tool execution with a reason.
- description() - Method in record class com.github.copilot.sdk.generated.CommandsChangedCommand
-
Returns the value of the
descriptionrecord component. - description() - Method in record class com.github.copilot.sdk.generated.CustomAgentsUpdatedAgent
-
Returns the value of the
descriptionrecord component. - description() - Method in record class com.github.copilot.sdk.generated.rpc.AgentInfo
-
Returns the value of the
descriptionrecord component. - description() - Method in record class com.github.copilot.sdk.generated.rpc.InstructionsSources
-
Returns the value of the
descriptionrecord component. - description() - Method in record class com.github.copilot.sdk.generated.rpc.ServerSkill
-
Returns the value of the
descriptionrecord component. - description() - Method in record class com.github.copilot.sdk.generated.rpc.Skill
-
Returns the value of the
descriptionrecord component. - description() - Method in record class com.github.copilot.sdk.generated.rpc.Tool
-
Returns the value of the
descriptionrecord component. - description() - Method in record class com.github.copilot.sdk.generated.SkillInvokedEvent.SkillInvokedEventData
-
Returns the value of the
descriptionrecord component. - description() - Method in record class com.github.copilot.sdk.generated.SkillsLoadedSkill
-
Returns the value of the
descriptionrecord component. - description() - Method in record class com.github.copilot.sdk.json.ToolBinaryResult
-
Returns the value of the
descriptionrecord component. - description() - Method in record class com.github.copilot.sdk.json.ToolDefinition
-
Returns the value of the
descriptionrecord component. - deselect() - Method in class com.github.copilot.sdk.generated.rpc.SessionAgentApi
-
Invokes
session.agent.deselect. - deselectAgent() - Method in class com.github.copilot.sdk.CopilotSession
-
Deselects the currently selected custom agent, returning to the default agent.
- dest() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsRenameParams
-
Returns the value of the
destrecord component. - detailedContent() - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteResult
-
Returns the value of the
detailedContentrecord component. - DEVELOPER - Enum constant in enum class com.github.copilot.sdk.generated.SystemMessageRole
-
The
developervariant. - DIRECTORY - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesEntryType
-
The
directoryvariant. - disable(McpConfigDisableParams) - Method in class com.github.copilot.sdk.generated.rpc.ServerMcpConfigApi
-
Invokes
mcp.config.disable. - disable(SessionExtensionsDisableParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionExtensionsApi
-
Invokes
session.extensions.disable. - disable(SessionMcpDisableParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionMcpApi
-
Invokes
session.mcp.disable. - disable(SessionSkillsDisableParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionSkillsApi
-
Invokes
session.skills.disable. - DISABLED - Enum constant in enum class com.github.copilot.sdk.generated.ExtensionsLoadedExtensionStatus
-
The
disabledvariant. - DISABLED - Enum constant in enum class com.github.copilot.sdk.generated.McpServersLoadedServerStatus
-
The
disabledvariant. - DISABLED - Enum constant in enum class com.github.copilot.sdk.generated.McpServerStatusChangedStatus
-
The
disabledvariant. - DISABLED - Enum constant in enum class com.github.copilot.sdk.generated.rpc.ExtensionStatus
-
The
disabledvariant. - DISABLED - Enum constant in enum class com.github.copilot.sdk.generated.rpc.McpServerStatus
-
The
disabledvariant. - disabledSkills() - Method in record class com.github.copilot.sdk.generated.rpc.SkillsConfigSetDisabledSkillsParams
-
Returns the value of the
disabledSkillsrecord component. - DISCONNECTED - Enum constant in enum class com.github.copilot.sdk.ConnectionState
-
The client is not connected to the server.
- discover(McpDiscoverParams) - Method in class com.github.copilot.sdk.generated.rpc.ServerMcpApi
-
Invokes
mcp.discover. - discover(SkillsDiscoverParams) - Method in class com.github.copilot.sdk.generated.rpc.ServerSkillsApi
-
Invokes
skills.discover. - DiscoveredMcpServer - Record Class in com.github.copilot.sdk.generated.rpc
- DiscoveredMcpServer(String, DiscoveredMcpServerType, DiscoveredMcpServerSource, Boolean) - Constructor for record class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServer
-
Creates an instance of a
DiscoveredMcpServerrecord class. - DiscoveredMcpServerSource - Enum Class in com.github.copilot.sdk.generated.rpc
-
Configuration source
- DiscoveredMcpServerType - Enum Class in com.github.copilot.sdk.generated.rpc
-
Server transport type: stdio, http, sse, or memory (local configs are normalized to stdio)
- displayName() - Method in record class com.github.copilot.sdk.generated.CustomAgentsUpdatedAgent
-
Returns the value of the
displayNamerecord component. - displayName() - Method in record class com.github.copilot.sdk.generated.rpc.AgentInfo
-
Returns the value of the
displayNamerecord component. - displayName() - Method in record class com.github.copilot.sdk.json.Attachment
-
Returns the value of the
displayNamerecord component. - duration() - Method in record class com.github.copilot.sdk.generated.AssistantUsageEvent.AssistantUsageEventData
-
Returns the value of the
durationrecord component. - duration() - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsed
-
Returns the value of the
durationrecord component. - durationMs() - Method in record class com.github.copilot.sdk.generated.SubagentCompletedEvent.SubagentCompletedEventData
-
Returns the value of the
durationMsrecord component. - durationMs() - Method in record class com.github.copilot.sdk.generated.SubagentFailedEvent.SubagentFailedEventData
-
Returns the value of the
durationMsrecord component.
E
- elicitation() - Method in record class com.github.copilot.sdk.generated.CapabilitiesChangedUI
-
Returns the value of the
elicitationrecord component. - elicitation(SessionUiElicitationParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionUiApi
-
The elicitation response (accept with form values, decline, or cancel)
- elicitation(ElicitationParams) - Method in interface com.github.copilot.sdk.json.SessionUiApi
-
Shows a generic elicitation dialog with a custom schema.
- ElicitationCompletedAction - Enum Class in com.github.copilot.sdk.generated
-
The user action: "accept" (submitted form), "decline" (explicitly refused), or "cancel" (dismissed)
- ElicitationCompletedEvent - Class in com.github.copilot.sdk.generated
-
The
elicitation.completedsession event. - ElicitationCompletedEvent() - Constructor for class com.github.copilot.sdk.generated.ElicitationCompletedEvent
- ElicitationCompletedEvent.ElicitationCompletedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
ElicitationCompletedEvent. - ElicitationCompletedEventData(String, ElicitationCompletedAction, Map<String, Object>) - Constructor for record class com.github.copilot.sdk.generated.ElicitationCompletedEvent.ElicitationCompletedEventData
-
Creates an instance of a
ElicitationCompletedEventDatarecord class. - ElicitationContext - Class in com.github.copilot.sdk.json
-
Context for an elicitation request received from the server or MCP tools.
- ElicitationContext() - Constructor for class com.github.copilot.sdk.json.ElicitationContext
- ElicitationHandler - Interface in com.github.copilot.sdk.json
-
Functional interface for handling elicitation requests from the server.
- ElicitationParams - Class in com.github.copilot.sdk.json
-
Parameters for an elicitation request sent from the SDK to the host.
- ElicitationParams() - Constructor for class com.github.copilot.sdk.json.ElicitationParams
- ElicitationRequestedEvent - Class in com.github.copilot.sdk.generated
-
The
elicitation.requestedsession event. - ElicitationRequestedEvent() - Constructor for class com.github.copilot.sdk.generated.ElicitationRequestedEvent
- ElicitationRequestedEvent.ElicitationRequestedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
ElicitationRequestedEvent. - ElicitationRequestedEventData(String, String, String, String, ElicitationRequestedMode, ElicitationRequestedSchema, String) - Constructor for record class com.github.copilot.sdk.generated.ElicitationRequestedEvent.ElicitationRequestedEventData
-
Creates an instance of a
ElicitationRequestedEventDatarecord class. - ElicitationRequestedMode - Enum Class in com.github.copilot.sdk.generated
-
Elicitation mode; "form" for structured input, "url" for browser-based.
- ElicitationRequestedSchema - Record Class in com.github.copilot.sdk.generated
-
JSON Schema describing the form fields to present to the user (form mode only)
- ElicitationRequestedSchema(String, Map<String, Object>, List<String>) - Constructor for record class com.github.copilot.sdk.generated.ElicitationRequestedSchema
-
Creates an instance of a
ElicitationRequestedSchemarecord class. - ElicitationResult - Class in com.github.copilot.sdk.json
-
Result returned from an elicitation dialog.
- ElicitationResult() - Constructor for class com.github.copilot.sdk.json.ElicitationResult
- ElicitationResultAction - Enum Class in com.github.copilot.sdk.json
-
Action value for an
ElicitationResult. - ElicitationSchema - Class in com.github.copilot.sdk.json
-
JSON Schema describing the form fields to present for an elicitation dialog.
- ElicitationSchema() - Constructor for class com.github.copilot.sdk.json.ElicitationSchema
- elicitationSource() - Method in record class com.github.copilot.sdk.generated.ElicitationRequestedEvent.ElicitationRequestedEventData
-
Returns the value of the
elicitationSourcerecord component. - enable(McpConfigEnableParams) - Method in class com.github.copilot.sdk.generated.rpc.ServerMcpConfigApi
-
Invokes
mcp.config.enable. - enable(SessionExtensionsEnableParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionExtensionsApi
-
Invokes
session.extensions.enable. - enable(SessionMcpEnableParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionMcpApi
-
Invokes
session.mcp.enable. - enable(SessionSkillsEnableParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionSkillsApi
-
Invokes
session.skills.enable. - enabled() - Method in record class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServer
-
Returns the value of the
enabledrecord component. - enabled() - Method in record class com.github.copilot.sdk.generated.rpc.Plugin
-
Returns the value of the
enabledrecord component. - enabled() - Method in record class com.github.copilot.sdk.generated.rpc.ServerSkill
-
Returns the value of the
enabledrecord component. - enabled() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsSetApproveAllParams
-
Returns the value of the
enabledrecord component. - enabled() - Method in record class com.github.copilot.sdk.generated.rpc.Skill
-
Returns the value of the
enabledrecord component. - enabled() - Method in record class com.github.copilot.sdk.generated.SkillsLoadedSkill
-
Returns the value of the
enabledrecord component. - encryptedContent() - Method in record class com.github.copilot.sdk.generated.AssistantMessageEvent.AssistantMessageEventData
-
Returns the value of the
encryptedContentrecord component. - ENOENT - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionFsErrorCode
-
The
ENOENTvariant. - entitlementRequests() - Method in record class com.github.copilot.sdk.generated.AssistantUsageQuotaSnapshot
-
Returns the value of the
entitlementRequestsrecord component. - entitlementRequests() - Method in record class com.github.copilot.sdk.generated.rpc.AccountQuotaSnapshot
-
Returns the value of the
entitlementRequestsrecord component. - entries() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirResult
-
Returns the value of the
entriesrecord component. - entries() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesResult
-
Returns the value of the
entriesrecord component. - ENV - Enum constant in enum class com.github.copilot.sdk.generated.rpc.AuthInfoType
-
The
envvariant. - ENVIRONMENT_CONTEXT - Static variable in class com.github.copilot.sdk.json.SystemPromptSections
-
CWD, OS, git root, directory listing, available tools.
- ephemeral() - Method in record class com.github.copilot.sdk.generated.rpc.SessionLogParams
-
Returns the value of the
ephemeralrecord component. - equals(Object) - Method in record class com.github.copilot.sdk.generated.AbortEvent.AbortEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.AssistantIntentEvent.AssistantIntentEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.AssistantMessageDeltaEvent.AssistantMessageDeltaEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.AssistantMessageEvent.AssistantMessageEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.AssistantMessageToolRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.AssistantReasoningDeltaEvent.AssistantReasoningDeltaEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.AssistantReasoningEvent.AssistantReasoningEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.AssistantStreamingDeltaEvent.AssistantStreamingDeltaEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.AssistantTurnEndEvent.AssistantTurnEndEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.AssistantTurnStartEvent.AssistantTurnStartEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.AssistantUsageCopilotUsage
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.AssistantUsageCopilotUsageTokenDetail
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.AssistantUsageEvent.AssistantUsageEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.AssistantUsageQuotaSnapshot
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.AutoModeSwitchCompletedEvent.AutoModeSwitchCompletedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.AutoModeSwitchRequestedEvent.AutoModeSwitchRequestedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.CapabilitiesChangedEvent.CapabilitiesChangedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.CapabilitiesChangedUI
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.CommandCompletedEvent.CommandCompletedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.CommandExecuteEvent.CommandExecuteEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.CommandQueuedEvent.CommandQueuedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.CommandsChangedCommand
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.CommandsChangedEvent.CommandsChangedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsed
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsedCopilotUsage
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.CustomAgentsUpdatedAgent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.ElicitationCompletedEvent.ElicitationCompletedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.ElicitationRequestedEvent.ElicitationRequestedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.ElicitationRequestedSchema
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.ExitPlanModeCompletedEvent.ExitPlanModeCompletedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.ExitPlanModeRequestedEvent.ExitPlanModeRequestedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.ExtensionsLoadedExtension
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.ExternalToolCompletedEvent.ExternalToolCompletedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.ExternalToolRequestedEvent.ExternalToolRequestedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.HandoffRepository
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.HookEndError
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.HookEndEvent.HookEndEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.HookStartEvent.HookStartEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.McpOauthCompletedEvent.McpOauthCompletedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.McpOauthRequiredEvent.McpOauthRequiredEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.McpOauthRequiredStaticClientConfig
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.McpServersLoadedServer
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.PendingMessagesModifiedEvent.PendingMessagesModifiedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.PermissionCompletedEvent.PermissionCompletedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.PermissionCompletedResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.PermissionRequestedEvent.PermissionRequestedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.AccountGetQuotaResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.AccountQuotaSnapshot
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.AgentInfo
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServer
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.Extension
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.HistoryCompactContextWindow
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.InstructionsSources
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigAddParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigDisableParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigEnableParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigListResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigRemoveParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigUpdateParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.McpDiscoverParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.McpDiscoverResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.McpServer
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.Model
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.ModelBilling
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilities
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesLimits
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesLimitsVision
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverride
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverrideLimits
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverrideLimitsVision
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverrideSupports
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesSupports
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.ModelPolicy
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.ModelsListResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.PingParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.PingResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.Plugin
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.ServerSkill
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentDeselectParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentDeselectResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentGetCurrentParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentGetCurrentResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentListParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentListResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentReloadParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentReloadResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentSelectParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentSelectResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionAuthGetStatusParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionAuthGetStatusResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionCommandsHandlePendingCommandParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionCommandsHandlePendingCommandResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsDisableParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsDisableResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsEnableParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsEnableResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsListParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsListResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsReloadParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsReloadResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionFleetStartParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionFleetStartResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsAppendFileParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsError
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsExistsParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsExistsResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsMkdirParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesEntry
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReadFileParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReadFileResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsRenameParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsRmParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsSetProviderParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsSetProviderResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsStatParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsStatResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsWriteFileParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionHistoryCompactParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionHistoryCompactResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionHistoryTruncateParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionHistoryTruncateResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionInstructionsGetSourcesParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionInstructionsGetSourcesResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionLogParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionLogResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpDisableParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpDisableResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpEnableParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpEnableResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpListParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpListResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpOauthLoginParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpOauthLoginResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpReloadParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpReloadResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionModeGetParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionModeGetResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionModelGetCurrentParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionModelGetCurrentResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionModelSwitchToParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionModelSwitchToResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionModeSetParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionModeSetResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionNameGetParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionNameGetResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionNameSetParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsHandlePendingPermissionRequestParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsHandlePendingPermissionRequestResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsResetSessionApprovalsParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsResetSessionApprovalsResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsSetApproveAllParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsSetApproveAllResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanDeleteParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanDeleteResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanReadParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanReadResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanUpdateParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanUpdateResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionPluginsListParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionPluginsListResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionsForkParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionsForkResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionShellExecParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionShellExecResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionShellKillParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionShellKillResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsDisableParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsDisableResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsEnableParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsEnableResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsListParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsListResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsReloadParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsReloadResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionToolsHandlePendingToolCallParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionToolsHandlePendingToolCallResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionUiElicitationParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionUiElicitationResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionUiHandlePendingElicitationParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionUiHandlePendingElicitationResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionUsageGetMetricsParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionUsageGetMetricsResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceCreateFileParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceCreateFileResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceListFilesParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceListFilesResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceReadFileParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceReadFileResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesCreateFileParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesListFilesParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesListFilesResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesReadFileParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesReadFileResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.Skill
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SkillsConfigSetDisabledSkillsParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SkillsDiscoverParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.SkillsDiscoverResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.Tool
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.ToolsListParams
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.ToolsListResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.UIElicitationResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.UIElicitationSchema
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsCodeChanges
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsModelMetric
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsModelMetricRequests
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsModelMetricUsage
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SamplingCompletedEvent.SamplingCompletedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SamplingRequestedEvent.SamplingRequestedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionBackgroundTasksChangedEvent.SessionBackgroundTasksChangedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent.SessionCompactionCompleteEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionCompactionStartEvent.SessionCompactionStartEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionContextChangedEvent.SessionContextChangedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionCustomAgentsUpdatedEvent.SessionCustomAgentsUpdatedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionErrorEvent.SessionErrorEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionExtensionsLoadedEvent.SessionExtensionsLoadedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionHandoffEvent.SessionHandoffEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionIdleEvent.SessionIdleEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionInfoEvent.SessionInfoEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionMcpServersLoadedEvent.SessionMcpServersLoadedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionMcpServerStatusChangedEvent.SessionMcpServerStatusChangedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionModeChangedEvent.SessionModeChangedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionModelChangeEvent.SessionModelChangeEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionPlanChangedEvent.SessionPlanChangedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionRemoteSteerableChangedEvent.SessionRemoteSteerableChangedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionResumeEvent.SessionResumeEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionShutdownEvent.SessionShutdownEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionSkillsLoadedEvent.SessionSkillsLoadedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionSnapshotRewindEvent.SessionSnapshotRewindEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionStartEvent.SessionStartEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionTaskCompleteEvent.SessionTaskCompleteEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionTitleChangedEvent.SessionTitleChangedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionToolsUpdatedEvent.SessionToolsUpdatedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionTruncationEvent.SessionTruncationEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionUsageInfoEvent.SessionUsageInfoEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionWarningEvent.SessionWarningEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SessionWorkspaceFileChangedEvent.SessionWorkspaceFileChangedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.ShutdownCodeChanges
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.ShutdownModelMetric
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.ShutdownModelMetricRequests
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.ShutdownModelMetricUsage
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SkillInvokedEvent.SkillInvokedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SkillsLoadedSkill
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SubagentCompletedEvent.SubagentCompletedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SubagentDeselectedEvent.SubagentDeselectedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SubagentFailedEvent.SubagentFailedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SubagentSelectedEvent.SubagentSelectedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SubagentStartedEvent.SubagentStartedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SystemMessageEvent.SystemMessageEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SystemMessageMetadata
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.SystemNotificationEvent.SystemNotificationEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteError
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteEvent.ToolExecutionCompleteEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.ToolExecutionPartialResultEvent.ToolExecutionPartialResultEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.ToolExecutionProgressEvent.ToolExecutionProgressEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.ToolExecutionStartEvent.ToolExecutionStartEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.ToolUserRequestedEvent.ToolUserRequestedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.UserInputCompletedEvent.UserInputCompletedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.UserInputRequestedEvent.UserInputRequestedEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.UserMessageEvent.UserMessageEventData
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.generated.WorkingDirectoryContext
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.Attachment
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.CreateSessionResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.DeleteSessionResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.GetForegroundSessionResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.GetLastSessionIdResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.GetMessagesResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.GetSessionMetadataResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.ListSessionsResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.github.copilot.sdk.json.PermissionRequestResultKind
- equals(Object) - Method in record class com.github.copilot.sdk.json.PingResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.PostToolUseHookOutput
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.PreToolUseHookOutput
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.ResumeSessionResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.SendMessageResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.SessionEndHookInput
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.SessionEndHookOutput
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.SessionLifecycleEventMetadata
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.SessionStartHookInput
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.SessionStartHookOutput
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.SetForegroundSessionResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.ToolBinaryResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.ToolDefinition
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.ToolResultObject
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookInput
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookOutput
-
Indicates whether some other object is "equal to" this one.
- error() - Method in record class com.github.copilot.sdk.generated.HookEndEvent.HookEndEventData
-
Returns the value of the
errorrecord component. - error() - Method in record class com.github.copilot.sdk.generated.McpServersLoadedServer
-
Returns the value of the
errorrecord component. - error() - Method in record class com.github.copilot.sdk.generated.rpc.McpServer
-
Returns the value of the
errorrecord component. - error() - Method in record class com.github.copilot.sdk.generated.rpc.SessionCommandsHandlePendingCommandParams
-
Returns the value of the
errorrecord component. - error() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirResult
-
Returns the value of the
errorrecord component. - error() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesResult
-
Returns the value of the
errorrecord component. - error() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReadFileResult
-
Returns the value of the
errorrecord component. - error() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsStatResult
-
Returns the value of the
errorrecord component. - error() - Method in record class com.github.copilot.sdk.generated.rpc.SessionToolsHandlePendingToolCallParams
-
Returns the value of the
errorrecord component. - error() - Method in record class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent.SessionCompactionCompleteEventData
-
Returns the value of the
errorrecord component. - error() - Method in record class com.github.copilot.sdk.generated.SubagentFailedEvent.SubagentFailedEventData
-
Returns the value of the
errorrecord component. - error() - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteEvent.ToolExecutionCompleteEventData
-
Returns the value of the
errorrecord component. - error() - Method in record class com.github.copilot.sdk.json.DeleteSessionResponse
-
Returns the value of the
errorrecord component. - error() - Method in record class com.github.copilot.sdk.json.SessionEndHookInput
-
Returns the value of the
errorrecord component. - error() - Method in record class com.github.copilot.sdk.json.SetForegroundSessionResponse
-
Returns the value of the
errorrecord component. - error() - Method in record class com.github.copilot.sdk.json.ToolResultObject
-
Returns the value of the
errorrecord component. - error(String) - Static method in record class com.github.copilot.sdk.json.ToolResultObject
-
Creates an error result with the given error message.
- error(String, String) - Static method in record class com.github.copilot.sdk.json.ToolResultObject
-
Creates an error result with both a text result and error message.
- ERROR - Enum constant in enum class com.github.copilot.sdk.ConnectionState
-
The client encountered an error during connection or operation.
- ERROR - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionLogLevel
-
The
errorvariant. - ERROR - Enum constant in enum class com.github.copilot.sdk.generated.ShutdownType
-
The
errorvariant. - errorCode() - Method in record class com.github.copilot.sdk.generated.AutoModeSwitchRequestedEvent.AutoModeSwitchRequestedEventData
-
Returns the value of the
errorCoderecord component. - errorReason() - Method in record class com.github.copilot.sdk.generated.SessionShutdownEvent.SessionShutdownEventData
-
Returns the value of the
errorReasonrecord component. - errors() - Method in record class com.github.copilot.sdk.generated.SessionCustomAgentsUpdatedEvent.SessionCustomAgentsUpdatedEventData
-
Returns the value of the
errorsrecord component. - errorType() - Method in record class com.github.copilot.sdk.generated.SessionErrorEvent.SessionErrorEventData
-
Returns the value of the
errorTyperecord component. - eventCount() - Method in record class com.github.copilot.sdk.generated.SessionResumeEvent.SessionResumeEventData
-
Returns the value of the
eventCountrecord component. - EventErrorHandler - Interface in com.github.copilot.sdk
-
A handler for errors thrown by event handlers during event dispatch.
- EventErrorPolicy - Enum Class in com.github.copilot.sdk
-
Controls how event dispatch behaves when an event handler throws an exception.
- eventId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionHistoryTruncateParams
-
Returns the value of the
eventIdrecord component. - eventId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionLogResult
-
Returns the value of the
eventIdrecord component. - events() - Method in record class com.github.copilot.sdk.json.GetMessagesResponse
-
Returns the value of the
eventsrecord component. - eventsRemoved() - Method in record class com.github.copilot.sdk.generated.rpc.SessionHistoryTruncateResult
-
Returns the value of the
eventsRemovedrecord component. - eventsRemoved() - Method in record class com.github.copilot.sdk.generated.SessionSnapshotRewindEvent.SessionSnapshotRewindEventData
-
Returns the value of the
eventsRemovedrecord component. - exec(SessionShellExecParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionShellApi
-
Invokes
session.shell.exec. - exists() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsExistsResult
-
Returns the value of the
existsrecord component. - exists() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanReadResult
-
Returns the value of the
existsrecord component. - ExitPlanModeCompletedEvent - Class in com.github.copilot.sdk.generated
-
The
exit_plan_mode.completedsession event. - ExitPlanModeCompletedEvent() - Constructor for class com.github.copilot.sdk.generated.ExitPlanModeCompletedEvent
- ExitPlanModeCompletedEvent.ExitPlanModeCompletedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
ExitPlanModeCompletedEvent. - ExitPlanModeCompletedEventData(String, Boolean, String, Boolean, String) - Constructor for record class com.github.copilot.sdk.generated.ExitPlanModeCompletedEvent.ExitPlanModeCompletedEventData
-
Creates an instance of a
ExitPlanModeCompletedEventDatarecord class. - ExitPlanModeRequestedEvent - Class in com.github.copilot.sdk.generated
-
The
exit_plan_mode.requestedsession event. - ExitPlanModeRequestedEvent() - Constructor for class com.github.copilot.sdk.generated.ExitPlanModeRequestedEvent
- ExitPlanModeRequestedEvent.ExitPlanModeRequestedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
ExitPlanModeRequestedEvent. - ExitPlanModeRequestedEventData(String, String, String, List<String>, String) - Constructor for record class com.github.copilot.sdk.generated.ExitPlanModeRequestedEvent.ExitPlanModeRequestedEventData
-
Creates an instance of a
ExitPlanModeRequestedEventDatarecord class. - Extension - Record Class in com.github.copilot.sdk.generated.rpc
- Extension(String, String, ExtensionSource, ExtensionStatus, Long) - Constructor for record class com.github.copilot.sdk.generated.rpc.Extension
-
Creates an instance of a
Extensionrecord class. - extensions - Variable in class com.github.copilot.sdk.generated.rpc.SessionRpc
-
API methods for the
extensionsnamespace. - extensions() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsListResult
-
Returns the value of the
extensionsrecord component. - extensions() - Method in record class com.github.copilot.sdk.generated.SessionExtensionsLoadedEvent.SessionExtensionsLoadedEventData
-
Returns the value of the
extensionsrecord component. - ExtensionsLoadedExtension - Record Class in com.github.copilot.sdk.generated
- ExtensionsLoadedExtension(String, String, ExtensionsLoadedExtensionSource, ExtensionsLoadedExtensionStatus) - Constructor for record class com.github.copilot.sdk.generated.ExtensionsLoadedExtension
-
Creates an instance of a
ExtensionsLoadedExtensionrecord class. - ExtensionsLoadedExtensionSource - Enum Class in com.github.copilot.sdk.generated
-
Discovery source
- ExtensionsLoadedExtensionStatus - Enum Class in com.github.copilot.sdk.generated
-
Current status: running, disabled, failed, or starting
- ExtensionSource - Enum Class in com.github.copilot.sdk.generated.rpc
-
Discovery source: project (.github/extensions/) or user (~/.copilot/extensions/)
- ExtensionStatus - Enum Class in com.github.copilot.sdk.generated.rpc
-
Current status: running, disabled, failed, or starting
- ExternalToolCompletedEvent - Class in com.github.copilot.sdk.generated
-
The
external_tool.completedsession event. - ExternalToolCompletedEvent() - Constructor for class com.github.copilot.sdk.generated.ExternalToolCompletedEvent
- ExternalToolCompletedEvent.ExternalToolCompletedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
ExternalToolCompletedEvent. - ExternalToolCompletedEventData(String) - Constructor for record class com.github.copilot.sdk.generated.ExternalToolCompletedEvent.ExternalToolCompletedEventData
-
Creates an instance of a
ExternalToolCompletedEventDatarecord class. - ExternalToolRequestedEvent - Class in com.github.copilot.sdk.generated
-
The
external_tool.requestedsession event. - ExternalToolRequestedEvent() - Constructor for class com.github.copilot.sdk.generated.ExternalToolRequestedEvent
- ExternalToolRequestedEvent.ExternalToolRequestedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
ExternalToolRequestedEvent. - ExternalToolRequestedEventData(String, String, String, String, Object, String, String) - Constructor for record class com.github.copilot.sdk.generated.ExternalToolRequestedEvent.ExternalToolRequestedEventData
-
Creates an instance of a
ExternalToolRequestedEventDatarecord class.
F
- FAILED - Enum constant in enum class com.github.copilot.sdk.generated.ExtensionsLoadedExtensionStatus
-
The
failedvariant. - FAILED - Enum constant in enum class com.github.copilot.sdk.generated.McpServersLoadedServerStatus
-
The
failedvariant. - FAILED - Enum constant in enum class com.github.copilot.sdk.generated.McpServerStatusChangedStatus
-
The
failedvariant. - FAILED - Enum constant in enum class com.github.copilot.sdk.generated.rpc.ExtensionStatus
-
The
failedvariant. - FAILED - Enum constant in enum class com.github.copilot.sdk.generated.rpc.McpServerStatus
-
The
failedvariant. - failure(String, String) - Static method in record class com.github.copilot.sdk.json.ToolResultObject
-
Creates a failure result with the given text and error message.
- feedback() - Method in record class com.github.copilot.sdk.generated.ExitPlanModeCompletedEvent.ExitPlanModeCompletedEventData
-
Returns the value of the
feedbackrecord component. - FILE - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesEntryType
-
The
filevariant. - files() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceListFilesResult
-
Returns the value of the
filesrecord component. - files() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesListFilesResult
-
Returns the value of the
filesrecord component. - filesModified() - Method in record class com.github.copilot.sdk.generated.ShutdownCodeChanges
-
Returns the value of the
filesModifiedrecord component. - filesModifiedCount() - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsCodeChanges
-
Returns the value of the
filesModifiedCountrecord component. - finalMessage() - Method in record class com.github.copilot.sdk.json.SessionEndHookInput
-
Returns the value of the
finalMessagerecord component. - fleet - Variable in class com.github.copilot.sdk.generated.rpc.SessionRpc
-
API methods for the
fleetnamespace. - force() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsRmParams
-
Returns the value of the
forcerecord component. - forceReauth() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpOauthLoginParams
-
Returns the value of the
forceReauthrecord component. - forceStop() - Method in class com.github.copilot.sdk.CopilotClient
-
Forces an immediate stop of the client without graceful cleanup.
- FOREGROUND - Static variable in class com.github.copilot.sdk.json.SessionLifecycleEventTypes
-
Event fired when a session moves to foreground (TUI+server mode).
- fork(SessionsForkParams) - Method in class com.github.copilot.sdk.generated.rpc.ServerSessionsApi
-
Invokes
sessions.fork. - FORM - Enum constant in enum class com.github.copilot.sdk.generated.ElicitationRequestedMode
-
The
formvariant. - fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.AssistantMessageToolRequestType
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.ElicitationCompletedAction
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.ElicitationRequestedMode
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.ExtensionsLoadedExtensionSource
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.ExtensionsLoadedExtensionStatus
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.HandoffSourceType
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.McpServersLoadedServerStatus
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.McpServerStatusChangedStatus
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.PermissionCompletedKind
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.PlanChangedOperation
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.AuthInfoType
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServerSource
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServerType
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.ExtensionSource
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.ExtensionStatus
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.InstructionsSourcesLocation
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.InstructionsSourcesType
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.McpServerSource
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.McpServerStatus
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionFsErrorCode
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesEntryType
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionFsSetProviderConventions
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionLogLevel
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionMode
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionModeGetResult.SessionModeGetResultMode
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionModeSetResult.SessionModeSetResultMode
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace.SessionWorkspacesGetWorkspaceResultWorkspaceHostType
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace.SessionWorkspacesGetWorkspaceResultWorkspaceSessionSyncLevel
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.ShellKillSignal
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.UIElicitationResponseAction
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.ShutdownType
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.SystemMessageRole
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.UserMessageAgentMode
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.WorkingDirectoryContextHostType
- fromValue(String) - Static method in enum class com.github.copilot.sdk.generated.WorkspaceFileChangedOperation
- FUNCTION - Enum constant in enum class com.github.copilot.sdk.generated.AssistantMessageToolRequestType
-
The
functionvariant.
G
- get() - Method in class com.github.copilot.sdk.generated.rpc.SessionModeApi
-
The agent mode.
- get() - Method in class com.github.copilot.sdk.generated.rpc.SessionNameApi
-
Invokes
session.name.get. - get() - Static method in enum class com.github.copilot.sdk.SdkProtocolVersion
-
Gets the SDK protocol version.
- getAction() - Method in class com.github.copilot.sdk.json.ElicitationResult
-
Gets the user action taken on the elicitation dialog.
- getAction() - Method in class com.github.copilot.sdk.json.SectionOverride
-
Gets the override action.
- getAgent() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets the pre-selected agent name.
- getAgent() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the name of the custom agent to activate at session start.
- getAgent() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets the pre-selected agent name.
- getAgent() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the name of the custom agent to activate at session start.
- getAllowFreeform() - Method in class com.github.copilot.sdk.json.UserInputRequest
-
Returns whether freeform text input is allowed.
- getAnswer() - Method in class com.github.copilot.sdk.json.UserInputResponse
-
Gets the user's answer.
- getApiKey() - Method in class com.github.copilot.sdk.json.ProviderConfig
-
Gets the API key.
- getApiVersion() - Method in class com.github.copilot.sdk.json.AzureOptions
-
Gets the Azure OpenAI API version.
- getArgs() - Method in class com.github.copilot.sdk.json.CommandContext
-
Gets the raw argument string after the command name.
- getArgs() - Method in class com.github.copilot.sdk.json.McpStdioServerConfig
-
Gets the arguments to pass to the command.
- getArguments() - Method in class com.github.copilot.sdk.json.ToolInvocation
-
Gets the arguments passed to the tool as a Map.
- getArgumentsAs(Class<T>) - Method in class com.github.copilot.sdk.json.ToolInvocation
-
Deserializes the tool arguments into the specified type.
- getAttachments() - Method in class com.github.copilot.sdk.json.MessageOptions
-
Gets the attachments.
- getAttachments() - Method in class com.github.copilot.sdk.json.SendMessageRequest
-
Gets the attachments.
- getAuthStatus() - Method in class com.github.copilot.sdk.CopilotClient
-
Gets current authentication status.
- GetAuthStatusResponse - Class in com.github.copilot.sdk.json
-
Response from the auth.getStatus RPC call.
- GetAuthStatusResponse() - Constructor for class com.github.copilot.sdk.json.GetAuthStatusResponse
- getAuthType() - Method in class com.github.copilot.sdk.json.GetAuthStatusResponse
- getAvailableTools() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets available tools.
- getAvailableTools() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the list of allowed tool names.
- getAvailableTools() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets available tools.
- getAvailableTools() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the list of allowed tool names.
- getAzure() - Method in class com.github.copilot.sdk.json.ProviderConfig
-
Gets the Azure-specific options.
- getBackgroundCompactionThreshold() - Method in class com.github.copilot.sdk.json.InfiniteSessionConfig
-
Gets the background compaction threshold.
- getBaseUrl() - Method in class com.github.copilot.sdk.json.ProviderConfig
-
Gets the base URL for the API.
- getBearerToken() - Method in class com.github.copilot.sdk.json.ProviderConfig
-
Gets the bearer token.
- getBilling() - Method in class com.github.copilot.sdk.json.ModelInfo
- getBranch() - Method in class com.github.copilot.sdk.json.SessionContext
-
Gets the current git branch.
- getBufferExhaustionThreshold() - Method in class com.github.copilot.sdk.json.InfiniteSessionConfig
-
Gets the buffer exhaustion threshold.
- getCapabilities() - Method in class com.github.copilot.sdk.CopilotSession
-
Gets the capabilities reported by the host for this session.
- getCapabilities() - Method in class com.github.copilot.sdk.json.ModelInfo
- getCaptureContent() - Method in class com.github.copilot.sdk.json.TelemetryConfig
-
Gets whether to capture message content as part of telemetry.
- getChoices() - Method in class com.github.copilot.sdk.json.UserInputRequest
-
Gets the optional choices for multiple choice questions.
- getCliArgs() - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Gets the extra CLI arguments.
- getClientName() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets the client name.
- getClientName() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the client name used to identify the application using the SDK.
- getClientName() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets the client name.
- getClientName() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the client name used to identify the application using the SDK.
- getCliPath() - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Gets the path to the Copilot CLI executable.
- getCliUrl() - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Gets the URL of an existing CLI server to connect to.
- getCode() - Method in class com.github.copilot.sdk.json.JsonRpcError
-
Gets the error code.
- getCommand() - Method in class com.github.copilot.sdk.json.CommandContext
-
Gets the full command text (e.g.,
/deploy production). - getCommand() - Method in class com.github.copilot.sdk.json.McpStdioServerConfig
-
Gets the command to run the MCP server.
- getCommandName() - Method in class com.github.copilot.sdk.json.CommandContext
-
Gets the command name without the leading
/. - getCommands() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets the commands wire definitions.
- getCommands() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the slash commands registered for this session.
- getCommands() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets the commands wire definitions.
- getCommands() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the slash commands registered for this session.
- getConfigDir() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets config directory.
- getConfigDir() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the configuration directory path.
- getConfigDir() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets config directory.
- getConfigDir() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the custom configuration directory.
- getContent() - Method in class com.github.copilot.sdk.json.ElicitationResult
-
Gets the form values submitted by the user.
- getContent() - Method in class com.github.copilot.sdk.json.SectionOverride
-
Gets the content for the override.
- getContent() - Method in class com.github.copilot.sdk.json.SystemMessageConfig
-
Gets the system message content.
- getContext() - Method in class com.github.copilot.sdk.json.SessionMetadata
-
Gets the working directory context from session creation.
- getCurrent() - Method in class com.github.copilot.sdk.generated.rpc.SessionAgentApi
-
Invokes
session.agent.getCurrent. - getCurrent() - Method in class com.github.copilot.sdk.generated.rpc.SessionModelApi
-
Invokes
session.model.getCurrent. - getCurrentAgent() - Method in class com.github.copilot.sdk.CopilotSession
-
Gets the currently selected custom agent for this session, or
nullif no custom agent is selected. - getCustomAgents() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets custom agents.
- getCustomAgents() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the custom agent configurations.
- getCustomAgents() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets custom agents.
- getCustomAgents() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the custom agent configurations.
- getCwd() - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Gets the working directory for the CLI process.
- getCwd() - Method in class com.github.copilot.sdk.json.PostToolUseHookInput
-
Gets the current working directory.
- getCwd() - Method in class com.github.copilot.sdk.json.PreToolUseHookInput
-
Gets the current working directory.
- getCwd() - Method in class com.github.copilot.sdk.json.SessionContext
-
Gets the working directory where the session was created.
- getData() - Method in class com.github.copilot.sdk.generated.AbortEvent
- getData() - Method in class com.github.copilot.sdk.generated.AssistantIntentEvent
- getData() - Method in class com.github.copilot.sdk.generated.AssistantMessageDeltaEvent
- getData() - Method in class com.github.copilot.sdk.generated.AssistantMessageEvent
- getData() - Method in class com.github.copilot.sdk.generated.AssistantReasoningDeltaEvent
- getData() - Method in class com.github.copilot.sdk.generated.AssistantReasoningEvent
- getData() - Method in class com.github.copilot.sdk.generated.AssistantStreamingDeltaEvent
- getData() - Method in class com.github.copilot.sdk.generated.AssistantTurnEndEvent
- getData() - Method in class com.github.copilot.sdk.generated.AssistantTurnStartEvent
- getData() - Method in class com.github.copilot.sdk.generated.AssistantUsageEvent
- getData() - Method in class com.github.copilot.sdk.generated.AutoModeSwitchCompletedEvent
- getData() - Method in class com.github.copilot.sdk.generated.AutoModeSwitchRequestedEvent
- getData() - Method in class com.github.copilot.sdk.generated.CapabilitiesChangedEvent
- getData() - Method in class com.github.copilot.sdk.generated.CommandCompletedEvent
- getData() - Method in class com.github.copilot.sdk.generated.CommandExecuteEvent
- getData() - Method in class com.github.copilot.sdk.generated.CommandQueuedEvent
- getData() - Method in class com.github.copilot.sdk.generated.CommandsChangedEvent
- getData() - Method in class com.github.copilot.sdk.generated.ElicitationCompletedEvent
- getData() - Method in class com.github.copilot.sdk.generated.ElicitationRequestedEvent
- getData() - Method in class com.github.copilot.sdk.generated.ExitPlanModeCompletedEvent
- getData() - Method in class com.github.copilot.sdk.generated.ExitPlanModeRequestedEvent
- getData() - Method in class com.github.copilot.sdk.generated.ExternalToolCompletedEvent
- getData() - Method in class com.github.copilot.sdk.generated.ExternalToolRequestedEvent
- getData() - Method in class com.github.copilot.sdk.generated.HookEndEvent
- getData() - Method in class com.github.copilot.sdk.generated.HookStartEvent
- getData() - Method in class com.github.copilot.sdk.generated.McpOauthCompletedEvent
- getData() - Method in class com.github.copilot.sdk.generated.McpOauthRequiredEvent
- getData() - Method in class com.github.copilot.sdk.generated.PendingMessagesModifiedEvent
- getData() - Method in class com.github.copilot.sdk.generated.PermissionCompletedEvent
- getData() - Method in class com.github.copilot.sdk.generated.PermissionRequestedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SamplingCompletedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SamplingRequestedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionBackgroundTasksChangedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionCompactionStartEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionContextChangedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionCustomAgentsUpdatedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionErrorEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionExtensionsLoadedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionHandoffEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionIdleEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionInfoEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionMcpServersLoadedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionMcpServerStatusChangedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionModeChangedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionModelChangeEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionPlanChangedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionRemoteSteerableChangedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionResumeEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionShutdownEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionSkillsLoadedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionSnapshotRewindEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionStartEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionTaskCompleteEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionTitleChangedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionToolsUpdatedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionTruncationEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionUsageInfoEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionWarningEvent
- getData() - Method in class com.github.copilot.sdk.generated.SessionWorkspaceFileChangedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SkillInvokedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SubagentCompletedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SubagentDeselectedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SubagentFailedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SubagentSelectedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SubagentStartedEvent
- getData() - Method in class com.github.copilot.sdk.generated.SystemMessageEvent
- getData() - Method in class com.github.copilot.sdk.generated.SystemNotificationEvent
- getData() - Method in class com.github.copilot.sdk.generated.ToolExecutionCompleteEvent
- getData() - Method in class com.github.copilot.sdk.generated.ToolExecutionPartialResultEvent
- getData() - Method in class com.github.copilot.sdk.generated.ToolExecutionProgressEvent
- getData() - Method in class com.github.copilot.sdk.generated.ToolExecutionStartEvent
- getData() - Method in class com.github.copilot.sdk.generated.ToolUserRequestedEvent
- getData() - Method in class com.github.copilot.sdk.generated.UserInputCompletedEvent
- getData() - Method in class com.github.copilot.sdk.generated.UserInputRequestedEvent
- getData() - Method in class com.github.copilot.sdk.generated.UserMessageEvent
- getData() - Method in class com.github.copilot.sdk.json.BlobAttachment
-
Gets the base64-encoded binary content.
- getData() - Method in class com.github.copilot.sdk.json.JsonRpcError
-
Gets the additional error data.
- getDefaultAgent() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets the default agent config.
- getDefaultAgent() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the default agent configuration.
- getDefaultAgent() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets the default agent config.
- getDefaultAgent() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the default agent configuration.
- getDefaultReasoningEffort() - Method in class com.github.copilot.sdk.json.ModelInfo
-
Gets the default reasoning effort level.
- getDefaultValue() - Method in class com.github.copilot.sdk.json.InputOptions
-
Gets the default value pre-populated in the field.
- getDescription() - Method in class com.github.copilot.sdk.json.AgentInfo
-
Gets the description of the agent's purpose.
- getDescription() - Method in class com.github.copilot.sdk.json.CommandDefinition
-
Gets the human-readable description shown in the command completion UI.
- getDescription() - Method in class com.github.copilot.sdk.json.CommandWireDefinition
-
Gets the description.
- getDescription() - Method in class com.github.copilot.sdk.json.CustomAgentConfig
-
Gets the agent description.
- getDescription() - Method in class com.github.copilot.sdk.json.InputOptions
-
Gets the descriptive text shown below the field.
- getDisabledSkills() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets disabled skills.
- getDisabledSkills() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the disabled skills.
- getDisabledSkills() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets disabled skills.
- getDisabledSkills() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the disabled skill names.
- getDisableResume() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets disable resume flag.
- getDisplayName() - Method in class com.github.copilot.sdk.json.AgentInfo
-
Gets the human-readable display name of the agent.
- getDisplayName() - Method in class com.github.copilot.sdk.json.BlobAttachment
-
Gets the human-readable display name for the attachment.
- getDisplayName() - Method in class com.github.copilot.sdk.json.CustomAgentConfig
-
Gets the human-readable display name.
- getElicitation() - Method in class com.github.copilot.sdk.json.SessionUiCapabilities
-
Returns whether the host supports interactive elicitation dialogs.
- getElicitationSource() - Method in class com.github.copilot.sdk.json.ElicitationContext
-
Gets the source that initiated the request (e.g., MCP server name).
- getEnableConfigDiscovery() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets enable config discovery flag.
- getEnableConfigDiscovery() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets whether automatic configuration discovery is enabled.
- getEnableConfigDiscovery() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets enable config discovery flag.
- getEnableConfigDiscovery() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets whether automatic configuration discovery is enabled.
- getEnabled() - Method in class com.github.copilot.sdk.json.InfiniteSessionConfig
-
Gets whether infinite sessions are enabled.
- getEnv() - Method in class com.github.copilot.sdk.json.McpStdioServerConfig
-
Gets the environment variables to pass to the server.
- getEnvironment() - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Gets the environment variables for the CLI process.
- getEnvValueMode() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets MCP environment variable value mode.
- getEnvValueMode() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets MCP environment variable value mode.
- getEphemeral() - Method in class com.github.copilot.sdk.generated.SessionEvent
- getError() - Method in class com.github.copilot.sdk.json.JsonRpcResponse
-
Gets the error if the RPC call failed.
- getExcludedTools() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets excluded tools.
- getExcludedTools() - Method in class com.github.copilot.sdk.json.DefaultAgentConfig
-
Gets the list of tool names excluded from the default agent.
- getExcludedTools() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the list of excluded tool names.
- getExcludedTools() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets excluded tools.
- getExcludedTools() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the list of excluded tool names.
- getExecutor() - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Gets the executor used for internal asynchronous operations.
- getExporterType() - Method in class com.github.copilot.sdk.json.TelemetryConfig
-
Gets the exporter type.
- getExtensionData() - Method in class com.github.copilot.sdk.json.PermissionRequest
-
Gets additional extension data for the request.
- getFilePath() - Method in class com.github.copilot.sdk.json.TelemetryConfig
-
Gets the file path for the file exporter.
- getForegroundSessionId() - Method in class com.github.copilot.sdk.CopilotClient
-
Gets the ID of the session currently displayed in the TUI.
- GetForegroundSessionResponse - Record Class in com.github.copilot.sdk.json
-
Response from session.getForeground RPC call.
- GetForegroundSessionResponse(String, String) - Constructor for record class com.github.copilot.sdk.json.GetForegroundSessionResponse
-
Creates an instance of a
GetForegroundSessionResponserecord class. - getFormat() - Method in class com.github.copilot.sdk.json.InputOptions
-
Gets the semantic format hint (e.g.,
"email","uri","date","date-time"). - getGithubToken() - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Deprecated.Use
CopilotClientOptions.getGitHubToken()instead. - getGitHubToken() - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Gets the GitHub token for authentication.
- getGitHubToken() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets the GitHub token for per-session authentication.
- getGitHubToken() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the GitHub token for per-session authentication.
- getGitHubToken() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets the GitHub token for per-session authentication.
- getGitHubToken() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the GitHub token for per-session authentication.
- getGitRoot() - Method in class com.github.copilot.sdk.json.SessionContext
-
Gets the git repository root directory.
- getHandler() - Method in class com.github.copilot.sdk.json.CommandDefinition
-
Gets the handler invoked when the command is executed.
- getHeaders() - Method in class com.github.copilot.sdk.json.McpHttpServerConfig
-
Gets the optional HTTP headers to include in requests.
- getHeaders() - Method in class com.github.copilot.sdk.json.ProviderConfig
-
Gets the custom HTTP headers for outbound provider requests.
- getHooks() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets hooks flag.
- getHooks() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the hook handlers configuration.
- getHooks() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets hooks flag.
- getHooks() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the hook handlers configuration.
- getHost() - Method in class com.github.copilot.sdk.json.GetAuthStatusResponse
- getId() - Method in class com.github.copilot.sdk.generated.SessionEvent
- getId() - Method in class com.github.copilot.sdk.json.JsonRpcRequest
-
Gets the request ID.
- getId() - Method in class com.github.copilot.sdk.json.JsonRpcResponse
-
Gets the response ID.
- getId() - Method in class com.github.copilot.sdk.json.ModelInfo
- getIncludeSubAgentStreamingEvents() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets include sub-agent streaming events flag.
- getIncludeSubAgentStreamingEvents() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets whether sub-agent streaming events are included.
- getIncludeSubAgentStreamingEvents() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets include sub-agent streaming events flag.
- getIncludeSubAgentStreamingEvents() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets whether sub-agent streaming events are included.
- getInfer() - Method in class com.github.copilot.sdk.json.CustomAgentConfig
-
Gets whether inference mode is enabled.
- getInfiniteSessions() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets infinite sessions config.
- getInfiniteSessions() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the infinite session configuration.
- getInfiniteSessions() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets infinite sessions config.
- getInfiniteSessions() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the infinite sessions configuration.
- getJsonrpc() - Method in class com.github.copilot.sdk.json.JsonRpcRequest
-
Gets the JSON-RPC version.
- getJsonrpc() - Method in class com.github.copilot.sdk.json.JsonRpcResponse
-
Gets the JSON-RPC version.
- getKind() - Method in class com.github.copilot.sdk.json.PermissionRequest
-
Gets the kind of permission being requested.
- getKind() - Method in class com.github.copilot.sdk.json.PermissionRequestResult
-
Gets the result kind as a string.
- getLastSessionId() - Method in class com.github.copilot.sdk.CopilotClient
-
Gets the ID of the most recently used session.
- GetLastSessionIdResponse - Record Class in com.github.copilot.sdk.json
-
Internal response object from getting the last session ID.
- GetLastSessionIdResponse(String) - Constructor for record class com.github.copilot.sdk.json.GetLastSessionIdResponse
-
Creates an instance of a
GetLastSessionIdResponserecord class. - getLimits() - Method in class com.github.copilot.sdk.json.ModelCapabilities
- getLimits() - Method in class com.github.copilot.sdk.json.ModelCapabilitiesOverride
-
Gets the token limit overrides.
- getLogin() - Method in class com.github.copilot.sdk.json.GetAuthStatusResponse
- getLogLevel() - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Gets the log level for the CLI process.
- getMaxContextWindowTokens() - Method in class com.github.copilot.sdk.json.ModelCapabilitiesOverride.Limits
-
Gets the maximum context window tokens override.
- getMaxContextWindowTokens() - Method in class com.github.copilot.sdk.json.ModelLimits
- getMaxLength() - Method in class com.github.copilot.sdk.json.InputOptions
-
Gets the maximum character length.
- getMaxOutputTokens() - Method in class com.github.copilot.sdk.json.ModelCapabilitiesOverride.Limits
-
Gets the maximum output tokens override.
- getMaxPromptImages() - Method in class com.github.copilot.sdk.json.ModelVisionLimits
- getMaxPromptImageSize() - Method in class com.github.copilot.sdk.json.ModelVisionLimits
- getMaxPromptTokens() - Method in class com.github.copilot.sdk.json.ModelCapabilitiesOverride.Limits
-
Gets the maximum prompt tokens override.
- getMaxPromptTokens() - Method in class com.github.copilot.sdk.json.ModelLimits
- getMcpServers() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets MCP servers.
- getMcpServers() - Method in class com.github.copilot.sdk.json.CustomAgentConfig
-
Gets the MCP server configurations for this agent.
- getMcpServers() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the MCP server configurations.
- getMcpServers() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets MCP servers.
- getMcpServers() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the MCP server configurations.
- getMessage() - Method in class com.github.copilot.sdk.json.ElicitationContext
-
Gets the message describing what information is needed from the user.
- getMessage() - Method in class com.github.copilot.sdk.json.ElicitationParams
-
Gets the message describing what information is needed from the user.
- getMessage() - Method in class com.github.copilot.sdk.json.JsonRpcError
-
Gets the error message.
- getMessages() - Method in class com.github.copilot.sdk.CopilotSession
-
Gets the complete list of messages and events in the session.
- GetMessagesResponse - Record Class in com.github.copilot.sdk.json
-
Internal response object from getting session messages.
- GetMessagesResponse(List<JsonNode>) - Constructor for record class com.github.copilot.sdk.json.GetMessagesResponse
-
Creates an instance of a
GetMessagesResponserecord class. - getMetadata() - Method in class com.github.copilot.sdk.json.SessionLifecycleEvent
- getMethod() - Method in class com.github.copilot.sdk.json.JsonRpcRequest
-
Gets the method name.
- getMetrics() - Method in class com.github.copilot.sdk.generated.rpc.SessionUsageApi
-
Invokes
session.usage.getMetrics. - getMimeType() - Method in class com.github.copilot.sdk.json.BlobAttachment
-
Gets the MIME type of the binary content.
- getMinLength() - Method in class com.github.copilot.sdk.json.InputOptions
-
Gets the minimum character length.
- getMode() - Method in class com.github.copilot.sdk.json.ElicitationContext
-
Gets the elicitation mode:
"form"for structured input,"url"for browser redirect. - getMode() - Method in class com.github.copilot.sdk.json.MessageOptions
-
Gets the delivery mode.
- getMode() - Method in class com.github.copilot.sdk.json.SendMessageRequest
-
Gets the mode.
- getMode() - Method in class com.github.copilot.sdk.json.SystemMessageConfig
-
Gets the system message mode.
- getModel() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets the model name.
- getModel() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the AI model to use.
- getModel() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets the model name.
- getModel() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the AI model to use.
- getModelCapabilities() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets the model capabilities override.
- getModelCapabilities() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the model capabilities override.
- getModelCapabilities() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets the model capabilities override.
- getModelCapabilities() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the model capabilities override.
- getModels() - Method in class com.github.copilot.sdk.json.GetModelsResponse
- GetModelsResponse - Class in com.github.copilot.sdk.json
-
Response from the models.list RPC call.
- GetModelsResponse() - Constructor for class com.github.copilot.sdk.json.GetModelsResponse
- getModifiedTime() - Method in class com.github.copilot.sdk.json.SessionMetadata
-
Gets the timestamp when the session was last modified.
- getMultiplier() - Method in class com.github.copilot.sdk.json.ModelBilling
- getName() - Method in class com.github.copilot.sdk.json.AgentInfo
-
Gets the unique identifier of the agent.
- getName() - Method in class com.github.copilot.sdk.json.CommandDefinition
-
Gets the command name (without leading
/). - getName() - Method in class com.github.copilot.sdk.json.CommandWireDefinition
-
Gets the command name.
- getName() - Method in class com.github.copilot.sdk.json.CustomAgentConfig
-
Gets the unique identifier name for this agent.
- getName() - Method in class com.github.copilot.sdk.json.ModelInfo
- getOnElicitationRequest() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the elicitation request handler.
- getOnElicitationRequest() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the elicitation request handler.
- getOnEvent() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the event handler registered before the session.resume RPC is issued.
- getOnEvent() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the event handler registered before the session.create RPC is issued.
- getOnListModels() - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Gets the custom handler for listing available models.
- getOnPermissionRequest() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the permission request handler.
- getOnPermissionRequest() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the permission request handler.
- getOnPostToolUse() - Method in class com.github.copilot.sdk.json.SessionHooks
-
Gets the post-tool-use handler.
- getOnPreToolUse() - Method in class com.github.copilot.sdk.json.SessionHooks
-
Gets the pre-tool-use handler.
- getOnSessionEnd() - Method in class com.github.copilot.sdk.json.SessionHooks
-
Gets the session-end handler.
- getOnSessionStart() - Method in class com.github.copilot.sdk.json.SessionHooks
-
Gets the session-start handler.
- getOnUserInputRequest() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the user input request handler.
- getOnUserInputRequest() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the user input request handler.
- getOnUserPromptSubmitted() - Method in class com.github.copilot.sdk.json.SessionHooks
-
Gets the user-prompt-submitted handler.
- getOtlpEndpoint() - Method in class com.github.copilot.sdk.json.TelemetryConfig
-
Gets the OTLP exporter endpoint URL.
- getParams() - Method in class com.github.copilot.sdk.json.JsonRpcRequest
-
Gets the method parameters.
- getParentId() - Method in class com.github.copilot.sdk.generated.SessionEvent
- getPolicy() - Method in class com.github.copilot.sdk.json.ModelInfo
- getPort() - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Gets the TCP port for the CLI server.
- getPrompt() - Method in class com.github.copilot.sdk.json.CustomAgentConfig
-
Gets the system prompt for this agent.
- getPrompt() - Method in class com.github.copilot.sdk.json.MessageOptions
-
Gets the message prompt.
- getPrompt() - Method in class com.github.copilot.sdk.json.SendMessageRequest
-
Gets the message prompt.
- getProperties() - Method in class com.github.copilot.sdk.json.ElicitationSchema
-
Gets the form field definitions, keyed by field name.
- getProtocolVersion() - Method in class com.github.copilot.sdk.json.GetStatusResponse
- getProvider() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets the provider config.
- getProvider() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the custom API provider configuration.
- getProvider() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets the provider config.
- getProvider() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the custom API provider configuration.
- getQuestion() - Method in class com.github.copilot.sdk.json.UserInputRequest
-
Gets the question to ask the user.
- getQuota() - Method in class com.github.copilot.sdk.generated.rpc.ServerAccountApi
-
Invokes
account.getQuota. - getReasoningEffort() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets the reasoning effort.
- getReasoningEffort() - Method in class com.github.copilot.sdk.json.ModelCapabilitiesOverride.Supports
-
Gets the reasoning effort override.
- getReasoningEffort() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the reasoning effort level.
- getReasoningEffort() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets the reasoning effort.
- getReasoningEffort() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the reasoning effort level.
- getRepository() - Method in class com.github.copilot.sdk.json.SessionContext
-
Gets the GitHub repository in "owner/repo" format.
- getRequestedSchema() - Method in class com.github.copilot.sdk.json.ElicitationContext
-
Gets the JSON Schema describing the form fields to present (form mode only).
- getRequestedSchema() - Method in class com.github.copilot.sdk.json.ElicitationParams
-
Gets the JSON Schema describing the form fields to present.
- getRequestElicitation() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets the requestElicitation flag.
- getRequestElicitation() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets the requestElicitation flag.
- getRequestHeaders() - Method in class com.github.copilot.sdk.json.MessageOptions
-
Gets the custom per-turn HTTP headers for outbound model requests.
- getRequestHeaders() - Method in class com.github.copilot.sdk.json.SendMessageRequest
-
Gets the per-turn request headers.
- getRequestPermission() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets request permission flag.
- getRequestPermission() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets request permission flag.
- getRequestUserInput() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets request user input flag.
- getRequestUserInput() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets request user input flag.
- getRequired() - Method in class com.github.copilot.sdk.json.ElicitationSchema
-
Gets the list of required field names.
- getResult() - Method in class com.github.copilot.sdk.json.JsonRpcResponse
-
Gets the result of the RPC call.
- getRpc() - Method in class com.github.copilot.sdk.CopilotClient
-
Returns the typed RPC client for server-level methods.
- getRpc() - Method in class com.github.copilot.sdk.CopilotSession
-
Returns the typed RPC client for this session.
- getRules() - Method in class com.github.copilot.sdk.json.PermissionRequestResult
-
Gets the approval rules.
- getSections() - Method in class com.github.copilot.sdk.json.SystemMessageConfig
-
Gets the section-level overrides for
SystemMessageMode.CUSTOMIZEmode. - getSessionId() - Method in class com.github.copilot.sdk.CopilotSession
-
Gets the unique identifier for this session.
- getSessionId() - Method in class com.github.copilot.sdk.json.CommandContext
-
Gets the session ID where the command was invoked.
- getSessionId() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets the session ID.
- getSessionId() - Method in class com.github.copilot.sdk.json.ElicitationContext
-
Gets the session ID that triggered the elicitation request.
- getSessionId() - Method in class com.github.copilot.sdk.json.HookInvocation
-
Gets the session ID.
- getSessionId() - Method in class com.github.copilot.sdk.json.PermissionInvocation
-
Gets the session ID where the permission was requested.
- getSessionId() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets the session ID.
- getSessionId() - Method in class com.github.copilot.sdk.json.SendMessageRequest
-
Gets the session ID.
- getSessionId() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the custom session ID.
- getSessionId() - Method in class com.github.copilot.sdk.json.SessionLifecycleEvent
- getSessionId() - Method in class com.github.copilot.sdk.json.SessionMetadata
-
Gets the unique identifier for this session.
- getSessionId() - Method in class com.github.copilot.sdk.json.ToolInvocation
-
Gets the session ID where the tool was invoked.
- getSessionId() - Method in class com.github.copilot.sdk.json.UserInputInvocation
-
Gets the session ID.
- getSessionIdleTimeoutSeconds() - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Gets the server-wide idle timeout for sessions in seconds.
- getSessionMetadata(String) - Method in class com.github.copilot.sdk.CopilotClient
-
Gets metadata for a specific session by ID.
- GetSessionMetadataResponse - Record Class in com.github.copilot.sdk.json
-
Internal response object from getting session metadata by ID.
- GetSessionMetadataResponse(SessionMetadata) - Constructor for record class com.github.copilot.sdk.json.GetSessionMetadataResponse
-
Creates an instance of a
GetSessionMetadataResponserecord class. - getSkillDirectories() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets skill directories.
- getSkillDirectories() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the skill directories.
- getSkillDirectories() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets skill directories.
- getSkillDirectories() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the skill directories.
- getSkills() - Method in class com.github.copilot.sdk.json.CustomAgentConfig
-
Gets the list of skill names to preload into this agent's context.
- getSourceName() - Method in class com.github.copilot.sdk.json.TelemetryConfig
-
Gets the source name for telemetry spans.
- getSources() - Method in class com.github.copilot.sdk.generated.rpc.SessionInstructionsApi
-
Invokes
session.instructions.getSources. - getStartTime() - Method in class com.github.copilot.sdk.json.SessionMetadata
-
Gets the timestamp when the session was created.
- getState() - Method in class com.github.copilot.sdk.CopilotClient
-
Gets the current connection state.
- getState() - Method in class com.github.copilot.sdk.json.ModelPolicy
- getStatus() - Method in class com.github.copilot.sdk.CopilotClient
-
Gets CLI status including version and protocol information.
- getStatus() - Method in class com.github.copilot.sdk.generated.rpc.SessionAuthApi
-
Invokes
session.auth.getStatus. - getStatusMessage() - Method in class com.github.copilot.sdk.json.GetAuthStatusResponse
- GetStatusResponse - Class in com.github.copilot.sdk.json
-
Response from the status.get RPC call.
- GetStatusResponse() - Constructor for class com.github.copilot.sdk.json.GetStatusResponse
- getStreaming() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets streaming flag.
- getStreaming() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets streaming flag.
- getSummary() - Method in class com.github.copilot.sdk.json.SessionMetadata
-
Gets a brief summary of the session's conversation.
- getSupportedMediaTypes() - Method in class com.github.copilot.sdk.json.ModelVisionLimits
- getSupportedReasoningEfforts() - Method in class com.github.copilot.sdk.json.ModelInfo
-
Gets the supported reasoning effort levels.
- getSupports() - Method in class com.github.copilot.sdk.json.ModelCapabilities
- getSupports() - Method in class com.github.copilot.sdk.json.ModelCapabilitiesOverride
-
Gets the feature flag overrides.
- getSystemMessage() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets the system message config.
- getSystemMessage() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the system message configuration.
- getSystemMessage() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets the system message config.
- getSystemMessage() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the system message configuration.
- getTelemetry() - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Gets the OpenTelemetry configuration for the CLI server.
- getTerms() - Method in class com.github.copilot.sdk.json.ModelPolicy
- getTimeout() - Method in class com.github.copilot.sdk.json.McpServerConfig
-
Gets the optional timeout in milliseconds for tool calls to this server.
- getTimestamp() - Method in class com.github.copilot.sdk.generated.SessionEvent
- getTimestamp() - Method in class com.github.copilot.sdk.json.PostToolUseHookInput
-
Gets the timestamp of the hook invocation.
- getTimestamp() - Method in class com.github.copilot.sdk.json.PreToolUseHookInput
-
Gets the timestamp of the hook invocation.
- getTitle() - Method in class com.github.copilot.sdk.json.InputOptions
-
Gets the title label for the input field.
- getToolArgs() - Method in class com.github.copilot.sdk.json.PostToolUseHookInput
-
Gets the arguments passed to the tool.
- getToolArgs() - Method in class com.github.copilot.sdk.json.PreToolUseHookInput
-
Gets the arguments passed to the tool.
- getToolCallId() - Method in class com.github.copilot.sdk.json.PermissionRequest
-
Gets the associated tool call ID, if applicable.
- getToolCallId() - Method in class com.github.copilot.sdk.json.ToolInvocation
-
Gets the unique identifier for this tool call.
- getToolName() - Method in class com.github.copilot.sdk.json.PostToolUseHookInput
-
Gets the name of the tool that was invoked.
- getToolName() - Method in class com.github.copilot.sdk.json.PreToolUseHookInput
-
Gets the name of the tool being invoked.
- getToolName() - Method in class com.github.copilot.sdk.json.ToolInvocation
-
Gets the name of the tool being invoked.
- getToolResult() - Method in class com.github.copilot.sdk.json.PostToolUseHookInput
-
Gets the result returned by the tool.
- getTools() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets the tools.
- getTools() - Method in class com.github.copilot.sdk.json.CustomAgentConfig
-
Gets the list of tool names available to this agent.
- getTools() - Method in class com.github.copilot.sdk.json.McpServerConfig
-
Gets the list of tools to include from this server.
- getTools() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the custom tools for this session.
- getTools() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets the tools.
- getTools() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the custom tools for this session.
- getTransform() - Method in class com.github.copilot.sdk.json.SectionOverride
-
Gets the transform callback.
- getType() - Method in class com.github.copilot.sdk.generated.AbortEvent
- getType() - Method in class com.github.copilot.sdk.generated.AssistantIntentEvent
- getType() - Method in class com.github.copilot.sdk.generated.AssistantMessageDeltaEvent
- getType() - Method in class com.github.copilot.sdk.generated.AssistantMessageEvent
- getType() - Method in class com.github.copilot.sdk.generated.AssistantReasoningDeltaEvent
- getType() - Method in class com.github.copilot.sdk.generated.AssistantReasoningEvent
- getType() - Method in class com.github.copilot.sdk.generated.AssistantStreamingDeltaEvent
- getType() - Method in class com.github.copilot.sdk.generated.AssistantTurnEndEvent
- getType() - Method in class com.github.copilot.sdk.generated.AssistantTurnStartEvent
- getType() - Method in class com.github.copilot.sdk.generated.AssistantUsageEvent
- getType() - Method in class com.github.copilot.sdk.generated.AutoModeSwitchCompletedEvent
- getType() - Method in class com.github.copilot.sdk.generated.AutoModeSwitchRequestedEvent
- getType() - Method in class com.github.copilot.sdk.generated.CapabilitiesChangedEvent
- getType() - Method in class com.github.copilot.sdk.generated.CommandCompletedEvent
- getType() - Method in class com.github.copilot.sdk.generated.CommandExecuteEvent
- getType() - Method in class com.github.copilot.sdk.generated.CommandQueuedEvent
- getType() - Method in class com.github.copilot.sdk.generated.CommandsChangedEvent
- getType() - Method in class com.github.copilot.sdk.generated.ElicitationCompletedEvent
- getType() - Method in class com.github.copilot.sdk.generated.ElicitationRequestedEvent
- getType() - Method in class com.github.copilot.sdk.generated.ExitPlanModeCompletedEvent
- getType() - Method in class com.github.copilot.sdk.generated.ExitPlanModeRequestedEvent
- getType() - Method in class com.github.copilot.sdk.generated.ExternalToolCompletedEvent
- getType() - Method in class com.github.copilot.sdk.generated.ExternalToolRequestedEvent
- getType() - Method in class com.github.copilot.sdk.generated.HookEndEvent
- getType() - Method in class com.github.copilot.sdk.generated.HookStartEvent
- getType() - Method in class com.github.copilot.sdk.generated.McpOauthCompletedEvent
- getType() - Method in class com.github.copilot.sdk.generated.McpOauthRequiredEvent
- getType() - Method in class com.github.copilot.sdk.generated.PendingMessagesModifiedEvent
- getType() - Method in class com.github.copilot.sdk.generated.PermissionCompletedEvent
- getType() - Method in class com.github.copilot.sdk.generated.PermissionRequestedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SamplingCompletedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SamplingRequestedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionBackgroundTasksChangedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionCompactionStartEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionContextChangedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionCustomAgentsUpdatedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionErrorEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionEvent
-
Returns the event-type discriminator string (e.g.,
"session.idle"). - getType() - Method in class com.github.copilot.sdk.generated.SessionExtensionsLoadedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionHandoffEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionIdleEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionInfoEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionMcpServersLoadedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionMcpServerStatusChangedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionModeChangedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionModelChangeEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionPlanChangedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionRemoteSteerableChangedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionResumeEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionShutdownEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionSkillsLoadedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionSnapshotRewindEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionStartEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionTaskCompleteEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionTitleChangedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionToolsUpdatedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionTruncationEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionUsageInfoEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionWarningEvent
- getType() - Method in class com.github.copilot.sdk.generated.SessionWorkspaceFileChangedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SkillInvokedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SubagentCompletedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SubagentDeselectedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SubagentFailedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SubagentSelectedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SubagentStartedEvent
- getType() - Method in class com.github.copilot.sdk.generated.SystemMessageEvent
- getType() - Method in class com.github.copilot.sdk.generated.SystemNotificationEvent
- getType() - Method in class com.github.copilot.sdk.generated.ToolExecutionCompleteEvent
- getType() - Method in class com.github.copilot.sdk.generated.ToolExecutionPartialResultEvent
- getType() - Method in class com.github.copilot.sdk.generated.ToolExecutionProgressEvent
- getType() - Method in class com.github.copilot.sdk.generated.ToolExecutionStartEvent
- getType() - Method in class com.github.copilot.sdk.generated.ToolUserRequestedEvent
- getType() - Method in class com.github.copilot.sdk.generated.UnknownSessionEvent
- getType() - Method in class com.github.copilot.sdk.generated.UserInputCompletedEvent
- getType() - Method in class com.github.copilot.sdk.generated.UserInputRequestedEvent
- getType() - Method in class com.github.copilot.sdk.generated.UserMessageEvent
- getType() - Method in record class com.github.copilot.sdk.json.Attachment
- getType() - Method in class com.github.copilot.sdk.json.BlobAttachment
-
Returns the attachment type, always
"blob". - getType() - Method in class com.github.copilot.sdk.json.ElicitationSchema
-
Gets the schema type indicator (always
"object"). - getType() - Method in class com.github.copilot.sdk.json.McpHttpServerConfig
-
Gets the server type discriminator.
- getType() - Method in class com.github.copilot.sdk.json.McpStdioServerConfig
-
Gets the server type discriminator.
- getType() - Method in interface com.github.copilot.sdk.json.MessageAttachment
-
Returns the attachment type discriminator (e.g., "file", "blob").
- getType() - Method in class com.github.copilot.sdk.json.ProviderConfig
-
Gets the provider type.
- getType() - Method in class com.github.copilot.sdk.json.SessionLifecycleEvent
- getUi() - Method in class com.github.copilot.sdk.CopilotSession
-
Gets the UI API for eliciting information from the user during this session.
- getUi() - Method in class com.github.copilot.sdk.json.SessionCapabilities
-
Gets the UI-related capabilities.
- getUrl() - Method in class com.github.copilot.sdk.json.ElicitationContext
-
Gets the URL to open in the user's browser (url mode only).
- getUrl() - Method in class com.github.copilot.sdk.json.McpHttpServerConfig
-
Gets the URL of the remote server.
- getUseLoggedInUser() - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Returns whether to use the logged-in user for authentication.
- getValue() - Method in enum class com.github.copilot.sdk.generated.AssistantMessageToolRequestType
- getValue() - Method in enum class com.github.copilot.sdk.generated.ElicitationCompletedAction
- getValue() - Method in enum class com.github.copilot.sdk.generated.ElicitationRequestedMode
- getValue() - Method in enum class com.github.copilot.sdk.generated.ExtensionsLoadedExtensionSource
- getValue() - Method in enum class com.github.copilot.sdk.generated.ExtensionsLoadedExtensionStatus
- getValue() - Method in enum class com.github.copilot.sdk.generated.HandoffSourceType
- getValue() - Method in enum class com.github.copilot.sdk.generated.McpServersLoadedServerStatus
- getValue() - Method in enum class com.github.copilot.sdk.generated.McpServerStatusChangedStatus
- getValue() - Method in enum class com.github.copilot.sdk.generated.PermissionCompletedKind
- getValue() - Method in enum class com.github.copilot.sdk.generated.PlanChangedOperation
- getValue() - Method in enum class com.github.copilot.sdk.generated.rpc.AuthInfoType
- getValue() - Method in enum class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServerSource
- getValue() - Method in enum class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServerType
- getValue() - Method in enum class com.github.copilot.sdk.generated.rpc.ExtensionSource
- getValue() - Method in enum class com.github.copilot.sdk.generated.rpc.ExtensionStatus
- getValue() - Method in enum class com.github.copilot.sdk.generated.rpc.InstructionsSourcesLocation
- getValue() - Method in enum class com.github.copilot.sdk.generated.rpc.InstructionsSourcesType
- getValue() - Method in enum class com.github.copilot.sdk.generated.rpc.McpServerSource
- getValue() - Method in enum class com.github.copilot.sdk.generated.rpc.McpServerStatus
- getValue() - Method in enum class com.github.copilot.sdk.generated.rpc.SessionFsErrorCode
- getValue() - Method in enum class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesEntryType
- getValue() - Method in enum class com.github.copilot.sdk.generated.rpc.SessionFsSetProviderConventions
- getValue() - Method in enum class com.github.copilot.sdk.generated.rpc.SessionLogLevel
- getValue() - Method in enum class com.github.copilot.sdk.generated.rpc.SessionMode
- getValue() - Method in enum class com.github.copilot.sdk.generated.rpc.SessionModeGetResult.SessionModeGetResultMode
- getValue() - Method in enum class com.github.copilot.sdk.generated.rpc.SessionModeSetResult.SessionModeSetResultMode
- getValue() - Method in enum class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace.SessionWorkspacesGetWorkspaceResultWorkspaceHostType
- getValue() - Method in enum class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace.SessionWorkspacesGetWorkspaceResultWorkspaceSessionSyncLevel
- getValue() - Method in enum class com.github.copilot.sdk.generated.rpc.ShellKillSignal
- getValue() - Method in enum class com.github.copilot.sdk.generated.rpc.UIElicitationResponseAction
- getValue() - Method in enum class com.github.copilot.sdk.generated.ShutdownType
- getValue() - Method in enum class com.github.copilot.sdk.generated.SystemMessageRole
- getValue() - Method in enum class com.github.copilot.sdk.generated.UserMessageAgentMode
- getValue() - Method in enum class com.github.copilot.sdk.generated.WorkingDirectoryContextHostType
- getValue() - Method in enum class com.github.copilot.sdk.generated.WorkspaceFileChangedOperation
- getValue() - Method in enum class com.github.copilot.sdk.json.ElicitationResultAction
-
Returns the wire-format string value.
- getValue() - Method in class com.github.copilot.sdk.json.PermissionRequestResultKind
-
Returns the underlying string value of this kind.
- getValue() - Method in enum class com.github.copilot.sdk.json.SectionOverrideAction
-
Returns the JSON value for this action.
- getValue() - Method in enum class com.github.copilot.sdk.SystemMessageMode
-
Returns the JSON value for this mode.
- getVersion() - Method in class com.github.copilot.sdk.json.GetStatusResponse
- getVersionNumber() - Method in enum class com.github.copilot.sdk.SdkProtocolVersion
- getVision() - Method in class com.github.copilot.sdk.json.ModelCapabilitiesOverride.Supports
-
Gets the vision override.
- getVision() - Method in class com.github.copilot.sdk.json.ModelLimits
- getWireApi() - Method in class com.github.copilot.sdk.json.ProviderConfig
-
Gets the wire API format.
- getWorkingDirectory() - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Gets working directory.
- getWorkingDirectory() - Method in class com.github.copilot.sdk.json.McpStdioServerConfig
-
Gets the working directory for the server process.
- getWorkingDirectory() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Gets the working directory for the session.
- getWorkingDirectory() - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Gets working directory.
- getWorkingDirectory() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Gets the working directory for the session.
- getWorkspace() - Method in class com.github.copilot.sdk.generated.rpc.SessionWorkspacesApi
-
Invokes
session.workspaces.getWorkspace. - getWorkspacePath() - Method in class com.github.copilot.sdk.CopilotSession
-
Gets the path to the session workspace directory when infinite sessions are enabled.
- GH_CLI - Enum constant in enum class com.github.copilot.sdk.generated.rpc.AuthInfoType
-
The
gh-clivariant. - GITHUB - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace.SessionWorkspacesGetWorkspaceResultWorkspaceHostType
-
The
githubvariant. - GITHUB - Enum constant in enum class com.github.copilot.sdk.generated.WorkingDirectoryContextHostType
-
The
githubvariant. - gitRoot() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
-
Returns the value of the
gitRootrecord component. - gitRoot() - Method in record class com.github.copilot.sdk.generated.SessionContextChangedEvent.SessionContextChangedEventData
-
Returns the value of the
gitRootrecord component. - gitRoot() - Method in record class com.github.copilot.sdk.generated.WorkingDirectoryContext
-
Returns the value of the
gitRootrecord component. - GUIDELINES - Static variable in class com.github.copilot.sdk.json.SystemPromptSections
-
Tips, behavioral best practices, behavioral guidelines.
H
- handle(CommandContext) - Method in interface com.github.copilot.sdk.json.CommandHandler
-
Handles a slash-command execution.
- handle(ElicitationContext) - Method in interface com.github.copilot.sdk.json.ElicitationHandler
-
Handles an elicitation request from the server.
- handle(PermissionRequest, PermissionInvocation) - Method in interface com.github.copilot.sdk.json.PermissionHandler
-
Handles a permission request from the assistant.
- handle(PostToolUseHookInput, HookInvocation) - Method in interface com.github.copilot.sdk.json.PostToolUseHandler
-
Handles a post-tool-use hook invocation.
- handle(PreToolUseHookInput, HookInvocation) - Method in interface com.github.copilot.sdk.json.PreToolUseHandler
-
Handles a pre-tool-use hook invocation.
- handle(SessionEndHookInput, HookInvocation) - Method in interface com.github.copilot.sdk.json.SessionEndHandler
-
Handles a session end event.
- handle(SessionStartHookInput, HookInvocation) - Method in interface com.github.copilot.sdk.json.SessionStartHandler
-
Handles a session start event.
- handle(UserInputRequest, UserInputInvocation) - Method in interface com.github.copilot.sdk.json.UserInputHandler
-
Handles a user input request from the agent.
- handle(UserPromptSubmittedHookInput, HookInvocation) - Method in interface com.github.copilot.sdk.json.UserPromptSubmittedHandler
-
Handles a user prompt submission event.
- handleError(SessionEvent, Exception) - Method in interface com.github.copilot.sdk.EventErrorHandler
-
Called when an event handler throws an exception during event dispatch.
- handlePendingCommand(SessionCommandsHandlePendingCommandParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionCommandsApi
-
Invokes
session.commands.handlePendingCommand. - handlePendingElicitation(SessionUiHandlePendingElicitationParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionUiApi
-
Invokes
session.ui.handlePendingElicitation. - handlePendingPermissionRequest(SessionPermissionsHandlePendingPermissionRequestParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionPermissionsApi
-
Invokes
session.permissions.handlePendingPermissionRequest. - handlePendingToolCall(SessionToolsHandlePendingToolCallParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionToolsApi
-
Invokes
session.tools.handlePendingToolCall. - handler() - Method in record class com.github.copilot.sdk.json.ToolDefinition
-
Returns the value of the
handlerrecord component. - HandoffRepository - Record Class in com.github.copilot.sdk.generated
-
Repository context for the handed-off session
- HandoffRepository(String, String, String) - Constructor for record class com.github.copilot.sdk.generated.HandoffRepository
-
Creates an instance of a
HandoffRepositoryrecord class. - HandoffSourceType - Enum Class in com.github.copilot.sdk.generated
-
Origin type of the session being handed off
- handoffTime() - Method in record class com.github.copilot.sdk.generated.SessionHandoffEvent.SessionHandoffEventData
-
Returns the value of the
handoffTimerecord component. - hashCode() - Method in record class com.github.copilot.sdk.generated.AbortEvent.AbortEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.AssistantIntentEvent.AssistantIntentEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.AssistantMessageDeltaEvent.AssistantMessageDeltaEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.AssistantMessageEvent.AssistantMessageEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.AssistantMessageToolRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.AssistantReasoningDeltaEvent.AssistantReasoningDeltaEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.AssistantReasoningEvent.AssistantReasoningEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.AssistantStreamingDeltaEvent.AssistantStreamingDeltaEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.AssistantTurnEndEvent.AssistantTurnEndEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.AssistantTurnStartEvent.AssistantTurnStartEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.AssistantUsageCopilotUsage
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.AssistantUsageCopilotUsageTokenDetail
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.AssistantUsageEvent.AssistantUsageEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.AssistantUsageQuotaSnapshot
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.AutoModeSwitchCompletedEvent.AutoModeSwitchCompletedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.AutoModeSwitchRequestedEvent.AutoModeSwitchRequestedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.CapabilitiesChangedEvent.CapabilitiesChangedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.CapabilitiesChangedUI
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.CommandCompletedEvent.CommandCompletedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.CommandExecuteEvent.CommandExecuteEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.CommandQueuedEvent.CommandQueuedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.CommandsChangedCommand
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.CommandsChangedEvent.CommandsChangedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsed
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsedCopilotUsage
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.CustomAgentsUpdatedAgent
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.ElicitationCompletedEvent.ElicitationCompletedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.ElicitationRequestedEvent.ElicitationRequestedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.ElicitationRequestedSchema
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.ExitPlanModeCompletedEvent.ExitPlanModeCompletedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.ExitPlanModeRequestedEvent.ExitPlanModeRequestedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.ExtensionsLoadedExtension
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.ExternalToolCompletedEvent.ExternalToolCompletedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.ExternalToolRequestedEvent.ExternalToolRequestedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.HandoffRepository
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.HookEndError
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.HookEndEvent.HookEndEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.HookStartEvent.HookStartEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.McpOauthCompletedEvent.McpOauthCompletedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.McpOauthRequiredEvent.McpOauthRequiredEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.McpOauthRequiredStaticClientConfig
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.McpServersLoadedServer
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.PendingMessagesModifiedEvent.PendingMessagesModifiedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.PermissionCompletedEvent.PermissionCompletedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.PermissionCompletedResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.PermissionRequestedEvent.PermissionRequestedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.AccountGetQuotaResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.AccountQuotaSnapshot
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.AgentInfo
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServer
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.Extension
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.HistoryCompactContextWindow
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.InstructionsSources
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigAddParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigDisableParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigEnableParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigListResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigRemoveParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigUpdateParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.McpDiscoverParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.McpDiscoverResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.McpServer
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.Model
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.ModelBilling
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilities
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesLimits
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesLimitsVision
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverride
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverrideLimits
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverrideLimitsVision
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverrideSupports
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesSupports
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.ModelPolicy
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.ModelsListResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.PingParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.PingResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.Plugin
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.ServerSkill
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentDeselectParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentDeselectResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentGetCurrentParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentGetCurrentResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentListParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentListResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentReloadParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentReloadResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentSelectParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentSelectResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAuthGetStatusParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAuthGetStatusResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionCommandsHandlePendingCommandParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionCommandsHandlePendingCommandResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsDisableParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsDisableResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsEnableParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsEnableResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsListParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsListResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsReloadParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsReloadResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFleetStartParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFleetStartResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsAppendFileParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsError
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsExistsParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsExistsResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsMkdirParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesEntry
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReadFileParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReadFileResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsRenameParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsRmParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsSetProviderParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsSetProviderResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsStatParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsStatResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsWriteFileParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionHistoryCompactParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionHistoryCompactResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionHistoryTruncateParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionHistoryTruncateResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionInstructionsGetSourcesParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionInstructionsGetSourcesResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionLogParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionLogResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpDisableParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpDisableResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpEnableParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpEnableResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpListParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpListResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpOauthLoginParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpOauthLoginResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpReloadParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpReloadResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModeGetParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModeGetResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModelGetCurrentParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModelGetCurrentResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModelSwitchToParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModelSwitchToResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModeSetParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModeSetResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionNameGetParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionNameGetResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionNameSetParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsHandlePendingPermissionRequestParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsHandlePendingPermissionRequestResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsResetSessionApprovalsParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsResetSessionApprovalsResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsSetApproveAllParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsSetApproveAllResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanDeleteParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanDeleteResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanReadParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanReadResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanUpdateParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanUpdateResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPluginsListParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPluginsListResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionsForkParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionsForkResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionShellExecParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionShellExecResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionShellKillParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionShellKillResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsDisableParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsDisableResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsEnableParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsEnableResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsListParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsListResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsReloadParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsReloadResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionToolsHandlePendingToolCallParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionToolsHandlePendingToolCallResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUiElicitationParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUiElicitationResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUiHandlePendingElicitationParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUiHandlePendingElicitationResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUsageGetMetricsParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUsageGetMetricsResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceCreateFileParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceCreateFileResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceListFilesParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceListFilesResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceReadFileParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceReadFileResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesCreateFileParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesListFilesParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesListFilesResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesReadFileParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesReadFileResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.Skill
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SkillsConfigSetDisabledSkillsParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SkillsDiscoverParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.SkillsDiscoverResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.Tool
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.ToolsListParams
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.ToolsListResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.UIElicitationResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.UIElicitationSchema
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsCodeChanges
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsModelMetric
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsModelMetricRequests
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsModelMetricUsage
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SamplingCompletedEvent.SamplingCompletedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SamplingRequestedEvent.SamplingRequestedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionBackgroundTasksChangedEvent.SessionBackgroundTasksChangedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent.SessionCompactionCompleteEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionCompactionStartEvent.SessionCompactionStartEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionContextChangedEvent.SessionContextChangedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionCustomAgentsUpdatedEvent.SessionCustomAgentsUpdatedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionErrorEvent.SessionErrorEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionExtensionsLoadedEvent.SessionExtensionsLoadedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionHandoffEvent.SessionHandoffEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionIdleEvent.SessionIdleEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionInfoEvent.SessionInfoEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionMcpServersLoadedEvent.SessionMcpServersLoadedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionMcpServerStatusChangedEvent.SessionMcpServerStatusChangedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionModeChangedEvent.SessionModeChangedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionModelChangeEvent.SessionModelChangeEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionPlanChangedEvent.SessionPlanChangedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionRemoteSteerableChangedEvent.SessionRemoteSteerableChangedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionResumeEvent.SessionResumeEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionShutdownEvent.SessionShutdownEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionSkillsLoadedEvent.SessionSkillsLoadedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionSnapshotRewindEvent.SessionSnapshotRewindEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionStartEvent.SessionStartEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionTaskCompleteEvent.SessionTaskCompleteEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionTitleChangedEvent.SessionTitleChangedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionToolsUpdatedEvent.SessionToolsUpdatedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionTruncationEvent.SessionTruncationEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionUsageInfoEvent.SessionUsageInfoEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionWarningEvent.SessionWarningEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SessionWorkspaceFileChangedEvent.SessionWorkspaceFileChangedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.ShutdownCodeChanges
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.ShutdownModelMetric
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.ShutdownModelMetricRequests
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.ShutdownModelMetricUsage
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SkillInvokedEvent.SkillInvokedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SkillsLoadedSkill
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SubagentCompletedEvent.SubagentCompletedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SubagentDeselectedEvent.SubagentDeselectedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SubagentFailedEvent.SubagentFailedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SubagentSelectedEvent.SubagentSelectedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SubagentStartedEvent.SubagentStartedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SystemMessageEvent.SystemMessageEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SystemMessageMetadata
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.SystemNotificationEvent.SystemNotificationEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteError
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteEvent.ToolExecutionCompleteEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.ToolExecutionPartialResultEvent.ToolExecutionPartialResultEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.ToolExecutionProgressEvent.ToolExecutionProgressEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.ToolExecutionStartEvent.ToolExecutionStartEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.ToolUserRequestedEvent.ToolUserRequestedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.UserInputCompletedEvent.UserInputCompletedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.UserInputRequestedEvent.UserInputRequestedEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.UserMessageEvent.UserMessageEventData
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.generated.WorkingDirectoryContext
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.Attachment
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.CreateSessionResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.DeleteSessionResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.GetForegroundSessionResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.GetLastSessionIdResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.GetMessagesResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.GetSessionMetadataResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.ListSessionsResponse
-
Returns a hash code value for this object.
- hashCode() - Method in class com.github.copilot.sdk.json.PermissionRequestResultKind
- hashCode() - Method in record class com.github.copilot.sdk.json.PingResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.PostToolUseHookOutput
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.PreToolUseHookOutput
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.ResumeSessionResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.SendMessageResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.SessionEndHookInput
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.SessionEndHookOutput
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.SessionLifecycleEventMetadata
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.SessionStartHookInput
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.SessionStartHookOutput
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.SetForegroundSessionResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.ToolBinaryResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.ToolDefinition
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.ToolResultObject
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookInput
-
Returns a hash code value for this object.
- hashCode() - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookOutput
-
Returns a hash code value for this object.
- hasHooks() - Method in class com.github.copilot.sdk.json.SessionHooks
-
Returns whether any hooks are registered.
- headCommit() - Method in record class com.github.copilot.sdk.generated.SessionContextChangedEvent.SessionContextChangedEventData
-
Returns the value of the
headCommitrecord component. - headCommit() - Method in record class com.github.copilot.sdk.generated.WorkingDirectoryContext
-
Returns the value of the
headCommitrecord component. - history - Variable in class com.github.copilot.sdk.generated.rpc.SessionRpc
-
API methods for the
historynamespace. - HistoryCompactContextWindow - Record Class in com.github.copilot.sdk.generated.rpc
-
Post-compaction context window usage breakdown
- HistoryCompactContextWindow(Long, Long, Long, Long, Long, Long) - Constructor for record class com.github.copilot.sdk.generated.rpc.HistoryCompactContextWindow
-
Creates an instance of a
HistoryCompactContextWindowrecord class. - HMAC - Enum constant in enum class com.github.copilot.sdk.generated.rpc.AuthInfoType
-
The
hmacvariant. - HOME - Enum constant in enum class com.github.copilot.sdk.generated.rpc.InstructionsSourcesType
-
The
homevariant. - HookEndError - Record Class in com.github.copilot.sdk.generated
-
Error details when the hook failed
- HookEndError(String, String) - Constructor for record class com.github.copilot.sdk.generated.HookEndError
-
Creates an instance of a
HookEndErrorrecord class. - HookEndEvent - Class in com.github.copilot.sdk.generated
-
The
hook.endsession event. - HookEndEvent() - Constructor for class com.github.copilot.sdk.generated.HookEndEvent
- HookEndEvent.HookEndEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
HookEndEvent. - HookEndEventData(String, String, Object, Boolean, HookEndError) - Constructor for record class com.github.copilot.sdk.generated.HookEndEvent.HookEndEventData
-
Creates an instance of a
HookEndEventDatarecord class. - HookInvocation - Class in com.github.copilot.sdk.json
-
Context for a hook invocation.
- HookInvocation() - Constructor for class com.github.copilot.sdk.json.HookInvocation
- hookInvocationId() - Method in record class com.github.copilot.sdk.generated.HookEndEvent.HookEndEventData
-
Returns the value of the
hookInvocationIdrecord component. - hookInvocationId() - Method in record class com.github.copilot.sdk.generated.HookStartEvent.HookStartEventData
-
Returns the value of the
hookInvocationIdrecord component. - HookStartEvent - Class in com.github.copilot.sdk.generated
-
The
hook.startsession event. - HookStartEvent() - Constructor for class com.github.copilot.sdk.generated.HookStartEvent
- HookStartEvent.HookStartEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
HookStartEvent. - HookStartEventData(String, String, Object) - Constructor for record class com.github.copilot.sdk.generated.HookStartEvent.HookStartEventData
-
Creates an instance of a
HookStartEventDatarecord class. - hookType() - Method in record class com.github.copilot.sdk.generated.HookEndEvent.HookEndEventData
-
Returns the value of the
hookTyperecord component. - hookType() - Method in record class com.github.copilot.sdk.generated.HookStartEvent.HookStartEventData
-
Returns the value of the
hookTyperecord component. - host() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAuthGetStatusResult
-
Returns the value of the
hostrecord component. - host() - Method in record class com.github.copilot.sdk.generated.SessionHandoffEvent.SessionHandoffEventData
-
Returns the value of the
hostrecord component. - hostType() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
-
Returns the value of the
hostTyperecord component. - hostType() - Method in record class com.github.copilot.sdk.generated.SessionContextChangedEvent.SessionContextChangedEventData
-
Returns the value of the
hostTyperecord component. - hostType() - Method in record class com.github.copilot.sdk.generated.WorkingDirectoryContext
-
Returns the value of the
hostTyperecord component. - HTTP - Enum constant in enum class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServerType
-
The
httpvariant.
I
- id() - Method in record class com.github.copilot.sdk.generated.CustomAgentsUpdatedAgent
-
Returns the value of the
idrecord component. - id() - Method in record class com.github.copilot.sdk.generated.ExtensionsLoadedExtension
-
Returns the value of the
idrecord component. - id() - Method in record class com.github.copilot.sdk.generated.rpc.Extension
-
Returns the value of the
idrecord component. - id() - Method in record class com.github.copilot.sdk.generated.rpc.InstructionsSources
-
Returns the value of the
idrecord component. - id() - Method in record class com.github.copilot.sdk.generated.rpc.Model
-
Returns the value of the
idrecord component. - id() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsDisableParams
-
Returns the value of the
idrecord component. - id() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsEnableParams
-
Returns the value of the
idrecord component. - id() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
-
Returns the value of the
idrecord component. - IDENTITY - Static variable in class com.github.copilot.sdk.json.SystemPromptSections
-
Agent identity preamble and mode statement.
- InfiniteSessionConfig - Class in com.github.copilot.sdk.json
-
Configuration for infinite sessions with automatic context compaction and workspace persistence.
- InfiniteSessionConfig() - Constructor for class com.github.copilot.sdk.json.InfiniteSessionConfig
- INFO - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionLogLevel
-
The
infovariant. - infoType() - Method in record class com.github.copilot.sdk.generated.SessionInfoEvent.SessionInfoEventData
-
Returns the value of the
infoTyperecord component. - initialCwd() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsSetProviderParams
-
Returns the value of the
initialCwdrecord component. - initialPrompt() - Method in record class com.github.copilot.sdk.json.SessionStartHookInput
-
Returns the value of the
initialPromptrecord component. - initiator() - Method in record class com.github.copilot.sdk.generated.AssistantUsageEvent.AssistantUsageEventData
-
Returns the value of the
initiatorrecord component. - input() - Method in record class com.github.copilot.sdk.generated.HookStartEvent.HookStartEventData
-
Returns the value of the
inputrecord component. - input(String, InputOptions) - Method in interface com.github.copilot.sdk.json.SessionUiApi
-
Shows a text input dialog.
- InputOptions - Class in com.github.copilot.sdk.json
-
Options for the
SessionUiApi.input(String, InputOptions)convenience method. - InputOptions() - Constructor for class com.github.copilot.sdk.json.InputOptions
- inputTokens() - Method in record class com.github.copilot.sdk.generated.AssistantUsageEvent.AssistantUsageEventData
-
Returns the value of the
inputTokensrecord component. - inputTokens() - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsed
-
Returns the value of the
inputTokensrecord component. - inputTokens() - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsModelMetricUsage
-
Returns the value of the
inputTokensrecord component. - inputTokens() - Method in record class com.github.copilot.sdk.generated.ShutdownModelMetricUsage
-
Returns the value of the
inputTokensrecord component. - instructions - Variable in class com.github.copilot.sdk.generated.rpc.SessionRpc
-
API methods for the
instructionsnamespace. - instructions() - Method in record class com.github.copilot.sdk.generated.rpc.Tool
-
Returns the value of the
instructionsrecord component. - InstructionsSources - Record Class in com.github.copilot.sdk.generated.rpc
- InstructionsSources(String, String, String, String, InstructionsSourcesType, InstructionsSourcesLocation, String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.InstructionsSources
-
Creates an instance of a
InstructionsSourcesrecord class. - InstructionsSourcesLocation - Enum Class in com.github.copilot.sdk.generated.rpc
-
Where this source lives — used for UI grouping
- InstructionsSourcesType - Enum Class in com.github.copilot.sdk.generated.rpc
-
Category of instruction source — used for merge logic
- intent() - Method in record class com.github.copilot.sdk.generated.AssistantIntentEvent.AssistantIntentEventData
-
Returns the value of the
intentrecord component. - intentionSummary() - Method in record class com.github.copilot.sdk.generated.AssistantMessageToolRequest
-
Returns the value of the
intentionSummaryrecord component. - interactionId() - Method in record class com.github.copilot.sdk.generated.AssistantMessageEvent.AssistantMessageEventData
-
Returns the value of the
interactionIdrecord component. - interactionId() - Method in record class com.github.copilot.sdk.generated.AssistantTurnStartEvent.AssistantTurnStartEventData
-
Returns the value of the
interactionIdrecord component. - interactionId() - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteEvent.ToolExecutionCompleteEventData
-
Returns the value of the
interactionIdrecord component. - interactionId() - Method in record class com.github.copilot.sdk.generated.UserMessageEvent.UserMessageEventData
-
Returns the value of the
interactionIdrecord component. - INTERACTIVE - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionMode
-
The
interactivevariant. - INTERACTIVE - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionModeGetResult.SessionModeGetResultMode
-
The
interactivevariant. - INTERACTIVE - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionModeSetResult.SessionModeSetResultMode
-
The
interactivevariant. - INTERACTIVE - Enum constant in enum class com.github.copilot.sdk.generated.UserMessageAgentMode
-
The
interactivevariant. - interTokenLatencyMs() - Method in record class com.github.copilot.sdk.generated.AssistantUsageEvent.AssistantUsageEventData
-
Returns the value of the
interTokenLatencyMsrecord component. - invoke(ToolInvocation) - Method in interface com.github.copilot.sdk.json.ToolHandler
-
Invokes the tool with the given invocation context.
- invoke(String, Object, Class<T>) - Method in interface com.github.copilot.sdk.generated.rpc.RpcCaller
-
Invokes a JSON-RPC method and returns a future for the typed response.
- isAuthenticated() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAuthGetStatusResult
-
Returns the value of the
isAuthenticatedrecord component. - isAuthenticated() - Method in class com.github.copilot.sdk.json.GetAuthStatusResponse
- isAutoRestart() - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Deprecated.This option has no effect and will be removed in a future release.
- isAutoStart() - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Returns whether the client should automatically start the server.
- isDirectory() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsStatResult
-
Returns the value of the
isDirectoryrecord component. - isDisableResume() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Returns whether the resume event is disabled.
- isFile() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsStatResult
-
Returns the value of the
isFilerecord component. - isInitial() - Method in record class com.github.copilot.sdk.generated.SessionUsageInfoEvent.SessionUsageInfoEventData
-
Returns the value of the
isInitialrecord component. - isReasoningEffort() - Method in class com.github.copilot.sdk.json.ModelSupports
-
Returns whether this model supports reasoning effort configuration.
- isRemote() - Method in class com.github.copilot.sdk.json.SessionMetadata
-
Returns whether this session is stored remotely.
- isStreaming() - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Returns whether streaming is enabled.
- isStreaming() - Method in class com.github.copilot.sdk.json.SessionConfig
-
Returns whether streaming is enabled.
- isUnlimitedEntitlement() - Method in record class com.github.copilot.sdk.generated.AssistantUsageQuotaSnapshot
-
Returns the value of the
isUnlimitedEntitlementrecord component. - isUnlimitedEntitlement() - Method in record class com.github.copilot.sdk.generated.rpc.AccountQuotaSnapshot
-
Returns the value of the
isUnlimitedEntitlementrecord component. - isUserRequested() - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteEvent.ToolExecutionCompleteEventData
-
Returns the value of the
isUserRequestedrecord component. - isUseStdio() - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Returns whether to use stdio transport instead of TCP.
- isVision() - Method in class com.github.copilot.sdk.json.ModelSupports
- isWasFreeform() - Method in class com.github.copilot.sdk.json.UserInputResponse
-
Returns whether the answer was freeform (not from the provided choices).
J
- JsonRpcError - Class in com.github.copilot.sdk.json
-
JSON-RPC 2.0 error structure.
- JsonRpcError() - Constructor for class com.github.copilot.sdk.json.JsonRpcError
- JsonRpcRequest - Class in com.github.copilot.sdk.json
-
JSON-RPC 2.0 request structure.
- JsonRpcRequest() - Constructor for class com.github.copilot.sdk.json.JsonRpcRequest
- JsonRpcResponse - Class in com.github.copilot.sdk.json
-
JSON-RPC 2.0 response structure.
- JsonRpcResponse() - Constructor for class com.github.copilot.sdk.json.JsonRpcResponse
K
- kill(SessionShellKillParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionShellApi
-
Invokes
session.shell.kill. - killed() - Method in record class com.github.copilot.sdk.generated.rpc.SessionShellKillResult
-
Returns the value of the
killedrecord component. - kind() - Method in record class com.github.copilot.sdk.generated.PermissionCompletedResult
-
Returns the value of the
kindrecord component. - kind() - Method in record class com.github.copilot.sdk.generated.SystemNotificationEvent.SystemNotificationEventData
-
Returns the value of the
kindrecord component.
L
- label() - Method in record class com.github.copilot.sdk.generated.rpc.InstructionsSources
-
Returns the value of the
labelrecord component. - LAST_INSTRUCTIONS - Static variable in class com.github.copilot.sdk.json.SystemPromptSections
-
End-of-prompt instructions: parallel tool calling, persistence, task completion.
- lastCallInputTokens() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUsageGetMetricsResult
-
Returns the value of the
lastCallInputTokensrecord component. - lastCallOutputTokens() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUsageGetMetricsResult
-
Returns the value of the
lastCallOutputTokensrecord component. - LATEST - Enum constant in enum class com.github.copilot.sdk.SdkProtocolVersion
- level() - Method in record class com.github.copilot.sdk.generated.rpc.SessionLogParams
-
Returns the value of the
levelrecord component. - limits() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilities
-
Returns the value of the
limitsrecord component. - limits() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverride
-
Returns the value of the
limitsrecord component. - Limits() - Constructor for class com.github.copilot.sdk.json.ModelCapabilitiesOverride.Limits
- linesAdded() - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsCodeChanges
-
Returns the value of the
linesAddedrecord component. - linesAdded() - Method in record class com.github.copilot.sdk.generated.ShutdownCodeChanges
-
Returns the value of the
linesAddedrecord component. - linesRemoved() - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsCodeChanges
-
Returns the value of the
linesRemovedrecord component. - linesRemoved() - Method in record class com.github.copilot.sdk.generated.ShutdownCodeChanges
-
Returns the value of the
linesRemovedrecord component. - list() - Method in class com.github.copilot.sdk.generated.rpc.ServerMcpConfigApi
-
Invokes
mcp.config.list. - list() - Method in class com.github.copilot.sdk.generated.rpc.ServerModelsApi
-
Invokes
models.list. - list() - Method in class com.github.copilot.sdk.generated.rpc.SessionAgentApi
-
Invokes
session.agent.list. - list() - Method in class com.github.copilot.sdk.generated.rpc.SessionExtensionsApi
-
Invokes
session.extensions.list. - list() - Method in class com.github.copilot.sdk.generated.rpc.SessionMcpApi
-
Invokes
session.mcp.list. - list() - Method in class com.github.copilot.sdk.generated.rpc.SessionPluginsApi
-
Invokes
session.plugins.list. - list() - Method in class com.github.copilot.sdk.generated.rpc.SessionSkillsApi
-
Invokes
session.skills.list. - list(ToolsListParams) - Method in class com.github.copilot.sdk.generated.rpc.ServerToolsApi
-
Invokes
tools.list. - listAgents() - Method in class com.github.copilot.sdk.CopilotSession
-
Lists the custom agents available for selection in this session.
- listFiles() - Method in class com.github.copilot.sdk.generated.rpc.SessionWorkspaceApi
-
Invokes
session.workspace.listFiles. - listFiles() - Method in class com.github.copilot.sdk.generated.rpc.SessionWorkspacesApi
-
Invokes
session.workspaces.listFiles. - listModels() - Method in class com.github.copilot.sdk.CopilotClient
-
Lists available models with their metadata.
- listSessions() - Method in class com.github.copilot.sdk.CopilotClient
-
Lists all available sessions.
- listSessions(SessionListFilter) - Method in class com.github.copilot.sdk.CopilotClient
-
Lists all available sessions with optional filtering.
- ListSessionsResponse - Record Class in com.github.copilot.sdk.json
-
Internal response object from listing sessions.
- ListSessionsResponse(List<SessionMetadata>) - Constructor for record class com.github.copilot.sdk.json.ListSessionsResponse
-
Creates an instance of a
ListSessionsResponserecord class. - LOCAL - Enum constant in enum class com.github.copilot.sdk.generated.HandoffSourceType
-
The
localvariant. - LOCAL - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace.SessionWorkspacesGetWorkspaceResultWorkspaceSessionSyncLevel
-
The
localvariant. - location() - Method in record class com.github.copilot.sdk.generated.rpc.InstructionsSources
-
Returns the value of the
locationrecord component. - log(SessionLogParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionRpc
-
Invokes
session.log. - log(String) - Method in class com.github.copilot.sdk.CopilotSession
-
Logs an informational message to the session timeline.
- log(String, String, Boolean) - Method in class com.github.copilot.sdk.CopilotSession
-
Logs a message to the session timeline.
- log(String, String, Boolean, String) - Method in class com.github.copilot.sdk.CopilotSession
-
Logs a message to the session timeline.
- login() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAuthGetStatusResult
-
Returns the value of the
loginrecord component. - login(SessionMcpOauthLoginParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionMcpOauthApi
-
Invokes
session.mcp.oauth.login.
M
- marketplace() - Method in record class com.github.copilot.sdk.generated.rpc.Plugin
-
Returns the value of the
marketplacerecord component. - maxContextWindowTokens() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesLimits
-
Returns the value of the
maxContextWindowTokensrecord component. - maxContextWindowTokens() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverrideLimits
-
Returns the value of the
maxContextWindowTokensrecord component. - maxOutputTokens() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesLimits
-
Returns the value of the
maxOutputTokensrecord component. - maxOutputTokens() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverrideLimits
-
Returns the value of the
maxOutputTokensrecord component. - maxPromptImages() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesLimitsVision
-
Returns the value of the
maxPromptImagesrecord component. - maxPromptImages() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverrideLimitsVision
-
Returns the value of the
maxPromptImagesrecord component. - maxPromptImageSize() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesLimitsVision
-
Returns the value of the
maxPromptImageSizerecord component. - maxPromptImageSize() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverrideLimitsVision
-
Returns the value of the
maxPromptImageSizerecord component. - maxPromptTokens() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesLimits
-
Returns the value of the
maxPromptTokensrecord component. - maxPromptTokens() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverrideLimits
-
Returns the value of the
maxPromptTokensrecord component. - mcLastEventId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
-
Returns the value of the
mcLastEventIdrecord component. - mcp - Variable in class com.github.copilot.sdk.generated.rpc.ServerRpc
-
API methods for the
mcpnamespace. - mcp - Variable in class com.github.copilot.sdk.generated.rpc.SessionRpc
-
API methods for the
mcpnamespace. - McpConfigAddParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
mcp.config.addRPC method. - McpConfigAddParams(String, Object) - Constructor for record class com.github.copilot.sdk.generated.rpc.McpConfigAddParams
-
Creates an instance of a
McpConfigAddParamsrecord class. - McpConfigDisableParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
mcp.config.disableRPC method. - McpConfigDisableParams(List<String>) - Constructor for record class com.github.copilot.sdk.generated.rpc.McpConfigDisableParams
-
Creates an instance of a
McpConfigDisableParamsrecord class. - McpConfigEnableParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
mcp.config.enableRPC method. - McpConfigEnableParams(List<String>) - Constructor for record class com.github.copilot.sdk.generated.rpc.McpConfigEnableParams
-
Creates an instance of a
McpConfigEnableParamsrecord class. - McpConfigListResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
mcp.config.listRPC method. - McpConfigListResult(Map<String, Object>) - Constructor for record class com.github.copilot.sdk.generated.rpc.McpConfigListResult
-
Creates an instance of a
McpConfigListResultrecord class. - McpConfigRemoveParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
mcp.config.removeRPC method. - McpConfigRemoveParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.McpConfigRemoveParams
-
Creates an instance of a
McpConfigRemoveParamsrecord class. - McpConfigUpdateParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
mcp.config.updateRPC method. - McpConfigUpdateParams(String, Object) - Constructor for record class com.github.copilot.sdk.generated.rpc.McpConfigUpdateParams
-
Creates an instance of a
McpConfigUpdateParamsrecord class. - McpDiscoverParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
mcp.discoverRPC method. - McpDiscoverParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.McpDiscoverParams
-
Creates an instance of a
McpDiscoverParamsrecord class. - McpDiscoverResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
mcp.discoverRPC method. - McpDiscoverResult(List<DiscoveredMcpServer>) - Constructor for record class com.github.copilot.sdk.generated.rpc.McpDiscoverResult
-
Creates an instance of a
McpDiscoverResultrecord class. - McpHttpServerConfig - Class in com.github.copilot.sdk.json
-
Configuration for a remote HTTP/SSE MCP (Model Context Protocol) server.
- McpHttpServerConfig() - Constructor for class com.github.copilot.sdk.json.McpHttpServerConfig
- McpOauthCompletedEvent - Class in com.github.copilot.sdk.generated
-
The
mcp.oauth_completedsession event. - McpOauthCompletedEvent() - Constructor for class com.github.copilot.sdk.generated.McpOauthCompletedEvent
- McpOauthCompletedEvent.McpOauthCompletedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
McpOauthCompletedEvent. - McpOauthCompletedEventData(String) - Constructor for record class com.github.copilot.sdk.generated.McpOauthCompletedEvent.McpOauthCompletedEventData
-
Creates an instance of a
McpOauthCompletedEventDatarecord class. - McpOauthRequiredEvent - Class in com.github.copilot.sdk.generated
-
The
mcp.oauth_requiredsession event. - McpOauthRequiredEvent() - Constructor for class com.github.copilot.sdk.generated.McpOauthRequiredEvent
- McpOauthRequiredEvent.McpOauthRequiredEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
McpOauthRequiredEvent. - McpOauthRequiredEventData(String, String, String, McpOauthRequiredStaticClientConfig) - Constructor for record class com.github.copilot.sdk.generated.McpOauthRequiredEvent.McpOauthRequiredEventData
-
Creates an instance of a
McpOauthRequiredEventDatarecord class. - McpOauthRequiredStaticClientConfig - Record Class in com.github.copilot.sdk.generated
-
Static OAuth client configuration, if the server specifies one
- McpOauthRequiredStaticClientConfig(String, Boolean) - Constructor for record class com.github.copilot.sdk.generated.McpOauthRequiredStaticClientConfig
-
Creates an instance of a
McpOauthRequiredStaticClientConfigrecord class. - mcpRequestId() - Method in record class com.github.copilot.sdk.generated.SamplingRequestedEvent.SamplingRequestedEventData
-
Returns the value of the
mcpRequestIdrecord component. - McpServer - Record Class in com.github.copilot.sdk.generated.rpc
- McpServer(String, McpServerStatus, McpServerSource, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.McpServer
-
Creates an instance of a
McpServerrecord class. - McpServerConfig - Class in com.github.copilot.sdk.json
-
Abstract base class for MCP (Model Context Protocol) server configurations.
- McpServerConfig() - Constructor for class com.github.copilot.sdk.json.McpServerConfig
- mcpServerName() - Method in record class com.github.copilot.sdk.generated.AssistantMessageToolRequest
-
Returns the value of the
mcpServerNamerecord component. - mcpServerName() - Method in record class com.github.copilot.sdk.generated.ToolExecutionStartEvent.ToolExecutionStartEventData
-
Returns the value of the
mcpServerNamerecord component. - McpServersLoadedServer - Record Class in com.github.copilot.sdk.generated
- McpServersLoadedServer(String, McpServersLoadedServerStatus, String, String) - Constructor for record class com.github.copilot.sdk.generated.McpServersLoadedServer
-
Creates an instance of a
McpServersLoadedServerrecord class. - McpServersLoadedServerStatus - Enum Class in com.github.copilot.sdk.generated
-
Connection status: connected, failed, needs-auth, pending, disabled, or not_configured
- McpServerSource - Enum Class in com.github.copilot.sdk.generated.rpc
-
Configuration source: user, workspace, plugin, or builtin
- McpServerStatus - Enum Class in com.github.copilot.sdk.generated.rpc
-
Connection status: connected, failed, needs-auth, pending, disabled, or not_configured
- McpServerStatusChangedStatus - Enum Class in com.github.copilot.sdk.generated
-
New connection status: connected, failed, needs-auth, pending, disabled, or not_configured
- McpStdioServerConfig - Class in com.github.copilot.sdk.json
-
Configuration for a local/stdio MCP (Model Context Protocol) server.
- McpStdioServerConfig() - Constructor for class com.github.copilot.sdk.json.McpStdioServerConfig
- mcpToolName() - Method in record class com.github.copilot.sdk.generated.ToolExecutionStartEvent.ToolExecutionStartEventData
-
Returns the value of the
mcpToolNamerecord component. - mcSessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
-
Returns the value of the
mcSessionIdrecord component. - mcTaskId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
-
Returns the value of the
mcTaskIdrecord component. - MEMORY - Enum constant in enum class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServerType
-
The
memoryvariant. - message() - Method in record class com.github.copilot.sdk.generated.ElicitationRequestedEvent.ElicitationRequestedEventData
-
Returns the value of the
messagerecord component. - message() - Method in record class com.github.copilot.sdk.generated.HookEndError
-
Returns the value of the
messagerecord component. - message() - Method in record class com.github.copilot.sdk.generated.rpc.PingParams
-
Returns the value of the
messagerecord component. - message() - Method in record class com.github.copilot.sdk.generated.rpc.PingResult
-
Returns the value of the
messagerecord component. - message() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsError
-
Returns the value of the
messagerecord component. - message() - Method in record class com.github.copilot.sdk.generated.rpc.SessionLogParams
-
Returns the value of the
messagerecord component. - message() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUiElicitationParams
-
Returns the value of the
messagerecord component. - message() - Method in record class com.github.copilot.sdk.generated.SessionErrorEvent.SessionErrorEventData
-
Returns the value of the
messagerecord component. - message() - Method in record class com.github.copilot.sdk.generated.SessionInfoEvent.SessionInfoEventData
-
Returns the value of the
messagerecord component. - message() - Method in record class com.github.copilot.sdk.generated.SessionWarningEvent.SessionWarningEventData
-
Returns the value of the
messagerecord component. - message() - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteError
-
Returns the value of the
messagerecord component. - message() - Method in record class com.github.copilot.sdk.json.PingResponse
-
Returns the value of the
messagerecord component. - MessageAttachment - Interface in com.github.copilot.sdk.json
-
Marker interface for all attachment types that can be included in a message.
- messageId() - Method in record class com.github.copilot.sdk.generated.AssistantMessageDeltaEvent.AssistantMessageDeltaEventData
-
Returns the value of the
messageIdrecord component. - messageId() - Method in record class com.github.copilot.sdk.generated.AssistantMessageEvent.AssistantMessageEventData
-
Returns the value of the
messageIdrecord component. - messageId() - Method in record class com.github.copilot.sdk.json.SendMessageResponse
-
Returns the value of the
messageIdrecord component. - MessageOptions - Class in com.github.copilot.sdk.json
-
Options for sending a message to a Copilot session.
- MessageOptions() - Constructor for class com.github.copilot.sdk.json.MessageOptions
- messagesLength() - Method in record class com.github.copilot.sdk.generated.rpc.HistoryCompactContextWindow
-
Returns the value of the
messagesLengthrecord component. - messagesLength() - Method in record class com.github.copilot.sdk.generated.SessionUsageInfoEvent.SessionUsageInfoEventData
-
Returns the value of the
messagesLengthrecord component. - messagesRemoved() - Method in record class com.github.copilot.sdk.generated.rpc.SessionHistoryCompactResult
-
Returns the value of the
messagesRemovedrecord component. - messagesRemoved() - Method in record class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent.SessionCompactionCompleteEventData
-
Returns the value of the
messagesRemovedrecord component. - messagesRemovedDuringTruncation() - Method in record class com.github.copilot.sdk.generated.SessionTruncationEvent.SessionTruncationEventData
-
Returns the value of the
messagesRemovedDuringTruncationrecord component. - metadata() - Method in record class com.github.copilot.sdk.generated.SystemMessageEvent.SystemMessageEventData
-
Returns the value of the
metadatarecord component. - mimeType() - Method in record class com.github.copilot.sdk.json.ToolBinaryResult
-
Returns the value of the
mimeTyperecord component. - mode - Variable in class com.github.copilot.sdk.generated.rpc.SessionRpc
-
API methods for the
modenamespace. - mode() - Method in record class com.github.copilot.sdk.generated.ElicitationRequestedEvent.ElicitationRequestedEventData
-
Returns the value of the
moderecord component. - mode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsAppendFileParams
-
Returns the value of the
moderecord component. - mode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsMkdirParams
-
Returns the value of the
moderecord component. - mode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsWriteFileParams
-
Returns the value of the
moderecord component. - mode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModeGetResult
-
Returns the value of the
moderecord component. - mode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModeSetParams
-
Returns the value of the
moderecord component. - mode() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModeSetResult
-
Returns the value of the
moderecord component. - model - Variable in class com.github.copilot.sdk.generated.rpc.SessionRpc
-
API methods for the
modelnamespace. - model() - Method in record class com.github.copilot.sdk.generated.AssistantUsageEvent.AssistantUsageEventData
-
Returns the value of the
modelrecord component. - model() - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsed
-
Returns the value of the
modelrecord component. - model() - Method in record class com.github.copilot.sdk.generated.CustomAgentsUpdatedAgent
-
Returns the value of the
modelrecord component. - model() - Method in record class com.github.copilot.sdk.generated.rpc.ToolsListParams
-
Returns the value of the
modelrecord component. - model() - Method in record class com.github.copilot.sdk.generated.SessionToolsUpdatedEvent.SessionToolsUpdatedEventData
-
Returns the value of the
modelrecord component. - model() - Method in record class com.github.copilot.sdk.generated.SubagentCompletedEvent.SubagentCompletedEventData
-
Returns the value of the
modelrecord component. - model() - Method in record class com.github.copilot.sdk.generated.SubagentFailedEvent.SubagentFailedEventData
-
Returns the value of the
modelrecord component. - model() - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteEvent.ToolExecutionCompleteEventData
-
Returns the value of the
modelrecord component. - Model - Record Class in com.github.copilot.sdk.generated.rpc
- Model(String, String, ModelCapabilities, ModelPolicy, ModelBilling, List<String>, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.Model
-
Creates an instance of a
Modelrecord class. - MODEL - Enum constant in enum class com.github.copilot.sdk.generated.rpc.InstructionsSourcesType
-
The
modelvariant. - ModelBilling - Class in com.github.copilot.sdk.json
-
Model billing information.
- ModelBilling - Record Class in com.github.copilot.sdk.generated.rpc
-
Billing information
- ModelBilling() - Constructor for class com.github.copilot.sdk.json.ModelBilling
- ModelBilling(Double) - Constructor for record class com.github.copilot.sdk.generated.rpc.ModelBilling
-
Creates an instance of a
ModelBillingrecord class. - modelCapabilities() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModelSwitchToParams
-
Returns the value of the
modelCapabilitiesrecord component. - ModelCapabilities - Class in com.github.copilot.sdk.json
-
Model capabilities and limits.
- ModelCapabilities - Record Class in com.github.copilot.sdk.generated.rpc
-
Model capabilities and limits
- ModelCapabilities() - Constructor for class com.github.copilot.sdk.json.ModelCapabilities
- ModelCapabilities(ModelCapabilitiesSupports, ModelCapabilitiesLimits) - Constructor for record class com.github.copilot.sdk.generated.rpc.ModelCapabilities
-
Creates an instance of a
ModelCapabilitiesrecord class. - ModelCapabilitiesLimits - Record Class in com.github.copilot.sdk.generated.rpc
-
Token limits for prompts, outputs, and context window
- ModelCapabilitiesLimits(Long, Long, Long, ModelCapabilitiesLimitsVision) - Constructor for record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesLimits
-
Creates an instance of a
ModelCapabilitiesLimitsrecord class. - ModelCapabilitiesLimitsVision - Record Class in com.github.copilot.sdk.generated.rpc
-
Vision-specific limits
- ModelCapabilitiesLimitsVision(List<String>, Long, Long) - Constructor for record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesLimitsVision
-
Creates an instance of a
ModelCapabilitiesLimitsVisionrecord class. - ModelCapabilitiesOverride - Class in com.github.copilot.sdk.json
-
Per-property overrides for model capabilities, deep-merged over runtime defaults.
- ModelCapabilitiesOverride - Record Class in com.github.copilot.sdk.generated.rpc
-
Override individual model capabilities resolved by the runtime
- ModelCapabilitiesOverride() - Constructor for class com.github.copilot.sdk.json.ModelCapabilitiesOverride
- ModelCapabilitiesOverride(ModelCapabilitiesOverrideSupports, ModelCapabilitiesOverrideLimits) - Constructor for record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverride
-
Creates an instance of a
ModelCapabilitiesOverriderecord class. - ModelCapabilitiesOverride.Limits - Class in com.github.copilot.sdk.json
-
Token limit overrides for model capabilities.
- ModelCapabilitiesOverride.Supports - Class in com.github.copilot.sdk.json
-
Feature flag overrides for model capabilities.
- ModelCapabilitiesOverrideLimits - Record Class in com.github.copilot.sdk.generated.rpc
-
Token limits for prompts, outputs, and context window
- ModelCapabilitiesOverrideLimits(Long, Long, Long, ModelCapabilitiesOverrideLimitsVision) - Constructor for record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverrideLimits
-
Creates an instance of a
ModelCapabilitiesOverrideLimitsrecord class. - ModelCapabilitiesOverrideLimitsVision - Record Class in com.github.copilot.sdk.generated.rpc
- ModelCapabilitiesOverrideLimitsVision(List<String>, Long, Long) - Constructor for record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverrideLimitsVision
-
Creates an instance of a
ModelCapabilitiesOverrideLimitsVisionrecord class. - ModelCapabilitiesOverrideSupports - Record Class in com.github.copilot.sdk.generated.rpc
-
Feature flags indicating what the model supports
- ModelCapabilitiesOverrideSupports(Boolean, Boolean) - Constructor for record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverrideSupports
-
Creates an instance of a
ModelCapabilitiesOverrideSupportsrecord class. - ModelCapabilitiesSupports - Record Class in com.github.copilot.sdk.generated.rpc
-
Feature flags indicating what the model supports
- ModelCapabilitiesSupports(Boolean, Boolean) - Constructor for record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesSupports
-
Creates an instance of a
ModelCapabilitiesSupportsrecord class. - modelId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModelGetCurrentResult
-
Returns the value of the
modelIdrecord component. - modelId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModelSwitchToParams
-
Returns the value of the
modelIdrecord component. - modelId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModelSwitchToResult
-
Returns the value of the
modelIdrecord component. - ModelInfo - Class in com.github.copilot.sdk.json
-
Information about an available model.
- ModelInfo() - Constructor for class com.github.copilot.sdk.json.ModelInfo
- ModelLimits - Class in com.github.copilot.sdk.json
-
Model limits.
- ModelLimits() - Constructor for class com.github.copilot.sdk.json.ModelLimits
- modelMetrics() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUsageGetMetricsResult
-
Returns the value of the
modelMetricsrecord component. - modelMetrics() - Method in record class com.github.copilot.sdk.generated.SessionShutdownEvent.SessionShutdownEventData
-
Returns the value of the
modelMetricsrecord component. - ModelPolicy - Class in com.github.copilot.sdk.json
-
Model policy state.
- ModelPolicy - Record Class in com.github.copilot.sdk.generated.rpc
-
Policy state (if applicable)
- ModelPolicy() - Constructor for class com.github.copilot.sdk.json.ModelPolicy
- ModelPolicy(String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.ModelPolicy
-
Creates an instance of a
ModelPolicyrecord class. - models - Variable in class com.github.copilot.sdk.generated.rpc.ServerRpc
-
API methods for the
modelsnamespace. - models() - Method in record class com.github.copilot.sdk.generated.rpc.ModelsListResult
-
Returns the value of the
modelsrecord component. - ModelsListResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
models.listRPC method. - ModelsListResult(List<Model>) - Constructor for record class com.github.copilot.sdk.generated.rpc.ModelsListResult
-
Creates an instance of a
ModelsListResultrecord class. - ModelSupports - Class in com.github.copilot.sdk.json
-
Model support flags.
- ModelSupports() - Constructor for class com.github.copilot.sdk.json.ModelSupports
- ModelVisionLimits - Class in com.github.copilot.sdk.json
-
Model vision-specific limits.
- ModelVisionLimits() - Constructor for class com.github.copilot.sdk.json.ModelVisionLimits
- modifiedArgs() - Method in record class com.github.copilot.sdk.json.PreToolUseHookOutput
-
Returns the value of the
modifiedArgsrecord component. - modifiedConfig() - Method in record class com.github.copilot.sdk.json.SessionStartHookOutput
-
Returns the value of the
modifiedConfigrecord component. - modifiedPrompt() - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookOutput
-
Returns the value of the
modifiedPromptrecord component. - modifiedResult() - Method in record class com.github.copilot.sdk.json.PostToolUseHookOutput
-
Returns the value of the
modifiedResultrecord component. - modifiedTime() - Method in record class com.github.copilot.sdk.json.SessionLifecycleEventMetadata
-
Returns the value of the
modifiedTimerecord component. - mtime() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsStatResult
-
Returns the value of the
mtimerecord component. - multiplier() - Method in record class com.github.copilot.sdk.generated.rpc.ModelBilling
-
Returns the value of the
multiplierrecord component.
N
- name - Variable in class com.github.copilot.sdk.generated.rpc.SessionRpc
-
API methods for the
namenamespace. - name() - Method in record class com.github.copilot.sdk.generated.AssistantMessageToolRequest
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.CommandsChangedCommand
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.CustomAgentsUpdatedAgent
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.ExtensionsLoadedExtension
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.HandoffRepository
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.McpServersLoadedServer
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.rpc.AgentInfo
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServer
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.rpc.Extension
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigAddParams
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigRemoveParams
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigUpdateParams
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.rpc.McpServer
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.rpc.Model
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.rpc.Plugin
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.rpc.ServerSkill
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentSelectParams
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesEntry
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.rpc.SessionNameGetResult
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.rpc.SessionNameSetParams
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsDisableParams
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsEnableParams
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.rpc.Skill
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.rpc.Tool
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.SkillInvokedEvent.SkillInvokedEventData
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.SkillsLoadedSkill
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.generated.SystemMessageEvent.SystemMessageEventData
-
Returns the value of the
namerecord component. - name() - Method in record class com.github.copilot.sdk.json.ToolDefinition
-
Returns the value of the
namerecord component. - names() - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigDisableParams
-
Returns the value of the
namesrecord component. - names() - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigEnableParams
-
Returns the value of the
namesrecord component. - namespacedName() - Method in record class com.github.copilot.sdk.generated.rpc.Tool
-
Returns the value of the
namespacedNamerecord component. - nativeDocumentPathFallbackPaths() - Method in record class com.github.copilot.sdk.generated.UserMessageEvent.UserMessageEventData
-
Returns the value of the
nativeDocumentPathFallbackPathsrecord component. - NEEDS_AUTH - Enum constant in enum class com.github.copilot.sdk.generated.McpServersLoadedServerStatus
-
The
needs-authvariant. - NEEDS_AUTH - Enum constant in enum class com.github.copilot.sdk.generated.McpServerStatusChangedStatus
-
The
needs-authvariant. - NEEDS_AUTH - Enum constant in enum class com.github.copilot.sdk.generated.rpc.McpServerStatus
-
The
needs-authvariant. - NESTED_AGENTS - Enum constant in enum class com.github.copilot.sdk.generated.rpc.InstructionsSourcesType
-
The
nested-agentsvariant. - newMode() - Method in record class com.github.copilot.sdk.generated.SessionModeChangedEvent.SessionModeChangedEventData
-
Returns the value of the
newModerecord component. - newModel() - Method in record class com.github.copilot.sdk.generated.SessionModelChangeEvent.SessionModelChangeEventData
-
Returns the value of the
newModelrecord component. - NO_RESULT - Static variable in class com.github.copilot.sdk.json.PermissionRequestResultKind
-
Leaves the pending permission request unanswered.
- NOT_CONFIGURED - Enum constant in enum class com.github.copilot.sdk.generated.McpServersLoadedServerStatus
-
The
not_configuredvariant. - NOT_CONFIGURED - Enum constant in enum class com.github.copilot.sdk.generated.McpServerStatusChangedStatus
-
The
not_configuredvariant. - NOT_CONFIGURED - Enum constant in enum class com.github.copilot.sdk.generated.rpc.McpServerStatus
-
The
not_configuredvariant.
O
- oauth - Variable in class com.github.copilot.sdk.generated.rpc.SessionMcpApi
-
API methods for the
mcp.oauthsub-namespace. - on(Class<T>, Consumer<T>) - Method in class com.github.copilot.sdk.CopilotSession
-
Registers an event handler for a specific event type.
- on(Consumer<SessionEvent>) - Method in class com.github.copilot.sdk.CopilotSession
-
Registers a callback for all session events.
- onLifecycle(SessionLifecycleHandler) - Method in class com.github.copilot.sdk.CopilotClient
-
Subscribes to all session lifecycle events.
- onLifecycle(String, SessionLifecycleHandler) - Method in class com.github.copilot.sdk.CopilotClient
-
Subscribes to a specific session lifecycle event type.
- onLifecycleEvent(SessionLifecycleEvent) - Method in interface com.github.copilot.sdk.json.SessionLifecycleHandler
-
Called when a session lifecycle event occurs.
- operation() - Method in record class com.github.copilot.sdk.generated.SessionPlanChangedEvent.SessionPlanChangedEventData
-
Returns the value of the
operationrecord component. - operation() - Method in record class com.github.copilot.sdk.generated.SessionWorkspaceFileChangedEvent.SessionWorkspaceFileChangedEventData
-
Returns the value of the
operationrecord component. - output() - Method in record class com.github.copilot.sdk.generated.HookEndEvent.HookEndEventData
-
Returns the value of the
outputrecord component. - outputTokens() - Method in record class com.github.copilot.sdk.generated.AssistantMessageEvent.AssistantMessageEventData
-
Returns the value of the
outputTokensrecord component. - outputTokens() - Method in record class com.github.copilot.sdk.generated.AssistantUsageEvent.AssistantUsageEventData
-
Returns the value of the
outputTokensrecord component. - outputTokens() - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsed
-
Returns the value of the
outputTokensrecord component. - outputTokens() - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsModelMetricUsage
-
Returns the value of the
outputTokensrecord component. - outputTokens() - Method in record class com.github.copilot.sdk.generated.ShutdownModelMetricUsage
-
Returns the value of the
outputTokensrecord component. - overage() - Method in record class com.github.copilot.sdk.generated.AssistantUsageQuotaSnapshot
-
Returns the value of the
overagerecord component. - overage() - Method in record class com.github.copilot.sdk.generated.rpc.AccountQuotaSnapshot
-
Returns the value of the
overagerecord component. - overageAllowedWithExhaustedQuota() - Method in record class com.github.copilot.sdk.generated.AssistantUsageQuotaSnapshot
-
Returns the value of the
overageAllowedWithExhaustedQuotarecord component. - overageAllowedWithExhaustedQuota() - Method in record class com.github.copilot.sdk.generated.rpc.AccountQuotaSnapshot
-
Returns the value of the
overageAllowedWithExhaustedQuotarecord component. - overridesBuiltInTool() - Method in record class com.github.copilot.sdk.json.ToolDefinition
-
Returns the value of the
overridesBuiltInToolrecord component. - owner() - Method in record class com.github.copilot.sdk.generated.HandoffRepository
-
Returns the value of the
ownerrecord component.
P
- parameters() - Method in record class com.github.copilot.sdk.generated.rpc.Tool
-
Returns the value of the
parametersrecord component. - parameters() - Method in record class com.github.copilot.sdk.json.ToolDefinition
-
Returns the value of the
parametersrecord component. - parentToolCallId() - Method in record class com.github.copilot.sdk.generated.AssistantMessageDeltaEvent.AssistantMessageDeltaEventData
-
Returns the value of the
parentToolCallIdrecord component. - parentToolCallId() - Method in record class com.github.copilot.sdk.generated.AssistantMessageEvent.AssistantMessageEventData
-
Returns the value of the
parentToolCallIdrecord component. - parentToolCallId() - Method in record class com.github.copilot.sdk.generated.AssistantUsageEvent.AssistantUsageEventData
-
Returns the value of the
parentToolCallIdrecord component. - parentToolCallId() - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteEvent.ToolExecutionCompleteEventData
-
Returns the value of the
parentToolCallIdrecord component. - parentToolCallId() - Method in record class com.github.copilot.sdk.generated.ToolExecutionStartEvent.ToolExecutionStartEventData
-
Returns the value of the
parentToolCallIdrecord component. - partialOutput() - Method in record class com.github.copilot.sdk.generated.ToolExecutionPartialResultEvent.ToolExecutionPartialResultEventData
-
Returns the value of the
partialOutputrecord component. - path() - Method in record class com.github.copilot.sdk.generated.rpc.ServerSkill
-
Returns the value of the
pathrecord component. - path() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsAppendFileParams
-
Returns the value of the
pathrecord component. - path() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsExistsParams
-
Returns the value of the
pathrecord component. - path() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsMkdirParams
-
Returns the value of the
pathrecord component. - path() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirParams
-
Returns the value of the
pathrecord component. - path() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesParams
-
Returns the value of the
pathrecord component. - path() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReadFileParams
-
Returns the value of the
pathrecord component. - path() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsRmParams
-
Returns the value of the
pathrecord component. - path() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsStatParams
-
Returns the value of the
pathrecord component. - path() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsWriteFileParams
-
Returns the value of the
pathrecord component. - path() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanReadResult
-
Returns the value of the
pathrecord component. - path() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceCreateFileParams
-
Returns the value of the
pathrecord component. - path() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceReadFileParams
-
Returns the value of the
pathrecord component. - path() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesCreateFileParams
-
Returns the value of the
pathrecord component. - path() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesReadFileParams
-
Returns the value of the
pathrecord component. - path() - Method in record class com.github.copilot.sdk.generated.rpc.Skill
-
Returns the value of the
pathrecord component. - path() - Method in record class com.github.copilot.sdk.generated.SessionWorkspaceFileChangedEvent.SessionWorkspaceFileChangedEventData
-
Returns the value of the
pathrecord component. - path() - Method in record class com.github.copilot.sdk.generated.SkillInvokedEvent.SkillInvokedEventData
-
Returns the value of the
pathrecord component. - path() - Method in record class com.github.copilot.sdk.generated.SkillsLoadedSkill
-
Returns the value of the
pathrecord component. - path() - Method in record class com.github.copilot.sdk.json.Attachment
-
Returns the value of the
pathrecord component. - PENDING - Enum constant in enum class com.github.copilot.sdk.generated.McpServersLoadedServerStatus
-
The
pendingvariant. - PENDING - Enum constant in enum class com.github.copilot.sdk.generated.McpServerStatusChangedStatus
-
The
pendingvariant. - PENDING - Enum constant in enum class com.github.copilot.sdk.generated.rpc.McpServerStatus
-
The
pendingvariant. - PendingMessagesModifiedEvent - Class in com.github.copilot.sdk.generated
-
The
pending_messages.modifiedsession event. - PendingMessagesModifiedEvent() - Constructor for class com.github.copilot.sdk.generated.PendingMessagesModifiedEvent
- PendingMessagesModifiedEvent.PendingMessagesModifiedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
PendingMessagesModifiedEvent. - PendingMessagesModifiedEventData() - Constructor for record class com.github.copilot.sdk.generated.PendingMessagesModifiedEvent.PendingMessagesModifiedEventData
-
Creates an instance of a
PendingMessagesModifiedEventDatarecord class. - performedBy() - Method in record class com.github.copilot.sdk.generated.SessionTruncationEvent.SessionTruncationEventData
-
Returns the value of the
performedByrecord component. - PermissionCompletedEvent - Class in com.github.copilot.sdk.generated
-
The
permission.completedsession event. - PermissionCompletedEvent() - Constructor for class com.github.copilot.sdk.generated.PermissionCompletedEvent
- PermissionCompletedEvent.PermissionCompletedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
PermissionCompletedEvent. - PermissionCompletedEventData(String, String, PermissionCompletedResult) - Constructor for record class com.github.copilot.sdk.generated.PermissionCompletedEvent.PermissionCompletedEventData
-
Creates an instance of a
PermissionCompletedEventDatarecord class. - PermissionCompletedKind - Enum Class in com.github.copilot.sdk.generated
-
The outcome of the permission request
- PermissionCompletedResult - Record Class in com.github.copilot.sdk.generated
-
The result of the permission request
- PermissionCompletedResult(PermissionCompletedKind) - Constructor for record class com.github.copilot.sdk.generated.PermissionCompletedResult
-
Creates an instance of a
PermissionCompletedResultrecord class. - permissionDecision() - Method in record class com.github.copilot.sdk.json.PreToolUseHookOutput
-
Returns the value of the
permissionDecisionrecord component. - permissionDecisionReason() - Method in record class com.github.copilot.sdk.json.PreToolUseHookOutput
-
Returns the value of the
permissionDecisionReasonrecord component. - PermissionHandler - Interface in com.github.copilot.sdk.json
-
Functional interface for handling permission requests from the AI assistant.
- PermissionInvocation - Class in com.github.copilot.sdk.json
-
Context information for a permission request invocation.
- PermissionInvocation() - Constructor for class com.github.copilot.sdk.json.PermissionInvocation
- permissionRequest() - Method in record class com.github.copilot.sdk.generated.PermissionRequestedEvent.PermissionRequestedEventData
-
Returns the value of the
permissionRequestrecord component. - PermissionRequest - Class in com.github.copilot.sdk.json
-
Represents a permission request from the AI assistant.
- PermissionRequest() - Constructor for class com.github.copilot.sdk.json.PermissionRequest
- PermissionRequestedEvent - Class in com.github.copilot.sdk.generated
-
The
permission.requestedsession event. - PermissionRequestedEvent() - Constructor for class com.github.copilot.sdk.generated.PermissionRequestedEvent
- PermissionRequestedEvent.PermissionRequestedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
PermissionRequestedEvent. - PermissionRequestedEventData(String, Object, Object, Boolean) - Constructor for record class com.github.copilot.sdk.generated.PermissionRequestedEvent.PermissionRequestedEventData
-
Creates an instance of a
PermissionRequestedEventDatarecord class. - PermissionRequestResult - Class in com.github.copilot.sdk.json
-
Result of a permission request decision.
- PermissionRequestResult() - Constructor for class com.github.copilot.sdk.json.PermissionRequestResult
- PermissionRequestResultKind - Class in com.github.copilot.sdk.json
-
Describes the outcome kind of a permission request result.
- PermissionRequestResultKind(String) - Constructor for class com.github.copilot.sdk.json.PermissionRequestResultKind
-
Creates a new
PermissionRequestResultKindwith the given string value. - permissions - Variable in class com.github.copilot.sdk.generated.rpc.SessionRpc
-
API methods for the
permissionsnamespace. - phase() - Method in record class com.github.copilot.sdk.generated.AssistantMessageEvent.AssistantMessageEventData
-
Returns the value of the
phaserecord component. - pid() - Method in record class com.github.copilot.sdk.generated.rpc.Extension
-
Returns the value of the
pidrecord component. - ping(PingParams) - Method in class com.github.copilot.sdk.generated.rpc.ServerRpc
-
Invokes
ping. - ping(String) - Method in class com.github.copilot.sdk.CopilotClient
-
Pings the server to check connectivity.
- PingParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
pingRPC method. - PingParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.PingParams
-
Creates an instance of a
PingParamsrecord class. - PingResponse - Record Class in com.github.copilot.sdk.json
-
Response from a ping request to the Copilot CLI server.
- PingResponse(String, long, Integer) - Constructor for record class com.github.copilot.sdk.json.PingResponse
-
Creates an instance of a
PingResponserecord class. - PingResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
pingRPC method. - PingResult(String, Long, Long) - Constructor for record class com.github.copilot.sdk.generated.rpc.PingResult
-
Creates an instance of a
PingResultrecord class. - plan - Variable in class com.github.copilot.sdk.generated.rpc.SessionRpc
-
API methods for the
plannamespace. - PLAN - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionMode
-
The
planvariant. - PLAN - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionModeGetResult.SessionModeGetResultMode
-
The
planvariant. - PLAN - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionModeSetResult.SessionModeSetResultMode
-
The
planvariant. - PLAN - Enum constant in enum class com.github.copilot.sdk.generated.UserMessageAgentMode
-
The
planvariant. - PlanChangedOperation - Enum Class in com.github.copilot.sdk.generated
-
The type of operation performed on the plan file
- planContent() - Method in record class com.github.copilot.sdk.generated.ExitPlanModeRequestedEvent.ExitPlanModeRequestedEventData
-
Returns the value of the
planContentrecord component. - Plugin - Record Class in com.github.copilot.sdk.generated.rpc
- Plugin(String, String, String, Boolean) - Constructor for record class com.github.copilot.sdk.generated.rpc.Plugin
-
Creates an instance of a
Pluginrecord class. - PLUGIN - Enum constant in enum class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServerSource
-
The
pluginvariant. - PLUGIN - Enum constant in enum class com.github.copilot.sdk.generated.rpc.McpServerSource
-
The
pluginvariant. - pluginName() - Method in record class com.github.copilot.sdk.generated.SkillInvokedEvent.SkillInvokedEventData
-
Returns the value of the
pluginNamerecord component. - plugins - Variable in class com.github.copilot.sdk.generated.rpc.SessionRpc
-
API methods for the
pluginsnamespace. - plugins() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPluginsListResult
-
Returns the value of the
pluginsrecord component. - pluginVersion() - Method in record class com.github.copilot.sdk.generated.SkillInvokedEvent.SkillInvokedEventData
-
Returns the value of the
pluginVersionrecord component. - policy() - Method in record class com.github.copilot.sdk.generated.rpc.Model
-
Returns the value of the
policyrecord component. - POSIX - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionFsSetProviderConventions
-
The
posixvariant. - postCompactionTokens() - Method in record class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent.SessionCompactionCompleteEventData
-
Returns the value of the
postCompactionTokensrecord component. - PostToolUseHandler - Interface in com.github.copilot.sdk.json
-
Handler for post-tool-use hooks.
- PostToolUseHookInput - Class in com.github.copilot.sdk.json
-
Input for a post-tool-use hook.
- PostToolUseHookInput() - Constructor for class com.github.copilot.sdk.json.PostToolUseHookInput
- PostToolUseHookOutput - Record Class in com.github.copilot.sdk.json
-
Output for a post-tool-use hook.
- PostToolUseHookOutput(JsonNode, String, Boolean) - Constructor for record class com.github.copilot.sdk.json.PostToolUseHookOutput
-
Creates an instance of a
PostToolUseHookOutputrecord class. - postTruncationMessagesLength() - Method in record class com.github.copilot.sdk.generated.SessionTruncationEvent.SessionTruncationEventData
-
Returns the value of the
postTruncationMessagesLengthrecord component. - postTruncationTokensInMessages() - Method in record class com.github.copilot.sdk.generated.SessionTruncationEvent.SessionTruncationEventData
-
Returns the value of the
postTruncationTokensInMessagesrecord component. - preCompactionMessagesLength() - Method in record class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent.SessionCompactionCompleteEventData
-
Returns the value of the
preCompactionMessagesLengthrecord component. - preCompactionTokens() - Method in record class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent.SessionCompactionCompleteEventData
-
Returns the value of the
preCompactionTokensrecord component. - PREPEND - Enum constant in enum class com.github.copilot.sdk.json.SectionOverrideAction
-
Prepend content before the existing section.
- PreToolUseHandler - Interface in com.github.copilot.sdk.json
-
Handler for pre-tool-use hooks.
- PreToolUseHookInput - Class in com.github.copilot.sdk.json
-
Input for a pre-tool-use hook.
- PreToolUseHookInput() - Constructor for class com.github.copilot.sdk.json.PreToolUseHookInput
- PreToolUseHookOutput - Record Class in com.github.copilot.sdk.json
-
Output for a pre-tool-use hook.
- PreToolUseHookOutput(String, String, JsonNode, String, Boolean) - Constructor for record class com.github.copilot.sdk.json.PreToolUseHookOutput
-
Creates an instance of a
PreToolUseHookOutputrecord class. - preTruncationMessagesLength() - Method in record class com.github.copilot.sdk.generated.SessionTruncationEvent.SessionTruncationEventData
-
Returns the value of the
preTruncationMessagesLengthrecord component. - preTruncationTokensInMessages() - Method in record class com.github.copilot.sdk.generated.SessionTruncationEvent.SessionTruncationEventData
-
Returns the value of the
preTruncationTokensInMessagesrecord component. - previousMode() - Method in record class com.github.copilot.sdk.generated.SessionModeChangedEvent.SessionModeChangedEventData
-
Returns the value of the
previousModerecord component. - previousModel() - Method in record class com.github.copilot.sdk.generated.SessionModelChangeEvent.SessionModelChangeEventData
-
Returns the value of the
previousModelrecord component. - previousReasoningEffort() - Method in record class com.github.copilot.sdk.generated.SessionModelChangeEvent.SessionModelChangeEventData
-
Returns the value of the
previousReasoningEffortrecord component. - processId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionShellExecResult
-
Returns the value of the
processIdrecord component. - processId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionShellKillParams
-
Returns the value of the
processIdrecord component. - producer() - Method in record class com.github.copilot.sdk.generated.SessionStartEvent.SessionStartEventData
-
Returns the value of the
producerrecord component. - progressMessage() - Method in record class com.github.copilot.sdk.generated.ToolExecutionProgressEvent.ToolExecutionProgressEventData
-
Returns the value of the
progressMessagerecord component. - PROJECT - Enum constant in enum class com.github.copilot.sdk.generated.ExtensionsLoadedExtensionSource
-
The
projectvariant. - PROJECT - Enum constant in enum class com.github.copilot.sdk.generated.rpc.ExtensionSource
-
The
projectvariant. - projectPath() - Method in record class com.github.copilot.sdk.generated.rpc.ServerSkill
-
Returns the value of the
projectPathrecord component. - projectPaths() - Method in record class com.github.copilot.sdk.generated.rpc.SkillsDiscoverParams
-
Returns the value of the
projectPathsrecord component. - prompt() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFleetStartParams
-
Returns the value of the
promptrecord component. - prompt() - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookInput
-
Returns the value of the
promptrecord component. - promptRequest() - Method in record class com.github.copilot.sdk.generated.PermissionRequestedEvent.PermissionRequestedEventData
-
Returns the value of the
promptRequestrecord component. - promptVersion() - Method in record class com.github.copilot.sdk.generated.SystemMessageMetadata
-
Returns the value of the
promptVersionrecord component. - PROPAGATE_AND_LOG_ERRORS - Enum constant in enum class com.github.copilot.sdk.EventErrorPolicy
-
Propagate errors: log the error and stop dispatch on first listener error (default).
- properties() - Method in record class com.github.copilot.sdk.generated.ElicitationRequestedSchema
-
Returns the value of the
propertiesrecord component. - properties() - Method in record class com.github.copilot.sdk.generated.rpc.UIElicitationSchema
-
Returns the value of the
propertiesrecord component. - protocolVersion() - Method in record class com.github.copilot.sdk.generated.rpc.PingResult
-
Returns the value of the
protocolVersionrecord component. - protocolVersion() - Method in record class com.github.copilot.sdk.json.PingResponse
-
Returns the value of the
protocolVersionrecord component. - providerCallId() - Method in record class com.github.copilot.sdk.generated.AssistantUsageEvent.AssistantUsageEventData
-
Returns the value of the
providerCallIdrecord component. - providerCallId() - Method in record class com.github.copilot.sdk.generated.SessionErrorEvent.SessionErrorEventData
-
Returns the value of the
providerCallIdrecord component. - ProviderConfig - Class in com.github.copilot.sdk.json
-
Configuration for a custom API provider (BYOK - Bring Your Own Key).
- ProviderConfig() - Constructor for class com.github.copilot.sdk.json.ProviderConfig
- publicClient() - Method in record class com.github.copilot.sdk.generated.McpOauthRequiredStaticClientConfig
-
Returns the value of the
publicClientrecord component.
Q
- question() - Method in record class com.github.copilot.sdk.generated.UserInputRequestedEvent.UserInputRequestedEventData
-
Returns the value of the
questionrecord component. - quotaSnapshots() - Method in record class com.github.copilot.sdk.generated.AssistantUsageEvent.AssistantUsageEventData
-
Returns the value of the
quotaSnapshotsrecord component. - quotaSnapshots() - Method in record class com.github.copilot.sdk.generated.rpc.AccountGetQuotaResult
-
Returns the value of the
quotaSnapshotsrecord component.
R
- read() - Method in class com.github.copilot.sdk.generated.rpc.SessionPlanApi
-
Invokes
session.plan.read. - readFile(SessionWorkspaceReadFileParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionWorkspaceApi
-
Invokes
session.workspace.readFile. - readFile(SessionWorkspacesReadFileParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionWorkspacesApi
-
Invokes
session.workspaces.readFile. - reason() - Method in record class com.github.copilot.sdk.generated.AbortEvent.AbortEventData
-
Returns the value of the
reasonrecord component. - reason() - Method in record class com.github.copilot.sdk.json.SessionEndHookInput
-
Returns the value of the
reasonrecord component. - reasoningEffort() - Method in record class com.github.copilot.sdk.generated.AssistantUsageEvent.AssistantUsageEventData
-
Returns the value of the
reasoningEffortrecord component. - reasoningEffort() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverrideSupports
-
Returns the value of the
reasoningEffortrecord component. - reasoningEffort() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesSupports
-
Returns the value of the
reasoningEffortrecord component. - reasoningEffort() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModelSwitchToParams
-
Returns the value of the
reasoningEffortrecord component. - reasoningEffort() - Method in record class com.github.copilot.sdk.generated.SessionModelChangeEvent.SessionModelChangeEventData
-
Returns the value of the
reasoningEffortrecord component. - reasoningEffort() - Method in record class com.github.copilot.sdk.generated.SessionResumeEvent.SessionResumeEventData
-
Returns the value of the
reasoningEffortrecord component. - reasoningEffort() - Method in record class com.github.copilot.sdk.generated.SessionStartEvent.SessionStartEventData
-
Returns the value of the
reasoningEffortrecord component. - reasoningId() - Method in record class com.github.copilot.sdk.generated.AssistantReasoningDeltaEvent.AssistantReasoningDeltaEventData
-
Returns the value of the
reasoningIdrecord component. - reasoningId() - Method in record class com.github.copilot.sdk.generated.AssistantReasoningEvent.AssistantReasoningEventData
-
Returns the value of the
reasoningIdrecord component. - reasoningOpaque() - Method in record class com.github.copilot.sdk.generated.AssistantMessageEvent.AssistantMessageEventData
-
Returns the value of the
reasoningOpaquerecord component. - reasoningText() - Method in record class com.github.copilot.sdk.generated.AssistantMessageEvent.AssistantMessageEventData
-
Returns the value of the
reasoningTextrecord component. - reasoningTokens() - Method in record class com.github.copilot.sdk.generated.AssistantUsageEvent.AssistantUsageEventData
-
Returns the value of the
reasoningTokensrecord component. - reasoningTokens() - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsModelMetricUsage
-
Returns the value of the
reasoningTokensrecord component. - reasoningTokens() - Method in record class com.github.copilot.sdk.generated.ShutdownModelMetricUsage
-
Returns the value of the
reasoningTokensrecord component. - recommendedAction() - Method in record class com.github.copilot.sdk.generated.ExitPlanModeRequestedEvent.ExitPlanModeRequestedEventData
-
Returns the value of the
recommendedActionrecord component. - recursive() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsMkdirParams
-
Returns the value of the
recursiverecord component. - recursive() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsRmParams
-
Returns the value of the
recursiverecord component. - REJECTED - Static variable in class com.github.copilot.sdk.json.PermissionRequestResultKind
-
The permission was denied interactively by the user.
- reload() - Method in class com.github.copilot.sdk.generated.rpc.SessionAgentApi
-
Invokes
session.agent.reload. - reload() - Method in class com.github.copilot.sdk.generated.rpc.SessionExtensionsApi
-
Invokes
session.extensions.reload. - reload() - Method in class com.github.copilot.sdk.generated.rpc.SessionMcpApi
-
Invokes
session.mcp.reload. - reload() - Method in class com.github.copilot.sdk.generated.rpc.SessionSkillsApi
-
Invokes
session.skills.reload. - remainingPercentage() - Method in record class com.github.copilot.sdk.generated.AssistantUsageQuotaSnapshot
-
Returns the value of the
remainingPercentagerecord component. - remainingPercentage() - Method in record class com.github.copilot.sdk.generated.rpc.AccountQuotaSnapshot
-
Returns the value of the
remainingPercentagerecord component. - REMOTE - Enum constant in enum class com.github.copilot.sdk.generated.HandoffSourceType
-
The
remotevariant. - remoteSessionId() - Method in record class com.github.copilot.sdk.generated.SessionHandoffEvent.SessionHandoffEventData
-
Returns the value of the
remoteSessionIdrecord component. - remoteSteerable() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
-
Returns the value of the
remoteSteerablerecord component. - remoteSteerable() - Method in record class com.github.copilot.sdk.generated.SessionRemoteSteerableChangedEvent.SessionRemoteSteerableChangedEventData
-
Returns the value of the
remoteSteerablerecord component. - remoteSteerable() - Method in record class com.github.copilot.sdk.generated.SessionResumeEvent.SessionResumeEventData
-
Returns the value of the
remoteSteerablerecord component. - remoteSteerable() - Method in record class com.github.copilot.sdk.generated.SessionStartEvent.SessionStartEventData
-
Returns the value of the
remoteSteerablerecord component. - remove(McpConfigRemoveParams) - Method in class com.github.copilot.sdk.generated.rpc.ServerMcpConfigApi
-
Invokes
mcp.config.remove. - REMOVE - Enum constant in enum class com.github.copilot.sdk.json.SectionOverrideAction
-
Remove the section from the prompt.
- REPLACE - Enum constant in enum class com.github.copilot.sdk.json.SectionOverrideAction
-
Replace the section content entirely.
- REPLACE - Enum constant in enum class com.github.copilot.sdk.SystemMessageMode
-
Replace the default system message entirely with the custom content.
- REPO - Enum constant in enum class com.github.copilot.sdk.generated.rpc.InstructionsSourcesType
-
The
repovariant. - REPO_AND_USER - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace.SessionWorkspacesGetWorkspaceResultWorkspaceSessionSyncLevel
-
The
repo_and_uservariant. - repository() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
-
Returns the value of the
repositoryrecord component. - repository() - Method in record class com.github.copilot.sdk.generated.SessionContextChangedEvent.SessionContextChangedEventData
-
Returns the value of the
repositoryrecord component. - repository() - Method in record class com.github.copilot.sdk.generated.SessionHandoffEvent.SessionHandoffEventData
-
Returns the value of the
repositoryrecord component. - repository() - Method in record class com.github.copilot.sdk.generated.WorkingDirectoryContext
-
Returns the value of the
repositoryrecord component. - REPOSITORY - Enum constant in enum class com.github.copilot.sdk.generated.rpc.InstructionsSourcesLocation
-
The
repositoryvariant. - repositoryHost() - Method in record class com.github.copilot.sdk.generated.SessionContextChangedEvent.SessionContextChangedEventData
-
Returns the value of the
repositoryHostrecord component. - repositoryHost() - Method in record class com.github.copilot.sdk.generated.WorkingDirectoryContext
-
Returns the value of the
repositoryHostrecord component. - requestedSchema() - Method in record class com.github.copilot.sdk.generated.ElicitationRequestedEvent.ElicitationRequestedEventData
-
Returns the value of the
requestedSchemarecord component. - requestedSchema() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUiElicitationParams
-
Returns the value of the
requestedSchemarecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.AssistantMessageEvent.AssistantMessageEventData
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.AutoModeSwitchCompletedEvent.AutoModeSwitchCompletedEventData
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.AutoModeSwitchRequestedEvent.AutoModeSwitchRequestedEventData
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.CommandCompletedEvent.CommandCompletedEventData
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.CommandExecuteEvent.CommandExecuteEventData
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.CommandQueuedEvent.CommandQueuedEventData
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.ElicitationCompletedEvent.ElicitationCompletedEventData
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.ElicitationRequestedEvent.ElicitationRequestedEventData
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.ExitPlanModeCompletedEvent.ExitPlanModeCompletedEventData
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.ExitPlanModeRequestedEvent.ExitPlanModeRequestedEventData
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.ExternalToolCompletedEvent.ExternalToolCompletedEventData
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.ExternalToolRequestedEvent.ExternalToolRequestedEventData
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.McpOauthCompletedEvent.McpOauthCompletedEventData
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.McpOauthRequiredEvent.McpOauthRequiredEventData
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.PermissionCompletedEvent.PermissionCompletedEventData
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.PermissionRequestedEvent.PermissionRequestedEventData
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionCommandsHandlePendingCommandParams
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsHandlePendingPermissionRequestParams
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionToolsHandlePendingToolCallParams
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUiHandlePendingElicitationParams
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.SamplingCompletedEvent.SamplingCompletedEventData
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.SamplingRequestedEvent.SamplingRequestedEventData
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent.SessionCompactionCompleteEventData
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.UserInputCompletedEvent.UserInputCompletedEventData
-
Returns the value of the
requestIdrecord component. - requestId() - Method in record class com.github.copilot.sdk.generated.UserInputRequestedEvent.UserInputRequestedEventData
-
Returns the value of the
requestIdrecord component. - requests() - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsModelMetric
-
Returns the value of the
requestsrecord component. - requests() - Method in record class com.github.copilot.sdk.generated.ShutdownModelMetric
-
Returns the value of the
requestsrecord component. - required() - Method in record class com.github.copilot.sdk.generated.ElicitationRequestedSchema
-
Returns the value of the
requiredrecord component. - required() - Method in record class com.github.copilot.sdk.generated.rpc.UIElicitationSchema
-
Returns the value of the
requiredrecord component. - resetDate() - Method in record class com.github.copilot.sdk.generated.AssistantUsageQuotaSnapshot
-
Returns the value of the
resetDaterecord component. - resetDate() - Method in record class com.github.copilot.sdk.generated.rpc.AccountQuotaSnapshot
-
Returns the value of the
resetDaterecord component. - resetSessionApprovals() - Method in class com.github.copilot.sdk.generated.rpc.SessionPermissionsApi
-
Invokes
session.permissions.resetSessionApprovals. - resolvedByHook() - Method in record class com.github.copilot.sdk.generated.PermissionRequestedEvent.PermissionRequestedEventData
-
Returns the value of the
resolvedByHookrecord component. - response() - Method in record class com.github.copilot.sdk.generated.AutoModeSwitchCompletedEvent.AutoModeSwitchCompletedEventData
-
Returns the value of the
responserecord component. - result() - Method in record class com.github.copilot.sdk.generated.PermissionCompletedEvent.PermissionCompletedEventData
-
Returns the value of the
resultrecord component. - result() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsHandlePendingPermissionRequestParams
-
Returns the value of the
resultrecord component. - result() - Method in record class com.github.copilot.sdk.generated.rpc.SessionToolsHandlePendingToolCallParams
-
Returns the value of the
resultrecord component. - result() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUiHandlePendingElicitationParams
-
Returns the value of the
resultrecord component. - result() - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteEvent.ToolExecutionCompleteEventData
-
Returns the value of the
resultrecord component. - resultType() - Method in record class com.github.copilot.sdk.json.ToolResultObject
-
Returns the value of the
resultTyperecord component. - resumeSession(String, ResumeSessionConfig) - Method in class com.github.copilot.sdk.CopilotClient
-
Resumes an existing Copilot session.
- ResumeSessionConfig - Class in com.github.copilot.sdk.json
-
Configuration for resuming an existing Copilot session.
- ResumeSessionConfig() - Constructor for class com.github.copilot.sdk.json.ResumeSessionConfig
- ResumeSessionRequest - Class in com.github.copilot.sdk.json
-
Internal request object for resuming an existing session.
- ResumeSessionRequest() - Constructor for class com.github.copilot.sdk.json.ResumeSessionRequest
- ResumeSessionResponse - Record Class in com.github.copilot.sdk.json
-
Internal response object from resuming a session.
- ResumeSessionResponse(String, String, SessionCapabilities) - Constructor for record class com.github.copilot.sdk.json.ResumeSessionResponse
-
Creates an instance of a
ResumeSessionResponserecord class. - resumeTime() - Method in record class com.github.copilot.sdk.generated.SessionResumeEvent.SessionResumeEventData
-
Returns the value of the
resumeTimerecord component. - role() - Method in record class com.github.copilot.sdk.generated.SystemMessageEvent.SystemMessageEventData
-
Returns the value of the
rolerecord component. - ROUTINE - Enum constant in enum class com.github.copilot.sdk.generated.ShutdownType
-
The
routinevariant. - RpcCaller - Interface in com.github.copilot.sdk.generated.rpc
-
Interface for invoking JSON-RPC methods with typed responses.
- RUNNING - Enum constant in enum class com.github.copilot.sdk.generated.ExtensionsLoadedExtensionStatus
-
The
runningvariant. - RUNNING - Enum constant in enum class com.github.copilot.sdk.generated.rpc.ExtensionStatus
-
The
runningvariant.
S
- SAFETY - Static variable in class com.github.copilot.sdk.json.SystemPromptSections
-
Environment limitations, prohibited actions, security policies.
- SamplingCompletedEvent - Class in com.github.copilot.sdk.generated
-
The
sampling.completedsession event. - SamplingCompletedEvent() - Constructor for class com.github.copilot.sdk.generated.SamplingCompletedEvent
- SamplingCompletedEvent.SamplingCompletedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SamplingCompletedEvent. - SamplingCompletedEventData(String) - Constructor for record class com.github.copilot.sdk.generated.SamplingCompletedEvent.SamplingCompletedEventData
-
Creates an instance of a
SamplingCompletedEventDatarecord class. - SamplingRequestedEvent - Class in com.github.copilot.sdk.generated
-
The
sampling.requestedsession event. - SamplingRequestedEvent() - Constructor for class com.github.copilot.sdk.generated.SamplingRequestedEvent
- SamplingRequestedEvent.SamplingRequestedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SamplingRequestedEvent. - SamplingRequestedEventData(String, String, Object) - Constructor for record class com.github.copilot.sdk.generated.SamplingRequestedEvent.SamplingRequestedEventData
-
Creates an instance of a
SamplingRequestedEventDatarecord class. - SdkProtocolVersion - Enum Class in com.github.copilot.sdk
-
Provides the SDK protocol version.
- SectionOverride - Class in com.github.copilot.sdk.json
-
Override operation for a single system prompt section in
SystemMessageMode#CUSTOMIZEmode. - SectionOverride() - Constructor for class com.github.copilot.sdk.json.SectionOverride
- SectionOverrideAction - Enum Class in com.github.copilot.sdk.json
-
Specifies the operation to perform on a system prompt section in
SystemMessageMode#CUSTOMIZEmode. - select(SessionAgentSelectParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionAgentApi
-
Invokes
session.agent.select. - select(String, String[]) - Method in interface com.github.copilot.sdk.json.SessionUiApi
-
Shows a selection dialog with the given options.
- selectAgent(String) - Method in class com.github.copilot.sdk.CopilotSession
-
Selects a custom agent for this session.
- selectedAction() - Method in record class com.github.copilot.sdk.generated.ExitPlanModeCompletedEvent.ExitPlanModeCompletedEventData
-
Returns the value of the
selectedActionrecord component. - selectedModel() - Method in record class com.github.copilot.sdk.generated.SessionResumeEvent.SessionResumeEventData
-
Returns the value of the
selectedModelrecord component. - selectedModel() - Method in record class com.github.copilot.sdk.generated.SessionStartEvent.SessionStartEventData
-
Returns the value of the
selectedModelrecord component. - send(MessageOptions) - Method in class com.github.copilot.sdk.CopilotSession
-
Sends a message to the Copilot session.
- send(String) - Method in class com.github.copilot.sdk.CopilotSession
-
Sends a simple text message to the Copilot session.
- sendAndWait(MessageOptions) - Method in class com.github.copilot.sdk.CopilotSession
-
Sends a message and waits until the session becomes idle with default 60 second timeout.
- sendAndWait(MessageOptions, long) - Method in class com.github.copilot.sdk.CopilotSession
-
Sends a message and waits until the session becomes idle.
- sendAndWait(String) - Method in class com.github.copilot.sdk.CopilotSession
-
Sends a simple text message and waits until the session becomes idle.
- SendMessageRequest - Class in com.github.copilot.sdk.json
-
Internal request object for sending a message to a session.
- SendMessageRequest() - Constructor for class com.github.copilot.sdk.json.SendMessageRequest
- SendMessageResponse - Record Class in com.github.copilot.sdk.json
-
Internal response object from sending a message.
- SendMessageResponse(String) - Constructor for record class com.github.copilot.sdk.json.SendMessageResponse
-
Creates an instance of a
SendMessageResponserecord class. - ServerAccountApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
accountnamespace. - ServerMcpApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
mcpnamespace. - ServerMcpConfigApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
mcp.confignamespace. - ServerModelsApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
modelsnamespace. - serverName() - Method in record class com.github.copilot.sdk.generated.McpOauthRequiredEvent.McpOauthRequiredEventData
-
Returns the value of the
serverNamerecord component. - serverName() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpDisableParams
-
Returns the value of the
serverNamerecord component. - serverName() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpEnableParams
-
Returns the value of the
serverNamerecord component. - serverName() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpOauthLoginParams
-
Returns the value of the
serverNamerecord component. - serverName() - Method in record class com.github.copilot.sdk.generated.SamplingRequestedEvent.SamplingRequestedEventData
-
Returns the value of the
serverNamerecord component. - serverName() - Method in record class com.github.copilot.sdk.generated.SessionMcpServerStatusChangedEvent.SessionMcpServerStatusChangedEventData
-
Returns the value of the
serverNamerecord component. - ServerRpc - Class in com.github.copilot.sdk.generated.rpc
-
Typed client for server-level RPC methods.
- ServerRpc(RpcCaller) - Constructor for class com.github.copilot.sdk.generated.rpc.ServerRpc
-
Creates a new server RPC client.
- servers() - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigListResult
-
Returns the value of the
serversrecord component. - servers() - Method in record class com.github.copilot.sdk.generated.rpc.McpDiscoverResult
-
Returns the value of the
serversrecord component. - servers() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpListResult
-
Returns the value of the
serversrecord component. - servers() - Method in record class com.github.copilot.sdk.generated.SessionMcpServersLoadedEvent.SessionMcpServersLoadedEventData
-
Returns the value of the
serversrecord component. - ServerSessionFsApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
sessionFsnamespace. - ServerSessionsApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
sessionsnamespace. - ServerSkill - Record Class in com.github.copilot.sdk.generated.rpc
- ServerSkill(String, String, String, Boolean, Boolean, String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.ServerSkill
-
Creates an instance of a
ServerSkillrecord class. - ServerSkillsApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
skillsnamespace. - ServerSkillsConfigApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
skills.confignamespace. - ServerToolsApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
toolsnamespace. - serverUrl() - Method in record class com.github.copilot.sdk.generated.McpOauthRequiredEvent.McpOauthRequiredEventData
-
Returns the value of the
serverUrlrecord component. - session() - Method in record class com.github.copilot.sdk.json.GetSessionMetadataResponse
-
Returns the value of the
sessionrecord component. - SessionAgentApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
agentnamespace. - SessionAgentDeselectParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.agent.deselectRPC method. - SessionAgentDeselectParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionAgentDeselectParams
-
Creates an instance of a
SessionAgentDeselectParamsrecord class. - SessionAgentDeselectResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.agent.deselectRPC method. - SessionAgentDeselectResult() - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionAgentDeselectResult
-
Creates an instance of a
SessionAgentDeselectResultrecord class. - SessionAgentGetCurrentParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.agent.getCurrentRPC method. - SessionAgentGetCurrentParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionAgentGetCurrentParams
-
Creates an instance of a
SessionAgentGetCurrentParamsrecord class. - SessionAgentGetCurrentResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.agent.getCurrentRPC method. - SessionAgentGetCurrentResult(AgentInfo) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionAgentGetCurrentResult
-
Creates an instance of a
SessionAgentGetCurrentResultrecord class. - SessionAgentListParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.agent.listRPC method. - SessionAgentListParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionAgentListParams
-
Creates an instance of a
SessionAgentListParamsrecord class. - SessionAgentListResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.agent.listRPC method. - SessionAgentListResult(List<AgentInfo>) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionAgentListResult
-
Creates an instance of a
SessionAgentListResultrecord class. - SessionAgentReloadParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.agent.reloadRPC method. - SessionAgentReloadParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionAgentReloadParams
-
Creates an instance of a
SessionAgentReloadParamsrecord class. - SessionAgentReloadResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.agent.reloadRPC method. - SessionAgentReloadResult(List<AgentInfo>) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionAgentReloadResult
-
Creates an instance of a
SessionAgentReloadResultrecord class. - SessionAgentSelectParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.agent.selectRPC method. - SessionAgentSelectParams(String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionAgentSelectParams
-
Creates an instance of a
SessionAgentSelectParamsrecord class. - SessionAgentSelectResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.agent.selectRPC method. - SessionAgentSelectResult(AgentInfo) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionAgentSelectResult
-
Creates an instance of a
SessionAgentSelectResultrecord class. - SessionAuthApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
authnamespace. - SessionAuthGetStatusParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.auth.getStatusRPC method. - SessionAuthGetStatusParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionAuthGetStatusParams
-
Creates an instance of a
SessionAuthGetStatusParamsrecord class. - SessionAuthGetStatusResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.auth.getStatusRPC method. - SessionAuthGetStatusResult(Boolean, AuthInfoType, String, String, String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionAuthGetStatusResult
-
Creates an instance of a
SessionAuthGetStatusResultrecord class. - SessionBackgroundTasksChangedEvent - Class in com.github.copilot.sdk.generated
-
The
session.background_tasks_changedsession event. - SessionBackgroundTasksChangedEvent() - Constructor for class com.github.copilot.sdk.generated.SessionBackgroundTasksChangedEvent
- SessionBackgroundTasksChangedEvent.SessionBackgroundTasksChangedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionBackgroundTasksChangedEvent. - SessionBackgroundTasksChangedEventData() - Constructor for record class com.github.copilot.sdk.generated.SessionBackgroundTasksChangedEvent.SessionBackgroundTasksChangedEventData
-
Creates an instance of a
SessionBackgroundTasksChangedEventDatarecord class. - SessionCapabilities - Class in com.github.copilot.sdk.json
-
Represents the capabilities reported by the host for a session.
- SessionCapabilities() - Constructor for class com.github.copilot.sdk.json.SessionCapabilities
- SessionCommandsApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
commandsnamespace. - SessionCommandsHandlePendingCommandParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.commands.handlePendingCommandRPC method. - SessionCommandsHandlePendingCommandParams(String, String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionCommandsHandlePendingCommandParams
-
Creates an instance of a
SessionCommandsHandlePendingCommandParamsrecord class. - SessionCommandsHandlePendingCommandResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.commands.handlePendingCommandRPC method. - SessionCommandsHandlePendingCommandResult(Boolean) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionCommandsHandlePendingCommandResult
-
Creates an instance of a
SessionCommandsHandlePendingCommandResultrecord class. - SessionCompactionCompleteEvent - Class in com.github.copilot.sdk.generated
-
The
session.compaction_completesession event. - SessionCompactionCompleteEvent() - Constructor for class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent
- SessionCompactionCompleteEvent.SessionCompactionCompleteEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionCompactionCompleteEvent. - SessionCompactionCompleteEventData(Boolean, String, Double, Double, Double, Double, Double, String, Double, String, CompactionCompleteCompactionTokensUsed, String, Double, Double, Double) - Constructor for record class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent.SessionCompactionCompleteEventData
-
Creates an instance of a
SessionCompactionCompleteEventDatarecord class. - SessionCompactionStartEvent - Class in com.github.copilot.sdk.generated
-
The
session.compaction_startsession event. - SessionCompactionStartEvent() - Constructor for class com.github.copilot.sdk.generated.SessionCompactionStartEvent
- SessionCompactionStartEvent.SessionCompactionStartEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionCompactionStartEvent. - SessionCompactionStartEventData(Double, Double, Double) - Constructor for record class com.github.copilot.sdk.generated.SessionCompactionStartEvent.SessionCompactionStartEventData
-
Creates an instance of a
SessionCompactionStartEventDatarecord class. - SessionConfig - Class in com.github.copilot.sdk.json
-
Configuration for creating a new Copilot session.
- SessionConfig() - Constructor for class com.github.copilot.sdk.json.SessionConfig
- SessionContext - Class in com.github.copilot.sdk.json
-
Working directory context for a session.
- SessionContext() - Constructor for class com.github.copilot.sdk.json.SessionContext
- SessionContextChangedEvent - Class in com.github.copilot.sdk.generated
-
The
session.context_changedsession event. - SessionContextChangedEvent() - Constructor for class com.github.copilot.sdk.generated.SessionContextChangedEvent
- SessionContextChangedEvent.SessionContextChangedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionContextChangedEvent. - SessionContextChangedEventData(String, String, String, WorkingDirectoryContextHostType, String, String, String, String) - Constructor for record class com.github.copilot.sdk.generated.SessionContextChangedEvent.SessionContextChangedEventData
-
Creates an instance of a
SessionContextChangedEventDatarecord class. - SessionCustomAgentsUpdatedEvent - Class in com.github.copilot.sdk.generated
-
The
session.custom_agents_updatedsession event. - SessionCustomAgentsUpdatedEvent() - Constructor for class com.github.copilot.sdk.generated.SessionCustomAgentsUpdatedEvent
- SessionCustomAgentsUpdatedEvent.SessionCustomAgentsUpdatedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionCustomAgentsUpdatedEvent. - SessionCustomAgentsUpdatedEventData(List<CustomAgentsUpdatedAgent>, List<String>, List<String>) - Constructor for record class com.github.copilot.sdk.generated.SessionCustomAgentsUpdatedEvent.SessionCustomAgentsUpdatedEventData
-
Creates an instance of a
SessionCustomAgentsUpdatedEventDatarecord class. - SessionEndHandler - Interface in com.github.copilot.sdk.json
-
Handler for session-end hooks.
- SessionEndHookInput - Record Class in com.github.copilot.sdk.json
-
Input for a session-end hook.
- SessionEndHookInput(long, String, String, String, String) - Constructor for record class com.github.copilot.sdk.json.SessionEndHookInput
-
Creates an instance of a
SessionEndHookInputrecord class. - SessionEndHookOutput - Record Class in com.github.copilot.sdk.json
-
Output for a session-end hook.
- SessionEndHookOutput(Boolean, List<String>, String) - Constructor for record class com.github.copilot.sdk.json.SessionEndHookOutput
-
Creates an instance of a
SessionEndHookOutputrecord class. - SessionErrorEvent - Class in com.github.copilot.sdk.generated
-
The
session.errorsession event. - SessionErrorEvent() - Constructor for class com.github.copilot.sdk.generated.SessionErrorEvent
- SessionErrorEvent.SessionErrorEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionErrorEvent. - SessionErrorEventData(String, String, String, Long, String, String) - Constructor for record class com.github.copilot.sdk.generated.SessionErrorEvent.SessionErrorEventData
-
Creates an instance of a
SessionErrorEventDatarecord class. - SessionEvent - Class in com.github.copilot.sdk.generated
-
Base class for all generated session events.
- SessionEvent() - Constructor for class com.github.copilot.sdk.generated.SessionEvent
- SessionExtensionsApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
extensionsnamespace. - SessionExtensionsDisableParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.extensions.disableRPC method. - SessionExtensionsDisableParams(String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionExtensionsDisableParams
-
Creates an instance of a
SessionExtensionsDisableParamsrecord class. - SessionExtensionsDisableResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.extensions.disableRPC method. - SessionExtensionsDisableResult() - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionExtensionsDisableResult
-
Creates an instance of a
SessionExtensionsDisableResultrecord class. - SessionExtensionsEnableParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.extensions.enableRPC method. - SessionExtensionsEnableParams(String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionExtensionsEnableParams
-
Creates an instance of a
SessionExtensionsEnableParamsrecord class. - SessionExtensionsEnableResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.extensions.enableRPC method. - SessionExtensionsEnableResult() - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionExtensionsEnableResult
-
Creates an instance of a
SessionExtensionsEnableResultrecord class. - SessionExtensionsListParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.extensions.listRPC method. - SessionExtensionsListParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionExtensionsListParams
-
Creates an instance of a
SessionExtensionsListParamsrecord class. - SessionExtensionsListResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.extensions.listRPC method. - SessionExtensionsListResult(List<Extension>) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionExtensionsListResult
-
Creates an instance of a
SessionExtensionsListResultrecord class. - SessionExtensionsLoadedEvent - Class in com.github.copilot.sdk.generated
-
The
session.extensions_loadedsession event. - SessionExtensionsLoadedEvent() - Constructor for class com.github.copilot.sdk.generated.SessionExtensionsLoadedEvent
- SessionExtensionsLoadedEvent.SessionExtensionsLoadedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionExtensionsLoadedEvent. - SessionExtensionsLoadedEventData(List<ExtensionsLoadedExtension>) - Constructor for record class com.github.copilot.sdk.generated.SessionExtensionsLoadedEvent.SessionExtensionsLoadedEventData
-
Creates an instance of a
SessionExtensionsLoadedEventDatarecord class. - SessionExtensionsReloadParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.extensions.reloadRPC method. - SessionExtensionsReloadParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionExtensionsReloadParams
-
Creates an instance of a
SessionExtensionsReloadParamsrecord class. - SessionExtensionsReloadResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.extensions.reloadRPC method. - SessionExtensionsReloadResult() - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionExtensionsReloadResult
-
Creates an instance of a
SessionExtensionsReloadResultrecord class. - SessionFleetApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
fleetnamespace. - SessionFleetStartParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.fleet.startRPC method. - SessionFleetStartParams(String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionFleetStartParams
-
Creates an instance of a
SessionFleetStartParamsrecord class. - SessionFleetStartResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.fleet.startRPC method. - SessionFleetStartResult(Boolean) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionFleetStartResult
-
Creates an instance of a
SessionFleetStartResultrecord class. - sessionFs - Variable in class com.github.copilot.sdk.generated.rpc.ServerRpc
-
API methods for the
sessionFsnamespace. - SessionFsAppendFileParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
sessionFs.appendFileRPC method. - SessionFsAppendFileParams(String, String, String, Long) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionFsAppendFileParams
-
Creates an instance of a
SessionFsAppendFileParamsrecord class. - SessionFsError - Record Class in com.github.copilot.sdk.generated.rpc
-
Describes a filesystem error.
- SessionFsError(SessionFsErrorCode, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionFsError
-
Creates an instance of a
SessionFsErrorrecord class. - SessionFsErrorCode - Enum Class in com.github.copilot.sdk.generated.rpc
-
Error classification
- SessionFsExistsParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
sessionFs.existsRPC method. - SessionFsExistsParams(String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionFsExistsParams
-
Creates an instance of a
SessionFsExistsParamsrecord class. - SessionFsExistsResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
sessionFs.existsRPC method. - SessionFsExistsResult(Boolean) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionFsExistsResult
-
Creates an instance of a
SessionFsExistsResultrecord class. - SessionFsMkdirParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
sessionFs.mkdirRPC method. - SessionFsMkdirParams(String, String, Boolean, Long) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionFsMkdirParams
-
Creates an instance of a
SessionFsMkdirParamsrecord class. - SessionFsReaddirParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
sessionFs.readdirRPC method. - SessionFsReaddirParams(String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirParams
-
Creates an instance of a
SessionFsReaddirParamsrecord class. - SessionFsReaddirResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
sessionFs.readdirRPC method. - SessionFsReaddirResult(List<String>, SessionFsError) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirResult
-
Creates an instance of a
SessionFsReaddirResultrecord class. - SessionFsReaddirWithTypesEntry - Record Class in com.github.copilot.sdk.generated.rpc
- SessionFsReaddirWithTypesEntry(String, SessionFsReaddirWithTypesEntryType) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesEntry
-
Creates an instance of a
SessionFsReaddirWithTypesEntryrecord class. - SessionFsReaddirWithTypesEntryType - Enum Class in com.github.copilot.sdk.generated.rpc
-
Entry type
- SessionFsReaddirWithTypesParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
sessionFs.readdirWithTypesRPC method. - SessionFsReaddirWithTypesParams(String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesParams
-
Creates an instance of a
SessionFsReaddirWithTypesParamsrecord class. - SessionFsReaddirWithTypesResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
sessionFs.readdirWithTypesRPC method. - SessionFsReaddirWithTypesResult(List<SessionFsReaddirWithTypesEntry>, SessionFsError) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesResult
-
Creates an instance of a
SessionFsReaddirWithTypesResultrecord class. - SessionFsReadFileParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
sessionFs.readFileRPC method. - SessionFsReadFileParams(String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionFsReadFileParams
-
Creates an instance of a
SessionFsReadFileParamsrecord class. - SessionFsReadFileResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
sessionFs.readFileRPC method. - SessionFsReadFileResult(String, SessionFsError) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionFsReadFileResult
-
Creates an instance of a
SessionFsReadFileResultrecord class. - SessionFsRenameParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
sessionFs.renameRPC method. - SessionFsRenameParams(String, String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionFsRenameParams
-
Creates an instance of a
SessionFsRenameParamsrecord class. - SessionFsRmParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
sessionFs.rmRPC method. - SessionFsRmParams(String, String, Boolean, Boolean) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionFsRmParams
-
Creates an instance of a
SessionFsRmParamsrecord class. - SessionFsSetProviderConventions - Enum Class in com.github.copilot.sdk.generated.rpc
-
Path conventions used by this filesystem
- SessionFsSetProviderParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
sessionFs.setProviderRPC method. - SessionFsSetProviderParams(String, String, SessionFsSetProviderConventions) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionFsSetProviderParams
-
Creates an instance of a
SessionFsSetProviderParamsrecord class. - SessionFsSetProviderResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
sessionFs.setProviderRPC method. - SessionFsSetProviderResult(Boolean) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionFsSetProviderResult
-
Creates an instance of a
SessionFsSetProviderResultrecord class. - SessionFsStatParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
sessionFs.statRPC method. - SessionFsStatParams(String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionFsStatParams
-
Creates an instance of a
SessionFsStatParamsrecord class. - SessionFsStatResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
sessionFs.statRPC method. - SessionFsStatResult(Boolean, Boolean, Long, OffsetDateTime, OffsetDateTime, SessionFsError) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionFsStatResult
-
Creates an instance of a
SessionFsStatResultrecord class. - SessionFsWriteFileParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
sessionFs.writeFileRPC method. - SessionFsWriteFileParams(String, String, String, Long) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionFsWriteFileParams
-
Creates an instance of a
SessionFsWriteFileParamsrecord class. - SessionHandoffEvent - Class in com.github.copilot.sdk.generated
-
The
session.handoffsession event. - SessionHandoffEvent() - Constructor for class com.github.copilot.sdk.generated.SessionHandoffEvent
- SessionHandoffEvent.SessionHandoffEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionHandoffEvent. - SessionHandoffEventData(OffsetDateTime, HandoffSourceType, HandoffRepository, String, String, String, String) - Constructor for record class com.github.copilot.sdk.generated.SessionHandoffEvent.SessionHandoffEventData
-
Creates an instance of a
SessionHandoffEventDatarecord class. - SessionHistoryApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
historynamespace. - SessionHistoryCompactParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.history.compactRPC method. - SessionHistoryCompactParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionHistoryCompactParams
-
Creates an instance of a
SessionHistoryCompactParamsrecord class. - SessionHistoryCompactResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.history.compactRPC method. - SessionHistoryCompactResult(Boolean, Long, Long, HistoryCompactContextWindow) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionHistoryCompactResult
-
Creates an instance of a
SessionHistoryCompactResultrecord class. - SessionHistoryTruncateParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.history.truncateRPC method. - SessionHistoryTruncateParams(String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionHistoryTruncateParams
-
Creates an instance of a
SessionHistoryTruncateParamsrecord class. - SessionHistoryTruncateResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.history.truncateRPC method. - SessionHistoryTruncateResult(Long) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionHistoryTruncateResult
-
Creates an instance of a
SessionHistoryTruncateResultrecord class. - SessionHooks - Class in com.github.copilot.sdk.json
-
Hook handlers configuration for a session.
- SessionHooks() - Constructor for class com.github.copilot.sdk.json.SessionHooks
- sessionId() - Method in record class com.github.copilot.sdk.generated.ExternalToolRequestedEvent.ExternalToolRequestedEventData
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentDeselectParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentGetCurrentParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentListParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentReloadParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentSelectParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAuthGetStatusParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionCommandsHandlePendingCommandParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsDisableParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsEnableParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsListParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsReloadParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFleetStartParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsAppendFileParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsExistsParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsMkdirParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReadFileParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsRenameParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsRmParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsStatParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsWriteFileParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionHistoryCompactParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionHistoryTruncateParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionInstructionsGetSourcesParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionLogParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpDisableParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpEnableParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpListParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpOauthLoginParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpReloadParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModeGetParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModelGetCurrentParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModelSwitchToParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModeSetParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionNameGetParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionNameSetParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsHandlePendingPermissionRequestParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsResetSessionApprovalsParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsSetApproveAllParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanDeleteParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanReadParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanUpdateParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPluginsListParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionsForkParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionsForkResult
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionShellExecParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionShellKillParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsDisableParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsEnableParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsListParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsReloadParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionToolsHandlePendingToolCallParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUiElicitationParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUiHandlePendingElicitationParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUsageGetMetricsParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceCreateFileParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceListFilesParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceReadFileParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesCreateFileParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesListFilesParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesReadFileParams
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.generated.SessionStartEvent.SessionStartEventData
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.json.CreateSessionResponse
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.json.GetForegroundSessionResponse
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.json.GetLastSessionIdResponse
-
Returns the value of the
sessionIdrecord component. - sessionId() - Method in record class com.github.copilot.sdk.json.ResumeSessionResponse
-
Returns the value of the
sessionIdrecord component. - SessionIdleEvent - Class in com.github.copilot.sdk.generated
-
The
session.idlesession event. - SessionIdleEvent() - Constructor for class com.github.copilot.sdk.generated.SessionIdleEvent
- SessionIdleEvent.SessionIdleEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionIdleEvent. - SessionIdleEventData(Boolean) - Constructor for record class com.github.copilot.sdk.generated.SessionIdleEvent.SessionIdleEventData
-
Creates an instance of a
SessionIdleEventDatarecord class. - SessionInfoEvent - Class in com.github.copilot.sdk.generated
-
The
session.infosession event. - SessionInfoEvent() - Constructor for class com.github.copilot.sdk.generated.SessionInfoEvent
- SessionInfoEvent.SessionInfoEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionInfoEvent. - SessionInfoEventData(String, String, String) - Constructor for record class com.github.copilot.sdk.generated.SessionInfoEvent.SessionInfoEventData
-
Creates an instance of a
SessionInfoEventDatarecord class. - SessionInstructionsApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
instructionsnamespace. - SessionInstructionsGetSourcesParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.instructions.getSourcesRPC method. - SessionInstructionsGetSourcesParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionInstructionsGetSourcesParams
-
Creates an instance of a
SessionInstructionsGetSourcesParamsrecord class. - SessionInstructionsGetSourcesResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.instructions.getSourcesRPC method. - SessionInstructionsGetSourcesResult(List<InstructionsSources>) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionInstructionsGetSourcesResult
-
Creates an instance of a
SessionInstructionsGetSourcesResultrecord class. - SessionLifecycleEvent - Class in com.github.copilot.sdk.json
-
Session lifecycle event notification.
- SessionLifecycleEvent() - Constructor for class com.github.copilot.sdk.json.SessionLifecycleEvent
- SessionLifecycleEventMetadata - Record Class in com.github.copilot.sdk.json
-
Metadata for session lifecycle events.
- SessionLifecycleEventMetadata(String, String, String) - Constructor for record class com.github.copilot.sdk.json.SessionLifecycleEventMetadata
-
Creates an instance of a
SessionLifecycleEventMetadatarecord class. - SessionLifecycleEventTypes - Class in com.github.copilot.sdk.json
-
Types of session lifecycle events.
- SessionLifecycleHandler - Interface in com.github.copilot.sdk.json
-
Handler for session lifecycle events.
- SessionListFilter - Class in com.github.copilot.sdk.json
-
Filter options for listing sessions.
- SessionListFilter() - Constructor for class com.github.copilot.sdk.json.SessionListFilter
- sessionLog() - Method in record class com.github.copilot.sdk.json.ToolResultObject
-
Returns the value of the
sessionLogrecord component. - SessionLogLevel - Enum Class in com.github.copilot.sdk.generated.rpc
-
Log severity level.
- SessionLogParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.logRPC method. - SessionLogParams(String, String, SessionLogLevel, Boolean, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionLogParams
-
Creates an instance of a
SessionLogParamsrecord class. - SessionLogResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.logRPC method. - SessionLogResult(UUID) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionLogResult
-
Creates an instance of a
SessionLogResultrecord class. - SessionMcpApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
mcpnamespace. - SessionMcpDisableParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.mcp.disableRPC method. - SessionMcpDisableParams(String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionMcpDisableParams
-
Creates an instance of a
SessionMcpDisableParamsrecord class. - SessionMcpDisableResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.mcp.disableRPC method. - SessionMcpDisableResult() - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionMcpDisableResult
-
Creates an instance of a
SessionMcpDisableResultrecord class. - SessionMcpEnableParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.mcp.enableRPC method. - SessionMcpEnableParams(String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionMcpEnableParams
-
Creates an instance of a
SessionMcpEnableParamsrecord class. - SessionMcpEnableResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.mcp.enableRPC method. - SessionMcpEnableResult() - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionMcpEnableResult
-
Creates an instance of a
SessionMcpEnableResultrecord class. - SessionMcpListParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.mcp.listRPC method. - SessionMcpListParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionMcpListParams
-
Creates an instance of a
SessionMcpListParamsrecord class. - SessionMcpListResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.mcp.listRPC method. - SessionMcpListResult(List<McpServer>) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionMcpListResult
-
Creates an instance of a
SessionMcpListResultrecord class. - SessionMcpOauthApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
mcp.oauthnamespace. - SessionMcpOauthLoginParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.mcp.oauth.loginRPC method. - SessionMcpOauthLoginParams(String, String, Boolean, String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionMcpOauthLoginParams
-
Creates an instance of a
SessionMcpOauthLoginParamsrecord class. - SessionMcpOauthLoginResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.mcp.oauth.loginRPC method. - SessionMcpOauthLoginResult(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionMcpOauthLoginResult
-
Creates an instance of a
SessionMcpOauthLoginResultrecord class. - SessionMcpReloadParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.mcp.reloadRPC method. - SessionMcpReloadParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionMcpReloadParams
-
Creates an instance of a
SessionMcpReloadParamsrecord class. - SessionMcpReloadResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.mcp.reloadRPC method. - SessionMcpReloadResult() - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionMcpReloadResult
-
Creates an instance of a
SessionMcpReloadResultrecord class. - SessionMcpServersLoadedEvent - Class in com.github.copilot.sdk.generated
-
The
session.mcp_servers_loadedsession event. - SessionMcpServersLoadedEvent() - Constructor for class com.github.copilot.sdk.generated.SessionMcpServersLoadedEvent
- SessionMcpServersLoadedEvent.SessionMcpServersLoadedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionMcpServersLoadedEvent. - SessionMcpServersLoadedEventData(List<McpServersLoadedServer>) - Constructor for record class com.github.copilot.sdk.generated.SessionMcpServersLoadedEvent.SessionMcpServersLoadedEventData
-
Creates an instance of a
SessionMcpServersLoadedEventDatarecord class. - SessionMcpServerStatusChangedEvent - Class in com.github.copilot.sdk.generated
-
The
session.mcp_server_status_changedsession event. - SessionMcpServerStatusChangedEvent() - Constructor for class com.github.copilot.sdk.generated.SessionMcpServerStatusChangedEvent
- SessionMcpServerStatusChangedEvent.SessionMcpServerStatusChangedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionMcpServerStatusChangedEvent. - SessionMcpServerStatusChangedEventData(String, McpServerStatusChangedStatus) - Constructor for record class com.github.copilot.sdk.generated.SessionMcpServerStatusChangedEvent.SessionMcpServerStatusChangedEventData
-
Creates an instance of a
SessionMcpServerStatusChangedEventDatarecord class. - SessionMetadata - Class in com.github.copilot.sdk.json
-
Metadata about an existing Copilot session.
- SessionMetadata() - Constructor for class com.github.copilot.sdk.json.SessionMetadata
- SessionMode - Enum Class in com.github.copilot.sdk.generated.rpc
-
The agent mode.
- SessionModeApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
modenamespace. - SessionModeChangedEvent - Class in com.github.copilot.sdk.generated
-
The
session.mode_changedsession event. - SessionModeChangedEvent() - Constructor for class com.github.copilot.sdk.generated.SessionModeChangedEvent
- SessionModeChangedEvent.SessionModeChangedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionModeChangedEvent. - SessionModeChangedEventData(String, String) - Constructor for record class com.github.copilot.sdk.generated.SessionModeChangedEvent.SessionModeChangedEventData
-
Creates an instance of a
SessionModeChangedEventDatarecord class. - SessionModeGetParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.mode.getRPC method. - SessionModeGetParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionModeGetParams
-
Creates an instance of a
SessionModeGetParamsrecord class. - SessionModeGetResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.mode.getRPC method. - SessionModeGetResult(SessionModeGetResult.SessionModeGetResultMode) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionModeGetResult
-
Creates an instance of a
SessionModeGetResultrecord class. - SessionModeGetResult.SessionModeGetResultMode - Enum Class in com.github.copilot.sdk.generated.rpc
-
The current agent mode.
- SessionModelApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
modelnamespace. - SessionModelChangeEvent - Class in com.github.copilot.sdk.generated
-
The
session.model_changesession event. - SessionModelChangeEvent() - Constructor for class com.github.copilot.sdk.generated.SessionModelChangeEvent
- SessionModelChangeEvent.SessionModelChangeEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionModelChangeEvent. - SessionModelChangeEventData(String, String, String, String) - Constructor for record class com.github.copilot.sdk.generated.SessionModelChangeEvent.SessionModelChangeEventData
-
Creates an instance of a
SessionModelChangeEventDatarecord class. - SessionModelGetCurrentParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.model.getCurrentRPC method. - SessionModelGetCurrentParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionModelGetCurrentParams
-
Creates an instance of a
SessionModelGetCurrentParamsrecord class. - SessionModelGetCurrentResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.model.getCurrentRPC method. - SessionModelGetCurrentResult(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionModelGetCurrentResult
-
Creates an instance of a
SessionModelGetCurrentResultrecord class. - SessionModelSwitchToParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.model.switchToRPC method. - SessionModelSwitchToParams(String, String, String, ModelCapabilitiesOverride) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionModelSwitchToParams
-
Creates an instance of a
SessionModelSwitchToParamsrecord class. - SessionModelSwitchToResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.model.switchToRPC method. - SessionModelSwitchToResult(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionModelSwitchToResult
-
Creates an instance of a
SessionModelSwitchToResultrecord class. - SessionModeSetParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.mode.setRPC method. - SessionModeSetParams(String, SessionMode) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionModeSetParams
-
Creates an instance of a
SessionModeSetParamsrecord class. - SessionModeSetResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.mode.setRPC method. - SessionModeSetResult(SessionModeSetResult.SessionModeSetResultMode) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionModeSetResult
-
Creates an instance of a
SessionModeSetResultrecord class. - SessionModeSetResult.SessionModeSetResultMode - Enum Class in com.github.copilot.sdk.generated.rpc
-
The agent mode after switching.
- SessionNameApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
namenamespace. - SessionNameGetParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.name.getRPC method. - SessionNameGetParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionNameGetParams
-
Creates an instance of a
SessionNameGetParamsrecord class. - SessionNameGetResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.name.getRPC method. - SessionNameGetResult(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionNameGetResult
-
Creates an instance of a
SessionNameGetResultrecord class. - SessionNameSetParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.name.setRPC method. - SessionNameSetParams(String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionNameSetParams
-
Creates an instance of a
SessionNameSetParamsrecord class. - SessionPermissionsApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
permissionsnamespace. - SessionPermissionsHandlePendingPermissionRequestParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.permissions.handlePendingPermissionRequestRPC method. - SessionPermissionsHandlePendingPermissionRequestParams(String, String, Object) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionPermissionsHandlePendingPermissionRequestParams
-
Creates an instance of a
SessionPermissionsHandlePendingPermissionRequestParamsrecord class. - SessionPermissionsHandlePendingPermissionRequestResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.permissions.handlePendingPermissionRequestRPC method. - SessionPermissionsHandlePendingPermissionRequestResult(Boolean) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionPermissionsHandlePendingPermissionRequestResult
-
Creates an instance of a
SessionPermissionsHandlePendingPermissionRequestResultrecord class. - SessionPermissionsResetSessionApprovalsParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.permissions.resetSessionApprovalsRPC method. - SessionPermissionsResetSessionApprovalsParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionPermissionsResetSessionApprovalsParams
-
Creates an instance of a
SessionPermissionsResetSessionApprovalsParamsrecord class. - SessionPermissionsResetSessionApprovalsResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.permissions.resetSessionApprovalsRPC method. - SessionPermissionsResetSessionApprovalsResult(Boolean) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionPermissionsResetSessionApprovalsResult
-
Creates an instance of a
SessionPermissionsResetSessionApprovalsResultrecord class. - SessionPermissionsSetApproveAllParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.permissions.setApproveAllRPC method. - SessionPermissionsSetApproveAllParams(String, Boolean) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionPermissionsSetApproveAllParams
-
Creates an instance of a
SessionPermissionsSetApproveAllParamsrecord class. - SessionPermissionsSetApproveAllResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.permissions.setApproveAllRPC method. - SessionPermissionsSetApproveAllResult(Boolean) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionPermissionsSetApproveAllResult
-
Creates an instance of a
SessionPermissionsSetApproveAllResultrecord class. - SessionPlanApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
plannamespace. - SessionPlanChangedEvent - Class in com.github.copilot.sdk.generated
-
The
session.plan_changedsession event. - SessionPlanChangedEvent() - Constructor for class com.github.copilot.sdk.generated.SessionPlanChangedEvent
- SessionPlanChangedEvent.SessionPlanChangedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionPlanChangedEvent. - SessionPlanChangedEventData(PlanChangedOperation) - Constructor for record class com.github.copilot.sdk.generated.SessionPlanChangedEvent.SessionPlanChangedEventData
-
Creates an instance of a
SessionPlanChangedEventDatarecord class. - SessionPlanDeleteParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.plan.deleteRPC method. - SessionPlanDeleteParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionPlanDeleteParams
-
Creates an instance of a
SessionPlanDeleteParamsrecord class. - SessionPlanDeleteResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.plan.deleteRPC method. - SessionPlanDeleteResult() - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionPlanDeleteResult
-
Creates an instance of a
SessionPlanDeleteResultrecord class. - SessionPlanReadParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.plan.readRPC method. - SessionPlanReadParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionPlanReadParams
-
Creates an instance of a
SessionPlanReadParamsrecord class. - SessionPlanReadResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.plan.readRPC method. - SessionPlanReadResult(Boolean, String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionPlanReadResult
-
Creates an instance of a
SessionPlanReadResultrecord class. - SessionPlanUpdateParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.plan.updateRPC method. - SessionPlanUpdateParams(String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionPlanUpdateParams
-
Creates an instance of a
SessionPlanUpdateParamsrecord class. - SessionPlanUpdateResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.plan.updateRPC method. - SessionPlanUpdateResult() - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionPlanUpdateResult
-
Creates an instance of a
SessionPlanUpdateResultrecord class. - SessionPluginsApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
pluginsnamespace. - SessionPluginsListParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.plugins.listRPC method. - SessionPluginsListParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionPluginsListParams
-
Creates an instance of a
SessionPluginsListParamsrecord class. - SessionPluginsListResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.plugins.listRPC method. - SessionPluginsListResult(List<Plugin>) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionPluginsListResult
-
Creates an instance of a
SessionPluginsListResultrecord class. - SessionRemoteSteerableChangedEvent - Class in com.github.copilot.sdk.generated
-
The
session.remote_steerable_changedsession event. - SessionRemoteSteerableChangedEvent() - Constructor for class com.github.copilot.sdk.generated.SessionRemoteSteerableChangedEvent
- SessionRemoteSteerableChangedEvent.SessionRemoteSteerableChangedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionRemoteSteerableChangedEvent. - SessionRemoteSteerableChangedEventData(Boolean) - Constructor for record class com.github.copilot.sdk.generated.SessionRemoteSteerableChangedEvent.SessionRemoteSteerableChangedEventData
-
Creates an instance of a
SessionRemoteSteerableChangedEventDatarecord class. - SessionResumeEvent - Class in com.github.copilot.sdk.generated
-
The
session.resumesession event. - SessionResumeEvent() - Constructor for class com.github.copilot.sdk.generated.SessionResumeEvent
- SessionResumeEvent.SessionResumeEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionResumeEvent. - SessionResumeEventData(OffsetDateTime, Double, String, String, WorkingDirectoryContext, Boolean, Boolean) - Constructor for record class com.github.copilot.sdk.generated.SessionResumeEvent.SessionResumeEventData
-
Creates an instance of a
SessionResumeEventDatarecord class. - SessionRpc - Class in com.github.copilot.sdk.generated.rpc
-
Typed client for session-scoped RPC methods.
- SessionRpc(RpcCaller, String) - Constructor for class com.github.copilot.sdk.generated.rpc.SessionRpc
-
Creates a new session RPC client.
- sessions - Variable in class com.github.copilot.sdk.generated.rpc.ServerRpc
-
API methods for the
sessionsnamespace. - sessions() - Method in record class com.github.copilot.sdk.json.ListSessionsResponse
-
Returns the value of the
sessionsrecord component. - SessionsForkParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
sessions.forkRPC method. - SessionsForkParams(String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionsForkParams
-
Creates an instance of a
SessionsForkParamsrecord class. - SessionsForkResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
sessions.forkRPC method. - SessionsForkResult(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionsForkResult
-
Creates an instance of a
SessionsForkResultrecord class. - SessionShellApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
shellnamespace. - SessionShellExecParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.shell.execRPC method. - SessionShellExecParams(String, String, String, Long) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionShellExecParams
-
Creates an instance of a
SessionShellExecParamsrecord class. - SessionShellExecResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.shell.execRPC method. - SessionShellExecResult(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionShellExecResult
-
Creates an instance of a
SessionShellExecResultrecord class. - SessionShellKillParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.shell.killRPC method. - SessionShellKillParams(String, String, ShellKillSignal) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionShellKillParams
-
Creates an instance of a
SessionShellKillParamsrecord class. - SessionShellKillResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.shell.killRPC method. - SessionShellKillResult(Boolean) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionShellKillResult
-
Creates an instance of a
SessionShellKillResultrecord class. - SessionShutdownEvent - Class in com.github.copilot.sdk.generated
-
The
session.shutdownsession event. - SessionShutdownEvent() - Constructor for class com.github.copilot.sdk.generated.SessionShutdownEvent
- SessionShutdownEvent.SessionShutdownEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionShutdownEvent. - SessionShutdownEventData(ShutdownType, String, Double, Double, Double, ShutdownCodeChanges, Map<String, ShutdownModelMetric>, String, Double, Double, Double, Double) - Constructor for record class com.github.copilot.sdk.generated.SessionShutdownEvent.SessionShutdownEventData
-
Creates an instance of a
SessionShutdownEventDatarecord class. - SessionSkillsApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
skillsnamespace. - SessionSkillsDisableParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.skills.disableRPC method. - SessionSkillsDisableParams(String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionSkillsDisableParams
-
Creates an instance of a
SessionSkillsDisableParamsrecord class. - SessionSkillsDisableResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.skills.disableRPC method. - SessionSkillsDisableResult() - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionSkillsDisableResult
-
Creates an instance of a
SessionSkillsDisableResultrecord class. - SessionSkillsEnableParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.skills.enableRPC method. - SessionSkillsEnableParams(String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionSkillsEnableParams
-
Creates an instance of a
SessionSkillsEnableParamsrecord class. - SessionSkillsEnableResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.skills.enableRPC method. - SessionSkillsEnableResult() - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionSkillsEnableResult
-
Creates an instance of a
SessionSkillsEnableResultrecord class. - SessionSkillsListParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.skills.listRPC method. - SessionSkillsListParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionSkillsListParams
-
Creates an instance of a
SessionSkillsListParamsrecord class. - SessionSkillsListResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.skills.listRPC method. - SessionSkillsListResult(List<Skill>) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionSkillsListResult
-
Creates an instance of a
SessionSkillsListResultrecord class. - SessionSkillsLoadedEvent - Class in com.github.copilot.sdk.generated
-
The
session.skills_loadedsession event. - SessionSkillsLoadedEvent() - Constructor for class com.github.copilot.sdk.generated.SessionSkillsLoadedEvent
- SessionSkillsLoadedEvent.SessionSkillsLoadedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionSkillsLoadedEvent. - SessionSkillsLoadedEventData(List<SkillsLoadedSkill>) - Constructor for record class com.github.copilot.sdk.generated.SessionSkillsLoadedEvent.SessionSkillsLoadedEventData
-
Creates an instance of a
SessionSkillsLoadedEventDatarecord class. - SessionSkillsReloadParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.skills.reloadRPC method. - SessionSkillsReloadParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionSkillsReloadParams
-
Creates an instance of a
SessionSkillsReloadParamsrecord class. - SessionSkillsReloadResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.skills.reloadRPC method. - SessionSkillsReloadResult() - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionSkillsReloadResult
-
Creates an instance of a
SessionSkillsReloadResultrecord class. - SessionSnapshotRewindEvent - Class in com.github.copilot.sdk.generated
-
The
session.snapshot_rewindsession event. - SessionSnapshotRewindEvent() - Constructor for class com.github.copilot.sdk.generated.SessionSnapshotRewindEvent
- SessionSnapshotRewindEvent.SessionSnapshotRewindEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionSnapshotRewindEvent. - SessionSnapshotRewindEventData(String, Double) - Constructor for record class com.github.copilot.sdk.generated.SessionSnapshotRewindEvent.SessionSnapshotRewindEventData
-
Creates an instance of a
SessionSnapshotRewindEventDatarecord class. - SessionStartEvent - Class in com.github.copilot.sdk.generated
-
The
session.startsession event. - SessionStartEvent() - Constructor for class com.github.copilot.sdk.generated.SessionStartEvent
- SessionStartEvent.SessionStartEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionStartEvent. - SessionStartEventData(String, Double, String, String, OffsetDateTime, String, String, WorkingDirectoryContext, Boolean, Boolean) - Constructor for record class com.github.copilot.sdk.generated.SessionStartEvent.SessionStartEventData
-
Creates an instance of a
SessionStartEventDatarecord class. - SessionStartHandler - Interface in com.github.copilot.sdk.json
-
Handler for session-start hooks.
- SessionStartHookInput - Record Class in com.github.copilot.sdk.json
-
Input for a session-start hook.
- SessionStartHookInput(long, String, String, String) - Constructor for record class com.github.copilot.sdk.json.SessionStartHookInput
-
Creates an instance of a
SessionStartHookInputrecord class. - SessionStartHookOutput - Record Class in com.github.copilot.sdk.json
-
Output for a session-start hook.
- SessionStartHookOutput(String, Map<String, Object>) - Constructor for record class com.github.copilot.sdk.json.SessionStartHookOutput
-
Creates an instance of a
SessionStartHookOutputrecord class. - sessionStartTime() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUsageGetMetricsResult
-
Returns the value of the
sessionStartTimerecord component. - sessionStartTime() - Method in record class com.github.copilot.sdk.generated.SessionShutdownEvent.SessionShutdownEventData
-
Returns the value of the
sessionStartTimerecord component. - sessionStatePath() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsSetProviderParams
-
Returns the value of the
sessionStatePathrecord component. - sessionSummary() - Method in record class com.github.copilot.sdk.json.SessionEndHookOutput
-
Returns the value of the
sessionSummaryrecord component. - sessionSyncLevel() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
-
Returns the value of the
sessionSyncLevelrecord component. - SessionTaskCompleteEvent - Class in com.github.copilot.sdk.generated
-
The
session.task_completesession event. - SessionTaskCompleteEvent() - Constructor for class com.github.copilot.sdk.generated.SessionTaskCompleteEvent
- SessionTaskCompleteEvent.SessionTaskCompleteEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionTaskCompleteEvent. - SessionTaskCompleteEventData(String, Boolean) - Constructor for record class com.github.copilot.sdk.generated.SessionTaskCompleteEvent.SessionTaskCompleteEventData
-
Creates an instance of a
SessionTaskCompleteEventDatarecord class. - SessionTitleChangedEvent - Class in com.github.copilot.sdk.generated
-
The
session.title_changedsession event. - SessionTitleChangedEvent() - Constructor for class com.github.copilot.sdk.generated.SessionTitleChangedEvent
- SessionTitleChangedEvent.SessionTitleChangedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionTitleChangedEvent. - SessionTitleChangedEventData(String) - Constructor for record class com.github.copilot.sdk.generated.SessionTitleChangedEvent.SessionTitleChangedEventData
-
Creates an instance of a
SessionTitleChangedEventDatarecord class. - SessionToolsApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
toolsnamespace. - SessionToolsHandlePendingToolCallParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.tools.handlePendingToolCallRPC method. - SessionToolsHandlePendingToolCallParams(String, String, Object, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionToolsHandlePendingToolCallParams
-
Creates an instance of a
SessionToolsHandlePendingToolCallParamsrecord class. - SessionToolsHandlePendingToolCallResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.tools.handlePendingToolCallRPC method. - SessionToolsHandlePendingToolCallResult(Boolean) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionToolsHandlePendingToolCallResult
-
Creates an instance of a
SessionToolsHandlePendingToolCallResultrecord class. - SessionToolsUpdatedEvent - Class in com.github.copilot.sdk.generated
-
The
session.tools_updatedsession event. - SessionToolsUpdatedEvent() - Constructor for class com.github.copilot.sdk.generated.SessionToolsUpdatedEvent
- SessionToolsUpdatedEvent.SessionToolsUpdatedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionToolsUpdatedEvent. - SessionToolsUpdatedEventData(String) - Constructor for record class com.github.copilot.sdk.generated.SessionToolsUpdatedEvent.SessionToolsUpdatedEventData
-
Creates an instance of a
SessionToolsUpdatedEventDatarecord class. - SessionTruncationEvent - Class in com.github.copilot.sdk.generated
-
The
session.truncationsession event. - SessionTruncationEvent() - Constructor for class com.github.copilot.sdk.generated.SessionTruncationEvent
- SessionTruncationEvent.SessionTruncationEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionTruncationEvent. - SessionTruncationEventData(Double, Double, Double, Double, Double, Double, Double, String) - Constructor for record class com.github.copilot.sdk.generated.SessionTruncationEvent.SessionTruncationEventData
-
Creates an instance of a
SessionTruncationEventDatarecord class. - SessionUiApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
uinamespace. - SessionUiApi - Interface in com.github.copilot.sdk.json
-
Provides UI methods for eliciting information from the user during a session.
- SessionUiCapabilities - Class in com.github.copilot.sdk.json
-
UI-specific capability flags for a session.
- SessionUiCapabilities() - Constructor for class com.github.copilot.sdk.json.SessionUiCapabilities
- SessionUiElicitationParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.ui.elicitationRPC method. - SessionUiElicitationParams(String, String, UIElicitationSchema) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionUiElicitationParams
-
Creates an instance of a
SessionUiElicitationParamsrecord class. - SessionUiElicitationResult - Record Class in com.github.copilot.sdk.generated.rpc
-
The elicitation response (accept with form values, decline, or cancel)
- SessionUiElicitationResult(UIElicitationResponseAction, Map<String, Object>) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionUiElicitationResult
-
Creates an instance of a
SessionUiElicitationResultrecord class. - SessionUiHandlePendingElicitationParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.ui.handlePendingElicitationRPC method. - SessionUiHandlePendingElicitationParams(String, String, UIElicitationResponse) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionUiHandlePendingElicitationParams
-
Creates an instance of a
SessionUiHandlePendingElicitationParamsrecord class. - SessionUiHandlePendingElicitationResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.ui.handlePendingElicitationRPC method. - SessionUiHandlePendingElicitationResult(Boolean) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionUiHandlePendingElicitationResult
-
Creates an instance of a
SessionUiHandlePendingElicitationResultrecord class. - SessionUsageApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
usagenamespace. - SessionUsageGetMetricsParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.usage.getMetricsRPC method. - SessionUsageGetMetricsParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionUsageGetMetricsParams
-
Creates an instance of a
SessionUsageGetMetricsParamsrecord class. - SessionUsageGetMetricsResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.usage.getMetricsRPC method. - SessionUsageGetMetricsResult(Double, Long, Double, Long, UsageMetricsCodeChanges, Map<String, UsageMetricsModelMetric>, String, Long, Long) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionUsageGetMetricsResult
-
Creates an instance of a
SessionUsageGetMetricsResultrecord class. - SessionUsageInfoEvent - Class in com.github.copilot.sdk.generated
-
The
session.usage_infosession event. - SessionUsageInfoEvent() - Constructor for class com.github.copilot.sdk.generated.SessionUsageInfoEvent
- SessionUsageInfoEvent.SessionUsageInfoEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionUsageInfoEvent. - SessionUsageInfoEventData(Double, Double, Double, Double, Double, Double, Boolean) - Constructor for record class com.github.copilot.sdk.generated.SessionUsageInfoEvent.SessionUsageInfoEventData
-
Creates an instance of a
SessionUsageInfoEventDatarecord class. - SessionWarningEvent - Class in com.github.copilot.sdk.generated
-
The
session.warningsession event. - SessionWarningEvent() - Constructor for class com.github.copilot.sdk.generated.SessionWarningEvent
- SessionWarningEvent.SessionWarningEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionWarningEvent. - SessionWarningEventData(String, String, String) - Constructor for record class com.github.copilot.sdk.generated.SessionWarningEvent.SessionWarningEventData
-
Creates an instance of a
SessionWarningEventDatarecord class. - SessionWorkspaceApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
workspacenamespace. - SessionWorkspaceCreateFileParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.workspace.createFileRPC method. - SessionWorkspaceCreateFileParams(String, String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceCreateFileParams
-
Creates an instance of a
SessionWorkspaceCreateFileParamsrecord class. - SessionWorkspaceCreateFileResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.workspace.createFileRPC method. - SessionWorkspaceCreateFileResult() - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceCreateFileResult
-
Creates an instance of a
SessionWorkspaceCreateFileResultrecord class. - SessionWorkspaceFileChangedEvent - Class in com.github.copilot.sdk.generated
-
The
session.workspace_file_changedsession event. - SessionWorkspaceFileChangedEvent() - Constructor for class com.github.copilot.sdk.generated.SessionWorkspaceFileChangedEvent
- SessionWorkspaceFileChangedEvent.SessionWorkspaceFileChangedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SessionWorkspaceFileChangedEvent. - SessionWorkspaceFileChangedEventData(String, WorkspaceFileChangedOperation) - Constructor for record class com.github.copilot.sdk.generated.SessionWorkspaceFileChangedEvent.SessionWorkspaceFileChangedEventData
-
Creates an instance of a
SessionWorkspaceFileChangedEventDatarecord class. - SessionWorkspaceListFilesParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.workspace.listFilesRPC method. - SessionWorkspaceListFilesParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceListFilesParams
-
Creates an instance of a
SessionWorkspaceListFilesParamsrecord class. - SessionWorkspaceListFilesResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.workspace.listFilesRPC method. - SessionWorkspaceListFilesResult(List<String>) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceListFilesResult
-
Creates an instance of a
SessionWorkspaceListFilesResultrecord class. - SessionWorkspaceReadFileParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.workspace.readFileRPC method. - SessionWorkspaceReadFileParams(String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceReadFileParams
-
Creates an instance of a
SessionWorkspaceReadFileParamsrecord class. - SessionWorkspaceReadFileResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.workspace.readFileRPC method. - SessionWorkspaceReadFileResult(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceReadFileResult
-
Creates an instance of a
SessionWorkspaceReadFileResultrecord class. - SessionWorkspacesApi - Class in com.github.copilot.sdk.generated.rpc
-
API methods for the
workspacesnamespace. - SessionWorkspacesCreateFileParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.workspaces.createFileRPC method. - SessionWorkspacesCreateFileParams(String, String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesCreateFileParams
-
Creates an instance of a
SessionWorkspacesCreateFileParamsrecord class. - SessionWorkspacesGetWorkspaceParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.workspaces.getWorkspaceRPC method. - SessionWorkspacesGetWorkspaceParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceParams
-
Creates an instance of a
SessionWorkspacesGetWorkspaceParamsrecord class. - SessionWorkspacesGetWorkspaceResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.workspaces.getWorkspaceRPC method. - SessionWorkspacesGetWorkspaceResult(SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult
-
Creates an instance of a
SessionWorkspacesGetWorkspaceResultrecord class. - SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace - Record Class in com.github.copilot.sdk.generated.rpc
- SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace.SessionWorkspacesGetWorkspaceResultWorkspaceHostType - Enum Class in com.github.copilot.sdk.generated.rpc
- SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace.SessionWorkspacesGetWorkspaceResultWorkspaceSessionSyncLevel - Enum Class in com.github.copilot.sdk.generated.rpc
- SessionWorkspacesGetWorkspaceResultWorkspace(UUID, String, String, String, SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace.SessionWorkspacesGetWorkspaceResultWorkspaceHostType, String, String, String, Long, OffsetDateTime, OffsetDateTime, Boolean, String, String, String, SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace.SessionWorkspacesGetWorkspaceResultWorkspaceSessionSyncLevel, Boolean) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
-
Creates an instance of a
SessionWorkspacesGetWorkspaceResultWorkspacerecord class. - SessionWorkspacesListFilesParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.workspaces.listFilesRPC method. - SessionWorkspacesListFilesParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesListFilesParams
-
Creates an instance of a
SessionWorkspacesListFilesParamsrecord class. - SessionWorkspacesListFilesResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.workspaces.listFilesRPC method. - SessionWorkspacesListFilesResult(List<String>) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesListFilesResult
-
Creates an instance of a
SessionWorkspacesListFilesResultrecord class. - SessionWorkspacesReadFileParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
session.workspaces.readFileRPC method. - SessionWorkspacesReadFileParams(String, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesReadFileParams
-
Creates an instance of a
SessionWorkspacesReadFileParamsrecord class. - SessionWorkspacesReadFileResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
session.workspaces.readFileRPC method. - SessionWorkspacesReadFileResult(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesReadFileResult
-
Creates an instance of a
SessionWorkspacesReadFileResultrecord class. - set(SessionModeSetParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionModeApi
-
Invokes
session.mode.set. - set(SessionNameSetParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionNameApi
-
Invokes
session.name.set. - setAction(ElicitationResultAction) - Method in class com.github.copilot.sdk.json.ElicitationResult
-
Sets the user action taken on the elicitation dialog.
- setAction(SectionOverrideAction) - Method in class com.github.copilot.sdk.json.SectionOverride
-
Sets the override action.
- setAgent(String) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets the pre-selected agent name.
- setAgent(String) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets the name of the custom agent to activate when the session starts.
- setAgent(String) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets the pre-selected agent name.
- setAgent(String) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets the name of the custom agent to activate when the session starts.
- setAllowFreeform(Boolean) - Method in class com.github.copilot.sdk.json.UserInputRequest
-
Sets whether freeform text input is allowed.
- setAnswer(String) - Method in class com.github.copilot.sdk.json.UserInputResponse
-
Sets the user's answer.
- setApiKey(String) - Method in class com.github.copilot.sdk.json.ProviderConfig
-
Sets the API key for authentication.
- setApiVersion(String) - Method in class com.github.copilot.sdk.json.AzureOptions
-
Sets the Azure OpenAI API version to use.
- setApproveAll(SessionPermissionsSetApproveAllParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionPermissionsApi
-
Invokes
session.permissions.setApproveAll. - setArgs(String) - Method in class com.github.copilot.sdk.json.CommandContext
-
Sets the argument string.
- setArgs(List<String>) - Method in class com.github.copilot.sdk.json.McpStdioServerConfig
-
Sets the arguments to pass to the command.
- setArguments(JsonNode) - Method in class com.github.copilot.sdk.json.ToolInvocation
-
Sets the tool arguments.
- setAttachments(List<? extends MessageAttachment>) - Method in class com.github.copilot.sdk.json.MessageOptions
-
Sets attachments to include with the message.
- setAttachments(List<MessageAttachment>) - Method in class com.github.copilot.sdk.json.SendMessageRequest
-
Sets the attachments.
- setAuthenticated(boolean) - Method in class com.github.copilot.sdk.json.GetAuthStatusResponse
- setAuthType(String) - Method in class com.github.copilot.sdk.json.GetAuthStatusResponse
- setAutoRestart(boolean) - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Deprecated.This option has no effect and will be removed in a future release.
- setAutoStart(boolean) - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Sets whether the client should automatically start the CLI server when the first request is made.
- setAvailableTools(List<String>) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets available tools.
- setAvailableTools(List<String>) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets the list of tool names that are allowed in this session.
- setAvailableTools(List<String>) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets available tools.
- setAvailableTools(List<String>) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets the list of tool names that are allowed in this session.
- setAzure(AzureOptions) - Method in class com.github.copilot.sdk.json.ProviderConfig
-
Sets Azure-specific options for Azure OpenAI Service.
- setBackgroundCompactionThreshold(Double) - Method in class com.github.copilot.sdk.json.InfiniteSessionConfig
-
Sets the context utilization threshold at which background compaction starts.
- setBaseUrl(String) - Method in class com.github.copilot.sdk.json.ProviderConfig
-
Sets the base URL for the API.
- setBearerToken(String) - Method in class com.github.copilot.sdk.json.ProviderConfig
-
Sets a bearer token for authentication.
- setBilling(ModelBilling) - Method in class com.github.copilot.sdk.json.ModelInfo
- setBranch(String) - Method in class com.github.copilot.sdk.json.SessionContext
-
Sets the git branch.
- setBranch(String) - Method in class com.github.copilot.sdk.json.SessionListFilter
-
Sets the filter for git branch.
- setBufferExhaustionThreshold(Double) - Method in class com.github.copilot.sdk.json.InfiniteSessionConfig
-
Sets the context utilization threshold at which the session blocks until compaction completes.
- setCapabilities(ModelCapabilities) - Method in class com.github.copilot.sdk.json.ModelInfo
- setCaptureContent(Boolean) - Method in class com.github.copilot.sdk.json.TelemetryConfig
-
Sets whether to capture message content as part of telemetry.
- setChoices(List<String>) - Method in class com.github.copilot.sdk.json.UserInputRequest
-
Sets the choices for multiple choice questions.
- setCliArgs(String[]) - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Sets extra arguments to pass to the CLI process.
- setClientName(String) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets the client name.
- setClientName(String) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets the client name to identify the application using the SDK.
- setClientName(String) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets the client name.
- setClientName(String) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets the client name to identify the application using the SDK.
- setCliPath(String) - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Sets the path to the Copilot CLI executable.
- setCliUrl(String) - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Sets the URL of an existing CLI server to connect to.
- setCode(int) - Method in class com.github.copilot.sdk.json.JsonRpcError
-
Sets the error code.
- setCommand(String) - Method in class com.github.copilot.sdk.json.CommandContext
-
Sets the full command text.
- setCommand(String) - Method in class com.github.copilot.sdk.json.McpStdioServerConfig
-
Sets the command to run the MCP server.
- setCommandName(String) - Method in class com.github.copilot.sdk.json.CommandContext
-
Sets the command name.
- setCommands(List<CommandDefinition>) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets slash commands registered for this session.
- setCommands(List<CommandDefinition>) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets slash commands registered for this session.
- setCommands(List<CommandWireDefinition>) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets the commands wire definitions.
- setCommands(List<CommandWireDefinition>) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets the commands wire definitions.
- setConfigDir(String) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets config directory.
- setConfigDir(String) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets the configuration directory path.
- setConfigDir(String) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets config directory.
- setConfigDir(String) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets a custom configuration directory for the session.
- setContent(String) - Method in class com.github.copilot.sdk.json.SectionOverride
-
Sets the content for the override.
- setContent(String) - Method in class com.github.copilot.sdk.json.SystemMessageConfig
-
Sets the system message content.
- setContent(Map<String, Object>) - Method in class com.github.copilot.sdk.json.ElicitationResult
-
Sets the form values submitted by the user.
- setContext(SessionContext) - Method in class com.github.copilot.sdk.json.SessionMetadata
-
Sets the working directory context.
- setCustomAgents(List<CustomAgentConfig>) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets custom agents.
- setCustomAgents(List<CustomAgentConfig>) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets custom agent configurations.
- setCustomAgents(List<CustomAgentConfig>) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets custom agents.
- setCustomAgents(List<CustomAgentConfig>) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets custom agent configurations.
- setCwd(String) - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Sets the working directory for the CLI process.
- setCwd(String) - Method in class com.github.copilot.sdk.json.PostToolUseHookInput
-
Sets the current working directory.
- setCwd(String) - Method in class com.github.copilot.sdk.json.PreToolUseHookInput
-
Sets the current working directory.
- setCwd(String) - Method in class com.github.copilot.sdk.json.SessionContext
-
Sets the working directory.
- setCwd(String) - Method in class com.github.copilot.sdk.json.SessionListFilter
-
Sets the filter for exact cwd match.
- setData(AbortEvent.AbortEventData) - Method in class com.github.copilot.sdk.generated.AbortEvent
- setData(AssistantIntentEvent.AssistantIntentEventData) - Method in class com.github.copilot.sdk.generated.AssistantIntentEvent
- setData(AssistantMessageDeltaEvent.AssistantMessageDeltaEventData) - Method in class com.github.copilot.sdk.generated.AssistantMessageDeltaEvent
- setData(AssistantMessageEvent.AssistantMessageEventData) - Method in class com.github.copilot.sdk.generated.AssistantMessageEvent
- setData(AssistantReasoningDeltaEvent.AssistantReasoningDeltaEventData) - Method in class com.github.copilot.sdk.generated.AssistantReasoningDeltaEvent
- setData(AssistantReasoningEvent.AssistantReasoningEventData) - Method in class com.github.copilot.sdk.generated.AssistantReasoningEvent
- setData(AssistantStreamingDeltaEvent.AssistantStreamingDeltaEventData) - Method in class com.github.copilot.sdk.generated.AssistantStreamingDeltaEvent
- setData(AssistantTurnEndEvent.AssistantTurnEndEventData) - Method in class com.github.copilot.sdk.generated.AssistantTurnEndEvent
- setData(AssistantTurnStartEvent.AssistantTurnStartEventData) - Method in class com.github.copilot.sdk.generated.AssistantTurnStartEvent
- setData(AssistantUsageEvent.AssistantUsageEventData) - Method in class com.github.copilot.sdk.generated.AssistantUsageEvent
- setData(AutoModeSwitchCompletedEvent.AutoModeSwitchCompletedEventData) - Method in class com.github.copilot.sdk.generated.AutoModeSwitchCompletedEvent
- setData(AutoModeSwitchRequestedEvent.AutoModeSwitchRequestedEventData) - Method in class com.github.copilot.sdk.generated.AutoModeSwitchRequestedEvent
- setData(CapabilitiesChangedEvent.CapabilitiesChangedEventData) - Method in class com.github.copilot.sdk.generated.CapabilitiesChangedEvent
- setData(CommandCompletedEvent.CommandCompletedEventData) - Method in class com.github.copilot.sdk.generated.CommandCompletedEvent
- setData(CommandExecuteEvent.CommandExecuteEventData) - Method in class com.github.copilot.sdk.generated.CommandExecuteEvent
- setData(CommandQueuedEvent.CommandQueuedEventData) - Method in class com.github.copilot.sdk.generated.CommandQueuedEvent
- setData(CommandsChangedEvent.CommandsChangedEventData) - Method in class com.github.copilot.sdk.generated.CommandsChangedEvent
- setData(ElicitationCompletedEvent.ElicitationCompletedEventData) - Method in class com.github.copilot.sdk.generated.ElicitationCompletedEvent
- setData(ElicitationRequestedEvent.ElicitationRequestedEventData) - Method in class com.github.copilot.sdk.generated.ElicitationRequestedEvent
- setData(ExitPlanModeCompletedEvent.ExitPlanModeCompletedEventData) - Method in class com.github.copilot.sdk.generated.ExitPlanModeCompletedEvent
- setData(ExitPlanModeRequestedEvent.ExitPlanModeRequestedEventData) - Method in class com.github.copilot.sdk.generated.ExitPlanModeRequestedEvent
- setData(ExternalToolCompletedEvent.ExternalToolCompletedEventData) - Method in class com.github.copilot.sdk.generated.ExternalToolCompletedEvent
- setData(ExternalToolRequestedEvent.ExternalToolRequestedEventData) - Method in class com.github.copilot.sdk.generated.ExternalToolRequestedEvent
- setData(HookEndEvent.HookEndEventData) - Method in class com.github.copilot.sdk.generated.HookEndEvent
- setData(HookStartEvent.HookStartEventData) - Method in class com.github.copilot.sdk.generated.HookStartEvent
- setData(McpOauthCompletedEvent.McpOauthCompletedEventData) - Method in class com.github.copilot.sdk.generated.McpOauthCompletedEvent
- setData(McpOauthRequiredEvent.McpOauthRequiredEventData) - Method in class com.github.copilot.sdk.generated.McpOauthRequiredEvent
- setData(PendingMessagesModifiedEvent.PendingMessagesModifiedEventData) - Method in class com.github.copilot.sdk.generated.PendingMessagesModifiedEvent
- setData(PermissionCompletedEvent.PermissionCompletedEventData) - Method in class com.github.copilot.sdk.generated.PermissionCompletedEvent
- setData(PermissionRequestedEvent.PermissionRequestedEventData) - Method in class com.github.copilot.sdk.generated.PermissionRequestedEvent
- setData(SamplingCompletedEvent.SamplingCompletedEventData) - Method in class com.github.copilot.sdk.generated.SamplingCompletedEvent
- setData(SamplingRequestedEvent.SamplingRequestedEventData) - Method in class com.github.copilot.sdk.generated.SamplingRequestedEvent
- setData(SessionBackgroundTasksChangedEvent.SessionBackgroundTasksChangedEventData) - Method in class com.github.copilot.sdk.generated.SessionBackgroundTasksChangedEvent
- setData(SessionCompactionCompleteEvent.SessionCompactionCompleteEventData) - Method in class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent
- setData(SessionCompactionStartEvent.SessionCompactionStartEventData) - Method in class com.github.copilot.sdk.generated.SessionCompactionStartEvent
- setData(SessionContextChangedEvent.SessionContextChangedEventData) - Method in class com.github.copilot.sdk.generated.SessionContextChangedEvent
- setData(SessionCustomAgentsUpdatedEvent.SessionCustomAgentsUpdatedEventData) - Method in class com.github.copilot.sdk.generated.SessionCustomAgentsUpdatedEvent
- setData(SessionErrorEvent.SessionErrorEventData) - Method in class com.github.copilot.sdk.generated.SessionErrorEvent
- setData(SessionExtensionsLoadedEvent.SessionExtensionsLoadedEventData) - Method in class com.github.copilot.sdk.generated.SessionExtensionsLoadedEvent
- setData(SessionHandoffEvent.SessionHandoffEventData) - Method in class com.github.copilot.sdk.generated.SessionHandoffEvent
- setData(SessionIdleEvent.SessionIdleEventData) - Method in class com.github.copilot.sdk.generated.SessionIdleEvent
- setData(SessionInfoEvent.SessionInfoEventData) - Method in class com.github.copilot.sdk.generated.SessionInfoEvent
- setData(SessionMcpServersLoadedEvent.SessionMcpServersLoadedEventData) - Method in class com.github.copilot.sdk.generated.SessionMcpServersLoadedEvent
- setData(SessionMcpServerStatusChangedEvent.SessionMcpServerStatusChangedEventData) - Method in class com.github.copilot.sdk.generated.SessionMcpServerStatusChangedEvent
- setData(SessionModeChangedEvent.SessionModeChangedEventData) - Method in class com.github.copilot.sdk.generated.SessionModeChangedEvent
- setData(SessionModelChangeEvent.SessionModelChangeEventData) - Method in class com.github.copilot.sdk.generated.SessionModelChangeEvent
- setData(SessionPlanChangedEvent.SessionPlanChangedEventData) - Method in class com.github.copilot.sdk.generated.SessionPlanChangedEvent
- setData(SessionRemoteSteerableChangedEvent.SessionRemoteSteerableChangedEventData) - Method in class com.github.copilot.sdk.generated.SessionRemoteSteerableChangedEvent
- setData(SessionResumeEvent.SessionResumeEventData) - Method in class com.github.copilot.sdk.generated.SessionResumeEvent
- setData(SessionShutdownEvent.SessionShutdownEventData) - Method in class com.github.copilot.sdk.generated.SessionShutdownEvent
- setData(SessionSkillsLoadedEvent.SessionSkillsLoadedEventData) - Method in class com.github.copilot.sdk.generated.SessionSkillsLoadedEvent
- setData(SessionSnapshotRewindEvent.SessionSnapshotRewindEventData) - Method in class com.github.copilot.sdk.generated.SessionSnapshotRewindEvent
- setData(SessionStartEvent.SessionStartEventData) - Method in class com.github.copilot.sdk.generated.SessionStartEvent
- setData(SessionTaskCompleteEvent.SessionTaskCompleteEventData) - Method in class com.github.copilot.sdk.generated.SessionTaskCompleteEvent
- setData(SessionTitleChangedEvent.SessionTitleChangedEventData) - Method in class com.github.copilot.sdk.generated.SessionTitleChangedEvent
- setData(SessionToolsUpdatedEvent.SessionToolsUpdatedEventData) - Method in class com.github.copilot.sdk.generated.SessionToolsUpdatedEvent
- setData(SessionTruncationEvent.SessionTruncationEventData) - Method in class com.github.copilot.sdk.generated.SessionTruncationEvent
- setData(SessionUsageInfoEvent.SessionUsageInfoEventData) - Method in class com.github.copilot.sdk.generated.SessionUsageInfoEvent
- setData(SessionWarningEvent.SessionWarningEventData) - Method in class com.github.copilot.sdk.generated.SessionWarningEvent
- setData(SessionWorkspaceFileChangedEvent.SessionWorkspaceFileChangedEventData) - Method in class com.github.copilot.sdk.generated.SessionWorkspaceFileChangedEvent
- setData(SkillInvokedEvent.SkillInvokedEventData) - Method in class com.github.copilot.sdk.generated.SkillInvokedEvent
- setData(SubagentCompletedEvent.SubagentCompletedEventData) - Method in class com.github.copilot.sdk.generated.SubagentCompletedEvent
- setData(SubagentDeselectedEvent.SubagentDeselectedEventData) - Method in class com.github.copilot.sdk.generated.SubagentDeselectedEvent
- setData(SubagentFailedEvent.SubagentFailedEventData) - Method in class com.github.copilot.sdk.generated.SubagentFailedEvent
- setData(SubagentSelectedEvent.SubagentSelectedEventData) - Method in class com.github.copilot.sdk.generated.SubagentSelectedEvent
- setData(SubagentStartedEvent.SubagentStartedEventData) - Method in class com.github.copilot.sdk.generated.SubagentStartedEvent
- setData(SystemMessageEvent.SystemMessageEventData) - Method in class com.github.copilot.sdk.generated.SystemMessageEvent
- setData(SystemNotificationEvent.SystemNotificationEventData) - Method in class com.github.copilot.sdk.generated.SystemNotificationEvent
- setData(ToolExecutionCompleteEvent.ToolExecutionCompleteEventData) - Method in class com.github.copilot.sdk.generated.ToolExecutionCompleteEvent
- setData(ToolExecutionPartialResultEvent.ToolExecutionPartialResultEventData) - Method in class com.github.copilot.sdk.generated.ToolExecutionPartialResultEvent
- setData(ToolExecutionProgressEvent.ToolExecutionProgressEventData) - Method in class com.github.copilot.sdk.generated.ToolExecutionProgressEvent
- setData(ToolExecutionStartEvent.ToolExecutionStartEventData) - Method in class com.github.copilot.sdk.generated.ToolExecutionStartEvent
- setData(ToolUserRequestedEvent.ToolUserRequestedEventData) - Method in class com.github.copilot.sdk.generated.ToolUserRequestedEvent
- setData(UserInputCompletedEvent.UserInputCompletedEventData) - Method in class com.github.copilot.sdk.generated.UserInputCompletedEvent
- setData(UserInputRequestedEvent.UserInputRequestedEventData) - Method in class com.github.copilot.sdk.generated.UserInputRequestedEvent
- setData(UserMessageEvent.UserMessageEventData) - Method in class com.github.copilot.sdk.generated.UserMessageEvent
- setData(Object) - Method in class com.github.copilot.sdk.json.JsonRpcError
-
Sets the additional error data.
- setData(String) - Method in class com.github.copilot.sdk.json.BlobAttachment
-
Sets the base64-encoded binary content.
- setDefaultAgent(DefaultAgentConfig) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets the default agent config.
- setDefaultAgent(DefaultAgentConfig) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets the default agent configuration.
- setDefaultAgent(DefaultAgentConfig) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets the default agent config.
- setDefaultAgent(DefaultAgentConfig) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets the default agent configuration.
- setDefaultReasoningEffort(String) - Method in class com.github.copilot.sdk.json.ModelInfo
-
Sets the default reasoning effort level.
- setDefaultValue(String) - Method in class com.github.copilot.sdk.json.InputOptions
-
Sets the default value pre-populated in the field.
- setDescription(String) - Method in class com.github.copilot.sdk.json.AgentInfo
-
Sets the description of the agent's purpose.
- setDescription(String) - Method in class com.github.copilot.sdk.json.CommandDefinition
-
Sets the human-readable description shown in the command completion UI.
- setDescription(String) - Method in class com.github.copilot.sdk.json.CommandWireDefinition
-
Sets the description.
- setDescription(String) - Method in class com.github.copilot.sdk.json.CustomAgentConfig
-
Sets a description of the agent's capabilities.
- setDescription(String) - Method in class com.github.copilot.sdk.json.InputOptions
-
Sets the descriptive text shown below the field.
- setDisabledSkills(SkillsConfigSetDisabledSkillsParams) - Method in class com.github.copilot.sdk.generated.rpc.ServerSkillsConfigApi
-
Invokes
skills.config.setDisabledSkills. - setDisabledSkills(List<String>) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets disabled skills.
- setDisabledSkills(List<String>) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets skills that should be disabled for this session.
- setDisabledSkills(List<String>) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets disabled skills.
- setDisabledSkills(List<String>) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets the list of skill names to disable.
- setDisableResume(boolean) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets whether to disable the session.resume event.
- setDisableResume(Boolean) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets disable resume flag.
- setDisplayName(String) - Method in class com.github.copilot.sdk.json.AgentInfo
-
Sets the human-readable display name of the agent.
- setDisplayName(String) - Method in class com.github.copilot.sdk.json.BlobAttachment
-
Sets the human-readable display name for the attachment.
- setDisplayName(String) - Method in class com.github.copilot.sdk.json.CustomAgentConfig
-
Sets the human-readable display name.
- setElicitation(Boolean) - Method in class com.github.copilot.sdk.json.SessionUiCapabilities
-
Sets whether the host supports interactive elicitation dialogs.
- setElicitationSource(String) - Method in class com.github.copilot.sdk.json.ElicitationContext
-
Sets the elicitation source.
- setEnableConfigDiscovery(Boolean) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets enable config discovery flag.
- setEnableConfigDiscovery(Boolean) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets whether to automatically discover MCP server configurations and skill directories from the working directory.
- setEnableConfigDiscovery(Boolean) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets enable config discovery flag.
- setEnableConfigDiscovery(Boolean) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets whether to automatically discover MCP server configurations and skill directories from the working directory.
- setEnabled(Boolean) - Method in class com.github.copilot.sdk.json.InfiniteSessionConfig
-
Sets whether infinite sessions are enabled.
- setEnv(Map<String, String>) - Method in class com.github.copilot.sdk.json.McpStdioServerConfig
-
Sets the environment variables to pass to the server.
- setEnvironment(Map<String, String>) - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Sets environment variables to pass to the CLI process.
- setEnvValueMode(String) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets MCP environment variable value mode.
- setEnvValueMode(String) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets MCP environment variable value mode.
- setEphemeral(Boolean) - Method in class com.github.copilot.sdk.generated.SessionEvent
- setError(JsonRpcError) - Method in class com.github.copilot.sdk.json.JsonRpcResponse
-
Sets the error for a failed RPC call.
- setEventErrorHandler(EventErrorHandler) - Method in class com.github.copilot.sdk.CopilotSession
-
Sets a custom error handler for exceptions thrown by event handlers.
- setEventErrorPolicy(EventErrorPolicy) - Method in class com.github.copilot.sdk.CopilotSession
-
Sets the error propagation policy for event dispatch.
- setExcludedTools(List<String>) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets excluded tools.
- setExcludedTools(List<String>) - Method in class com.github.copilot.sdk.json.DefaultAgentConfig
-
Sets the list of tool names to exclude from the default agent.
- setExcludedTools(List<String>) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets the list of tool names to exclude from this session.
- setExcludedTools(List<String>) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets excluded tools.
- setExcludedTools(List<String>) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets the list of tool names to exclude from this session.
- setExecutor(Executor) - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Sets the executor used for internal asynchronous operations.
- setExporterType(String) - Method in class com.github.copilot.sdk.json.TelemetryConfig
-
Sets the exporter type.
- setExtensionData(Map<String, Object>) - Method in class com.github.copilot.sdk.json.PermissionRequest
-
Sets additional extension data for the request.
- setFilePath(String) - Method in class com.github.copilot.sdk.json.TelemetryConfig
-
Sets the file path for the file exporter.
- setForegroundSessionId(String) - Method in class com.github.copilot.sdk.CopilotClient
-
Requests the TUI to switch to displaying the specified session.
- SetForegroundSessionResponse - Record Class in com.github.copilot.sdk.json
-
Response from session.setForeground RPC call.
- SetForegroundSessionResponse(boolean, String) - Constructor for record class com.github.copilot.sdk.json.SetForegroundSessionResponse
-
Creates an instance of a
SetForegroundSessionResponserecord class. - setFormat(String) - Method in class com.github.copilot.sdk.json.InputOptions
-
Sets the semantic format hint.
- setGithubToken(String) - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Deprecated.Use
CopilotClientOptions.setGitHubToken(String)instead. - setGitHubToken(String) - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Sets the GitHub token to use for authentication.
- setGitHubToken(String) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets the GitHub token for per-session authentication.
- setGitHubToken(String) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets the GitHub token for per-session authentication.
- setGitHubToken(String) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets the GitHub token for per-session authentication.
- setGitHubToken(String) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets the GitHub token for per-session authentication.
- setGitRoot(String) - Method in class com.github.copilot.sdk.json.SessionContext
-
Sets the git repository root directory.
- setGitRoot(String) - Method in class com.github.copilot.sdk.json.SessionListFilter
-
Sets the filter for git root directory.
- setHandler(CommandHandler) - Method in class com.github.copilot.sdk.json.CommandDefinition
-
Sets the handler invoked when the command is executed.
- setHeaders(Map<String, String>) - Method in class com.github.copilot.sdk.json.McpHttpServerConfig
-
Sets optional HTTP headers to include in requests to this server.
- setHeaders(Map<String, String>) - Method in class com.github.copilot.sdk.json.ProviderConfig
-
Sets custom HTTP headers to include in outbound provider requests.
- setHooks(SessionHooks) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets hook handlers for session lifecycle events.
- setHooks(SessionHooks) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets hook handlers for session lifecycle events.
- setHooks(Boolean) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets hooks flag.
- setHooks(Boolean) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets hooks flag.
- setHost(String) - Method in class com.github.copilot.sdk.json.GetAuthStatusResponse
- setId(Long) - Method in class com.github.copilot.sdk.json.JsonRpcRequest
-
Sets the request ID.
- setId(Object) - Method in class com.github.copilot.sdk.json.JsonRpcResponse
-
Sets the response ID.
- setId(String) - Method in class com.github.copilot.sdk.json.ModelInfo
- setId(UUID) - Method in class com.github.copilot.sdk.generated.SessionEvent
- setIncludeSubAgentStreamingEvents(Boolean) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets include sub-agent streaming events flag.
- setIncludeSubAgentStreamingEvents(Boolean) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets whether to include sub-agent streaming events in the event stream.
- setIncludeSubAgentStreamingEvents(Boolean) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets include sub-agent streaming events flag.
- setIncludeSubAgentStreamingEvents(Boolean) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets whether to include sub-agent streaming events in the event stream.
- setInfer(Boolean) - Method in class com.github.copilot.sdk.json.CustomAgentConfig
-
Sets whether to enable inference mode for this agent.
- setInfiniteSessions(InfiniteSessionConfig) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets infinite sessions config.
- setInfiniteSessions(InfiniteSessionConfig) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets the infinite session configuration for persistent workspaces and automatic compaction.
- setInfiniteSessions(InfiniteSessionConfig) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets infinite sessions config.
- setInfiniteSessions(InfiniteSessionConfig) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets the infinite session configuration for persistent workspaces and automatic compaction.
- setJsonrpc(String) - Method in class com.github.copilot.sdk.json.JsonRpcRequest
-
Sets the JSON-RPC version.
- setJsonrpc(String) - Method in class com.github.copilot.sdk.json.JsonRpcResponse
-
Sets the JSON-RPC version.
- setKind(PermissionRequestResultKind) - Method in class com.github.copilot.sdk.json.PermissionRequestResult
-
Sets the result kind using a
PermissionRequestResultKindvalue. - setKind(String) - Method in class com.github.copilot.sdk.json.PermissionRequest
-
Sets the permission kind.
- setKind(String) - Method in class com.github.copilot.sdk.json.PermissionRequestResult
-
Sets the result kind using a raw string value.
- setLimits(ModelCapabilitiesOverride.Limits) - Method in class com.github.copilot.sdk.json.ModelCapabilitiesOverride
-
Sets the token limit overrides.
- setLimits(ModelLimits) - Method in class com.github.copilot.sdk.json.ModelCapabilities
- setLogin(String) - Method in class com.github.copilot.sdk.json.GetAuthStatusResponse
- setLogLevel(String) - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Sets the log level for the CLI process.
- setMaxContextWindowTokens(int) - Method in class com.github.copilot.sdk.json.ModelLimits
- setMaxContextWindowTokens(Integer) - Method in class com.github.copilot.sdk.json.ModelCapabilitiesOverride.Limits
-
Sets the maximum total context window size in tokens.
- setMaxLength(Integer) - Method in class com.github.copilot.sdk.json.InputOptions
-
Sets the maximum character length.
- setMaxOutputTokens(Integer) - Method in class com.github.copilot.sdk.json.ModelCapabilitiesOverride.Limits
-
Sets the maximum number of output tokens.
- setMaxPromptImages(int) - Method in class com.github.copilot.sdk.json.ModelVisionLimits
- setMaxPromptImageSize(int) - Method in class com.github.copilot.sdk.json.ModelVisionLimits
- setMaxPromptTokens(Integer) - Method in class com.github.copilot.sdk.json.ModelCapabilitiesOverride.Limits
-
Sets the maximum number of tokens in a prompt.
- setMaxPromptTokens(Integer) - Method in class com.github.copilot.sdk.json.ModelLimits
- setMcpServers(Map<String, McpServerConfig>) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets MCP servers.
- setMcpServers(Map<String, McpServerConfig>) - Method in class com.github.copilot.sdk.json.CustomAgentConfig
-
Sets MCP (Model Context Protocol) servers available to this agent.
- setMcpServers(Map<String, McpServerConfig>) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets MCP (Model Context Protocol) server configurations.
- setMcpServers(Map<String, McpServerConfig>) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets MCP servers.
- setMcpServers(Map<String, McpServerConfig>) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets MCP (Model Context Protocol) server configurations.
- setMessage(String) - Method in class com.github.copilot.sdk.json.ElicitationContext
-
Sets the message.
- setMessage(String) - Method in class com.github.copilot.sdk.json.ElicitationParams
-
Sets the message describing what information is needed from the user.
- setMessage(String) - Method in class com.github.copilot.sdk.json.JsonRpcError
-
Sets the error message.
- setMetadata(SessionLifecycleEventMetadata) - Method in class com.github.copilot.sdk.json.SessionLifecycleEvent
- setMethod(String) - Method in class com.github.copilot.sdk.json.JsonRpcRequest
-
Sets the method name.
- setMimeType(String) - Method in class com.github.copilot.sdk.json.BlobAttachment
-
Sets the MIME type of the binary content.
- setMinLength(Integer) - Method in class com.github.copilot.sdk.json.InputOptions
-
Sets the minimum character length.
- setMode(SystemMessageMode) - Method in class com.github.copilot.sdk.json.SystemMessageConfig
-
Sets the system message mode.
- setMode(String) - Method in class com.github.copilot.sdk.json.ElicitationContext
-
Sets the mode.
- setMode(String) - Method in class com.github.copilot.sdk.json.MessageOptions
-
Sets the message delivery mode.
- setMode(String) - Method in class com.github.copilot.sdk.json.SendMessageRequest
-
Sets the mode.
- setModel(String) - Method in class com.github.copilot.sdk.CopilotSession
-
Changes the model for this session.
- setModel(String) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets the model name.
- setModel(String) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets the AI model to use for the resumed session.
- setModel(String) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets the model name.
- setModel(String) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets the AI model to use for this session.
- setModel(String, String) - Method in class com.github.copilot.sdk.CopilotSession
-
Changes the model for this session with an optional reasoning effort level.
- setModel(String, String, ModelCapabilitiesOverride) - Method in class com.github.copilot.sdk.CopilotSession
-
Changes the model for this session with optional reasoning effort and capability overrides.
- setModelCapabilities(ModelCapabilitiesOverride) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets the model capabilities override.
- setModelCapabilities(ModelCapabilitiesOverride) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets per-property overrides for model capabilities, deep-merged over runtime defaults.
- setModelCapabilities(ModelCapabilitiesOverride) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets the model capabilities override.
- setModelCapabilities(ModelCapabilitiesOverride) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets per-property overrides for model capabilities, deep-merged over runtime defaults.
- setModels(List<ModelInfo>) - Method in class com.github.copilot.sdk.json.GetModelsResponse
- setModifiedTime(String) - Method in class com.github.copilot.sdk.json.SessionMetadata
-
Sets the session modified time.
- setMultiplier(double) - Method in class com.github.copilot.sdk.json.ModelBilling
- setName(String) - Method in class com.github.copilot.sdk.json.AgentInfo
-
Sets the unique identifier of the agent.
- setName(String) - Method in class com.github.copilot.sdk.json.CommandDefinition
-
Sets the command name (without leading
/). - setName(String) - Method in class com.github.copilot.sdk.json.CommandWireDefinition
-
Sets the command name.
- setName(String) - Method in class com.github.copilot.sdk.json.CustomAgentConfig
-
Sets the unique identifier name for this agent.
- setName(String) - Method in class com.github.copilot.sdk.json.ModelInfo
- setOnElicitationRequest(ElicitationHandler) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets a handler for elicitation requests from the server or MCP tools.
- setOnElicitationRequest(ElicitationHandler) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets a handler for elicitation requests from the server or MCP tools.
- setOnEvent(Consumer<SessionEvent>) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets an event handler that is registered on the session before the
session.resumeRPC is issued. - setOnEvent(Consumer<SessionEvent>) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets an event handler that is registered on the session before the
session.createRPC is issued. - setOnListModels(Supplier<CompletableFuture<List<ModelInfo>>>) - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Sets a custom handler for listing available models.
- setOnPermissionRequest(PermissionHandler) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets a handler for permission requests from the assistant.
- setOnPermissionRequest(PermissionHandler) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets a handler for permission requests from the assistant.
- setOnPostToolUse(PostToolUseHandler) - Method in class com.github.copilot.sdk.json.SessionHooks
-
Sets the handler called after a tool has been executed.
- setOnPreToolUse(PreToolUseHandler) - Method in class com.github.copilot.sdk.json.SessionHooks
-
Sets the handler called before a tool is executed.
- setOnSessionEnd(SessionEndHandler) - Method in class com.github.copilot.sdk.json.SessionHooks
-
Sets the handler called when a session ends.
- setOnSessionStart(SessionStartHandler) - Method in class com.github.copilot.sdk.json.SessionHooks
-
Sets the handler called when a session starts.
- setOnUserInputRequest(UserInputHandler) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets a handler for user input requests from the agent.
- setOnUserInputRequest(UserInputHandler) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets a handler for user input requests from the agent.
- setOnUserPromptSubmitted(UserPromptSubmittedHandler) - Method in class com.github.copilot.sdk.json.SessionHooks
-
Sets the handler called when the user submits a prompt.
- setOtlpEndpoint(String) - Method in class com.github.copilot.sdk.json.TelemetryConfig
-
Sets the OTLP exporter endpoint URL.
- setParams(Object) - Method in class com.github.copilot.sdk.json.JsonRpcRequest
-
Sets the method parameters.
- setParentId(UUID) - Method in class com.github.copilot.sdk.generated.SessionEvent
- setPolicy(ModelPolicy) - Method in class com.github.copilot.sdk.json.ModelInfo
- setPort(int) - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Sets the TCP port for the CLI server to listen on.
- setPrompt(String) - Method in class com.github.copilot.sdk.json.CustomAgentConfig
-
Sets the system prompt that defines this agent's behavior.
- setPrompt(String) - Method in class com.github.copilot.sdk.json.MessageOptions
-
Sets the message prompt to send to the assistant.
- setPrompt(String) - Method in class com.github.copilot.sdk.json.SendMessageRequest
-
Sets the message prompt.
- setProperties(Map<String, Object>) - Method in class com.github.copilot.sdk.json.ElicitationSchema
-
Sets the form field definitions, keyed by field name.
- setProtocolVersion(int) - Method in class com.github.copilot.sdk.json.GetStatusResponse
- setProvider(SessionFsSetProviderParams) - Method in class com.github.copilot.sdk.generated.rpc.ServerSessionFsApi
-
Invokes
sessionFs.setProvider. - setProvider(ProviderConfig) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets the provider config.
- setProvider(ProviderConfig) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets a custom API provider for BYOK scenarios.
- setProvider(ProviderConfig) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets the provider config.
- setProvider(ProviderConfig) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets a custom API provider for BYOK (Bring Your Own Key) scenarios.
- setQuestion(String) - Method in class com.github.copilot.sdk.json.UserInputRequest
-
Sets the question to ask the user.
- setReasoningEffort(boolean) - Method in class com.github.copilot.sdk.json.ModelSupports
-
Sets whether this model supports reasoning effort configuration.
- setReasoningEffort(Boolean) - Method in class com.github.copilot.sdk.json.ModelCapabilitiesOverride.Supports
-
Sets whether reasoning effort configuration is enabled.
- setReasoningEffort(String) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets the reasoning effort.
- setReasoningEffort(String) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets the reasoning effort level for models that support it.
- setReasoningEffort(String) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets the reasoning effort.
- setReasoningEffort(String) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets the reasoning effort level for models that support it.
- setRemote(boolean) - Method in class com.github.copilot.sdk.json.SessionMetadata
-
Sets whether this session is stored remotely.
- setRepository(String) - Method in class com.github.copilot.sdk.json.SessionContext
-
Sets the GitHub repository.
- setRepository(String) - Method in class com.github.copilot.sdk.json.SessionListFilter
-
Sets the filter for repository (in "owner/repo" format).
- setRequestedSchema(ElicitationSchema) - Method in class com.github.copilot.sdk.json.ElicitationContext
-
Sets the schema.
- setRequestedSchema(ElicitationSchema) - Method in class com.github.copilot.sdk.json.ElicitationParams
-
Sets the JSON Schema describing the form fields to present.
- setRequestElicitation(Boolean) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets the requestElicitation flag.
- setRequestElicitation(Boolean) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets the requestElicitation flag.
- setRequestHeaders(Map<String, String>) - Method in class com.github.copilot.sdk.json.MessageOptions
-
Sets custom per-turn HTTP headers for outbound model requests.
- setRequestHeaders(Map<String, String>) - Method in class com.github.copilot.sdk.json.SendMessageRequest
-
Sets the per-turn request headers.
- setRequestPermission(Boolean) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets request permission flag.
- setRequestPermission(Boolean) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets request permission flag.
- setRequestUserInput(Boolean) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets request user input flag.
- setRequestUserInput(Boolean) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets request user input flag.
- setRequired(List<String>) - Method in class com.github.copilot.sdk.json.ElicitationSchema
-
Sets the list of required field names.
- setResult(Object) - Method in class com.github.copilot.sdk.json.JsonRpcResponse
-
Sets the result of the RPC call.
- setRules(List<Object>) - Method in class com.github.copilot.sdk.json.PermissionRequestResult
-
Sets approval rules for future similar requests.
- setSections(Map<String, SectionOverride>) - Method in class com.github.copilot.sdk.json.SystemMessageConfig
-
Sets section-level overrides for
SystemMessageMode.CUSTOMIZEmode. - setSessionId(String) - Method in class com.github.copilot.sdk.json.CommandContext
-
Sets the session ID.
- setSessionId(String) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets the session ID.
- setSessionId(String) - Method in class com.github.copilot.sdk.json.ElicitationContext
-
Sets the session ID.
- setSessionId(String) - Method in class com.github.copilot.sdk.json.HookInvocation
-
Sets the session ID.
- setSessionId(String) - Method in class com.github.copilot.sdk.json.PermissionInvocation
-
Sets the session ID.
- setSessionId(String) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets the session ID.
- setSessionId(String) - Method in class com.github.copilot.sdk.json.SendMessageRequest
-
Sets the session ID.
- setSessionId(String) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets a custom session ID.
- setSessionId(String) - Method in class com.github.copilot.sdk.json.SessionLifecycleEvent
- setSessionId(String) - Method in class com.github.copilot.sdk.json.SessionMetadata
-
Sets the session identifier.
- setSessionId(String) - Method in class com.github.copilot.sdk.json.ToolInvocation
-
Sets the session ID.
- setSessionId(String) - Method in class com.github.copilot.sdk.json.UserInputInvocation
-
Sets the session ID.
- setSessionIdleTimeoutSeconds(Integer) - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Sets the server-wide idle timeout for sessions in seconds.
- setSkillDirectories(List<String>) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets skill directories.
- setSkillDirectories(List<String>) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets directories containing skill definitions.
- setSkillDirectories(List<String>) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets skill directories.
- setSkillDirectories(List<String>) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets the skill directories for loading custom skills.
- setSkills(List<String>) - Method in class com.github.copilot.sdk.json.CustomAgentConfig
-
Sets the list of skill names to preload into this agent's context.
- setSourceName(String) - Method in class com.github.copilot.sdk.json.TelemetryConfig
-
Sets the source name for telemetry spans.
- setStartTime(String) - Method in class com.github.copilot.sdk.json.SessionMetadata
-
Sets the session start time.
- setState(String) - Method in class com.github.copilot.sdk.json.ModelPolicy
- setStatusMessage(String) - Method in class com.github.copilot.sdk.json.GetAuthStatusResponse
- setStreaming(boolean) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets whether to enable streaming of response chunks.
- setStreaming(boolean) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets whether to enable streaming of response chunks.
- setStreaming(Boolean) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets streaming flag.
- setStreaming(Boolean) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets streaming flag.
- setSummary(String) - Method in class com.github.copilot.sdk.json.SessionMetadata
-
Sets the session summary.
- setSupportedMediaTypes(List<String>) - Method in class com.github.copilot.sdk.json.ModelVisionLimits
- setSupportedReasoningEfforts(List<String>) - Method in class com.github.copilot.sdk.json.ModelInfo
-
Sets the supported reasoning effort levels.
- setSupports(ModelCapabilitiesOverride.Supports) - Method in class com.github.copilot.sdk.json.ModelCapabilitiesOverride
-
Sets the feature flag overrides.
- setSupports(ModelSupports) - Method in class com.github.copilot.sdk.json.ModelCapabilities
- setSystemMessage(SystemMessageConfig) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets the system message config.
- setSystemMessage(SystemMessageConfig) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets the system message configuration.
- setSystemMessage(SystemMessageConfig) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets the system message config.
- setSystemMessage(SystemMessageConfig) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets the system message configuration.
- setTelemetry(TelemetryConfig) - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Sets the OpenTelemetry configuration for the CLI server.
- setTerms(String) - Method in class com.github.copilot.sdk.json.ModelPolicy
- setTimeout(Integer) - Method in class com.github.copilot.sdk.json.McpHttpServerConfig
- setTimeout(Integer) - Method in class com.github.copilot.sdk.json.McpServerConfig
-
Sets an optional timeout in milliseconds for tool calls to this server.
- setTimeout(Integer) - Method in class com.github.copilot.sdk.json.McpStdioServerConfig
- setTimestamp(long) - Method in class com.github.copilot.sdk.json.PostToolUseHookInput
-
Sets the timestamp of the hook invocation.
- setTimestamp(long) - Method in class com.github.copilot.sdk.json.PreToolUseHookInput
-
Sets the timestamp of the hook invocation.
- setTimestamp(OffsetDateTime) - Method in class com.github.copilot.sdk.generated.SessionEvent
- setTitle(String) - Method in class com.github.copilot.sdk.json.InputOptions
-
Sets the title label for the input field.
- setToolArgs(JsonNode) - Method in class com.github.copilot.sdk.json.PostToolUseHookInput
-
Sets the arguments passed to the tool.
- setToolArgs(JsonNode) - Method in class com.github.copilot.sdk.json.PreToolUseHookInput
-
Sets the arguments passed to the tool.
- setToolCallId(String) - Method in class com.github.copilot.sdk.json.PermissionRequest
-
Sets the tool call ID.
- setToolCallId(String) - Method in class com.github.copilot.sdk.json.ToolInvocation
-
Sets the tool call ID.
- setToolName(String) - Method in class com.github.copilot.sdk.json.PostToolUseHookInput
-
Sets the name of the tool that was invoked.
- setToolName(String) - Method in class com.github.copilot.sdk.json.PreToolUseHookInput
-
Sets the name of the tool being invoked.
- setToolName(String) - Method in class com.github.copilot.sdk.json.ToolInvocation
-
Sets the tool name.
- setToolResult(JsonNode) - Method in class com.github.copilot.sdk.json.PostToolUseHookInput
-
Sets the result returned by the tool.
- setTools(List<ToolDefinition>) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets the tools.
- setTools(List<ToolDefinition>) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets custom tools that the assistant can invoke during the session.
- setTools(List<ToolDefinition>) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets the tools.
- setTools(List<ToolDefinition>) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets custom tools that the assistant can invoke during the session.
- setTools(List<String>) - Method in class com.github.copilot.sdk.json.CustomAgentConfig
-
Sets the tools available to this agent.
- setTools(List<String>) - Method in class com.github.copilot.sdk.json.McpHttpServerConfig
- setTools(List<String>) - Method in class com.github.copilot.sdk.json.McpServerConfig
-
Sets the list of tools to include from this server.
- setTools(List<String>) - Method in class com.github.copilot.sdk.json.McpStdioServerConfig
- setTransform(Function<String, CompletableFuture<String>>) - Method in class com.github.copilot.sdk.json.SectionOverride
-
Sets the transform callback for this section.
- setType(String) - Method in class com.github.copilot.sdk.json.ElicitationSchema
-
Sets the schema type indicator.
- setType(String) - Method in class com.github.copilot.sdk.json.ProviderConfig
-
Sets the provider type.
- setType(String) - Method in class com.github.copilot.sdk.json.SessionLifecycleEvent
- setUi(SessionUiCapabilities) - Method in class com.github.copilot.sdk.json.SessionCapabilities
-
Sets the UI-related capabilities.
- setUrl(String) - Method in class com.github.copilot.sdk.json.ElicitationContext
-
Sets the URL.
- setUrl(String) - Method in class com.github.copilot.sdk.json.McpHttpServerConfig
-
Sets the URL of the remote server.
- setUseLoggedInUser(Boolean) - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Sets whether to use the logged-in user for authentication.
- setUseStdio(boolean) - Method in class com.github.copilot.sdk.json.CopilotClientOptions
-
Sets whether to use stdio transport instead of TCP.
- setVersion(String) - Method in class com.github.copilot.sdk.json.GetStatusResponse
- setVision(boolean) - Method in class com.github.copilot.sdk.json.ModelSupports
- setVision(ModelVisionLimits) - Method in class com.github.copilot.sdk.json.ModelLimits
- setVision(Boolean) - Method in class com.github.copilot.sdk.json.ModelCapabilitiesOverride.Supports
-
Sets whether vision (image input) is enabled.
- setWasFreeform(boolean) - Method in class com.github.copilot.sdk.json.UserInputResponse
-
Sets whether the answer was freeform.
- setWireApi(String) - Method in class com.github.copilot.sdk.json.ProviderConfig
-
Sets the wire API format for custom providers.
- setWorkingDirectory(String) - Method in class com.github.copilot.sdk.json.CreateSessionRequest
-
Sets working directory.
- setWorkingDirectory(String) - Method in class com.github.copilot.sdk.json.McpStdioServerConfig
-
Sets the working directory for the server process.
- setWorkingDirectory(String) - Method in class com.github.copilot.sdk.json.ResumeSessionConfig
-
Sets the working directory for the session.
- setWorkingDirectory(String) - Method in class com.github.copilot.sdk.json.ResumeSessionRequest
-
Sets working directory.
- setWorkingDirectory(String) - Method in class com.github.copilot.sdk.json.SessionConfig
-
Sets the working directory for the session.
- shell - Variable in class com.github.copilot.sdk.generated.rpc.SessionRpc
-
API methods for the
shellnamespace. - SHELL - Enum constant in enum class com.github.copilot.sdk.generated.UserMessageAgentMode
-
The
shellvariant. - ShellKillSignal - Enum Class in com.github.copilot.sdk.generated.rpc
-
Signal to send (default: SIGTERM)
- ShutdownCodeChanges - Record Class in com.github.copilot.sdk.generated
-
Aggregate code change metrics for the session
- ShutdownCodeChanges(Double, Double, List<String>) - Constructor for record class com.github.copilot.sdk.generated.ShutdownCodeChanges
-
Creates an instance of a
ShutdownCodeChangesrecord class. - ShutdownModelMetric - Record Class in com.github.copilot.sdk.generated
- ShutdownModelMetric(ShutdownModelMetricRequests, ShutdownModelMetricUsage) - Constructor for record class com.github.copilot.sdk.generated.ShutdownModelMetric
-
Creates an instance of a
ShutdownModelMetricrecord class. - ShutdownModelMetricRequests - Record Class in com.github.copilot.sdk.generated
-
Request count and cost metrics
- ShutdownModelMetricRequests(Double, Double) - Constructor for record class com.github.copilot.sdk.generated.ShutdownModelMetricRequests
-
Creates an instance of a
ShutdownModelMetricRequestsrecord class. - ShutdownModelMetricUsage - Record Class in com.github.copilot.sdk.generated
-
Token usage breakdown
- ShutdownModelMetricUsage(Double, Double, Double, Double, Double) - Constructor for record class com.github.copilot.sdk.generated.ShutdownModelMetricUsage
-
Creates an instance of a
ShutdownModelMetricUsagerecord class. - shutdownType() - Method in record class com.github.copilot.sdk.generated.SessionShutdownEvent.SessionShutdownEventData
-
Returns the value of the
shutdownTyperecord component. - ShutdownType - Enum Class in com.github.copilot.sdk.generated
-
Whether the session ended normally ("routine") or due to a crash/fatal error ("error")
- SIGINT - Enum constant in enum class com.github.copilot.sdk.generated.rpc.ShellKillSignal
-
The
SIGINTvariant. - SIGKILL - Enum constant in enum class com.github.copilot.sdk.generated.rpc.ShellKillSignal
-
The
SIGKILLvariant. - signal() - Method in record class com.github.copilot.sdk.generated.rpc.SessionShellKillParams
-
Returns the value of the
signalrecord component. - SIGTERM - Enum constant in enum class com.github.copilot.sdk.generated.rpc.ShellKillSignal
-
The
SIGTERMvariant. - size() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsStatResult
-
Returns the value of the
sizerecord component. - Skill - Record Class in com.github.copilot.sdk.generated.rpc
- Skill(String, String, String, Boolean, Boolean, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.Skill
-
Creates an instance of a
Skillrecord class. - skillDirectories() - Method in record class com.github.copilot.sdk.generated.rpc.SkillsDiscoverParams
-
Returns the value of the
skillDirectoriesrecord component. - SkillInvokedEvent - Class in com.github.copilot.sdk.generated
-
The
skill.invokedsession event. - SkillInvokedEvent() - Constructor for class com.github.copilot.sdk.generated.SkillInvokedEvent
- SkillInvokedEvent.SkillInvokedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SkillInvokedEvent. - SkillInvokedEventData(String, String, String, List<String>, String, String, String) - Constructor for record class com.github.copilot.sdk.generated.SkillInvokedEvent.SkillInvokedEventData
-
Creates an instance of a
SkillInvokedEventDatarecord class. - skills - Variable in class com.github.copilot.sdk.generated.rpc.ServerRpc
-
API methods for the
skillsnamespace. - skills - Variable in class com.github.copilot.sdk.generated.rpc.SessionRpc
-
API methods for the
skillsnamespace. - skills() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsListResult
-
Returns the value of the
skillsrecord component. - skills() - Method in record class com.github.copilot.sdk.generated.rpc.SkillsDiscoverResult
-
Returns the value of the
skillsrecord component. - skills() - Method in record class com.github.copilot.sdk.generated.SessionSkillsLoadedEvent.SessionSkillsLoadedEventData
-
Returns the value of the
skillsrecord component. - SkillsConfigSetDisabledSkillsParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
skills.config.setDisabledSkillsRPC method. - SkillsConfigSetDisabledSkillsParams(List<String>) - Constructor for record class com.github.copilot.sdk.generated.rpc.SkillsConfigSetDisabledSkillsParams
-
Creates an instance of a
SkillsConfigSetDisabledSkillsParamsrecord class. - SkillsDiscoverParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
skills.discoverRPC method. - SkillsDiscoverParams(List<String>, List<String>) - Constructor for record class com.github.copilot.sdk.generated.rpc.SkillsDiscoverParams
-
Creates an instance of a
SkillsDiscoverParamsrecord class. - SkillsDiscoverResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
skills.discoverRPC method. - SkillsDiscoverResult(List<ServerSkill>) - Constructor for record class com.github.copilot.sdk.generated.rpc.SkillsDiscoverResult
-
Creates an instance of a
SkillsDiscoverResultrecord class. - SkillsLoadedSkill - Record Class in com.github.copilot.sdk.generated
- SkillsLoadedSkill(String, String, String, Boolean, Boolean, String) - Constructor for record class com.github.copilot.sdk.generated.SkillsLoadedSkill
-
Creates an instance of a
SkillsLoadedSkillrecord class. - skipPermission() - Method in record class com.github.copilot.sdk.json.ToolDefinition
-
Returns the value of the
skipPermissionrecord component. - source() - Method in record class com.github.copilot.sdk.generated.CustomAgentsUpdatedAgent
-
Returns the value of the
sourcerecord component. - source() - Method in record class com.github.copilot.sdk.generated.ExtensionsLoadedExtension
-
Returns the value of the
sourcerecord component. - source() - Method in record class com.github.copilot.sdk.generated.McpServersLoadedServer
-
Returns the value of the
sourcerecord component. - source() - Method in record class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServer
-
Returns the value of the
sourcerecord component. - source() - Method in record class com.github.copilot.sdk.generated.rpc.Extension
-
Returns the value of the
sourcerecord component. - source() - Method in record class com.github.copilot.sdk.generated.rpc.McpServer
-
Returns the value of the
sourcerecord component. - source() - Method in record class com.github.copilot.sdk.generated.rpc.ServerSkill
-
Returns the value of the
sourcerecord component. - source() - Method in record class com.github.copilot.sdk.generated.rpc.Skill
-
Returns the value of the
sourcerecord component. - source() - Method in record class com.github.copilot.sdk.generated.SkillsLoadedSkill
-
Returns the value of the
sourcerecord component. - source() - Method in record class com.github.copilot.sdk.generated.UserMessageEvent.UserMessageEventData
-
Returns the value of the
sourcerecord component. - source() - Method in record class com.github.copilot.sdk.json.SessionStartHookInput
-
Returns the value of the
sourcerecord component. - sourcePath() - Method in record class com.github.copilot.sdk.generated.rpc.InstructionsSources
-
Returns the value of the
sourcePathrecord component. - sources() - Method in record class com.github.copilot.sdk.generated.rpc.SessionInstructionsGetSourcesResult
-
Returns the value of the
sourcesrecord component. - sourceType() - Method in record class com.github.copilot.sdk.generated.SessionHandoffEvent.SessionHandoffEventData
-
Returns the value of the
sourceTyperecord component. - src() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsRenameParams
-
Returns the value of the
srcrecord component. - SSE - Enum constant in enum class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServerType
-
The
ssevariant. - stack() - Method in record class com.github.copilot.sdk.generated.HookEndError
-
Returns the value of the
stackrecord component. - stack() - Method in record class com.github.copilot.sdk.generated.SessionErrorEvent.SessionErrorEventData
-
Returns the value of the
stackrecord component. - start() - Method in class com.github.copilot.sdk.CopilotClient
-
Starts the Copilot client and connects to the server.
- start(SessionFleetStartParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionFleetApi
-
Invokes
session.fleet.start. - started() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFleetStartResult
-
Returns the value of the
startedrecord component. - STARTING - Enum constant in enum class com.github.copilot.sdk.generated.ExtensionsLoadedExtensionStatus
-
The
startingvariant. - STARTING - Enum constant in enum class com.github.copilot.sdk.generated.rpc.ExtensionStatus
-
The
startingvariant. - startTime() - Method in record class com.github.copilot.sdk.generated.SessionStartEvent.SessionStartEventData
-
Returns the value of the
startTimerecord component. - startTime() - Method in record class com.github.copilot.sdk.json.SessionLifecycleEventMetadata
-
Returns the value of the
startTimerecord component. - state() - Method in record class com.github.copilot.sdk.generated.rpc.ModelPolicy
-
Returns the value of the
staterecord component. - staticClientConfig() - Method in record class com.github.copilot.sdk.generated.McpOauthRequiredEvent.McpOauthRequiredEventData
-
Returns the value of the
staticClientConfigrecord component. - status() - Method in record class com.github.copilot.sdk.generated.ExtensionsLoadedExtension
-
Returns the value of the
statusrecord component. - status() - Method in record class com.github.copilot.sdk.generated.McpServersLoadedServer
-
Returns the value of the
statusrecord component. - status() - Method in record class com.github.copilot.sdk.generated.rpc.Extension
-
Returns the value of the
statusrecord component. - status() - Method in record class com.github.copilot.sdk.generated.rpc.McpServer
-
Returns the value of the
statusrecord component. - status() - Method in record class com.github.copilot.sdk.generated.SessionMcpServerStatusChangedEvent.SessionMcpServerStatusChangedEventData
-
Returns the value of the
statusrecord component. - statusCode() - Method in record class com.github.copilot.sdk.generated.SessionErrorEvent.SessionErrorEventData
-
Returns the value of the
statusCoderecord component. - statusMessage() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAuthGetStatusResult
-
Returns the value of the
statusMessagerecord component. - STDIO - Enum constant in enum class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServerType
-
The
stdiovariant. - stop() - Method in class com.github.copilot.sdk.CopilotClient
-
Disconnects from the Copilot server and closes all active sessions.
- SubagentCompletedEvent - Class in com.github.copilot.sdk.generated
-
The
subagent.completedsession event. - SubagentCompletedEvent() - Constructor for class com.github.copilot.sdk.generated.SubagentCompletedEvent
- SubagentCompletedEvent.SubagentCompletedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SubagentCompletedEvent. - SubagentCompletedEventData(String, String, String, String, Double, Double, Double) - Constructor for record class com.github.copilot.sdk.generated.SubagentCompletedEvent.SubagentCompletedEventData
-
Creates an instance of a
SubagentCompletedEventDatarecord class. - SubagentDeselectedEvent - Class in com.github.copilot.sdk.generated
-
The
subagent.deselectedsession event. - SubagentDeselectedEvent() - Constructor for class com.github.copilot.sdk.generated.SubagentDeselectedEvent
- SubagentDeselectedEvent.SubagentDeselectedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SubagentDeselectedEvent. - SubagentDeselectedEventData() - Constructor for record class com.github.copilot.sdk.generated.SubagentDeselectedEvent.SubagentDeselectedEventData
-
Creates an instance of a
SubagentDeselectedEventDatarecord class. - SubagentFailedEvent - Class in com.github.copilot.sdk.generated
-
The
subagent.failedsession event. - SubagentFailedEvent() - Constructor for class com.github.copilot.sdk.generated.SubagentFailedEvent
- SubagentFailedEvent.SubagentFailedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SubagentFailedEvent. - SubagentFailedEventData(String, String, String, String, String, Double, Double, Double) - Constructor for record class com.github.copilot.sdk.generated.SubagentFailedEvent.SubagentFailedEventData
-
Creates an instance of a
SubagentFailedEventDatarecord class. - SubagentSelectedEvent - Class in com.github.copilot.sdk.generated
-
The
subagent.selectedsession event. - SubagentSelectedEvent() - Constructor for class com.github.copilot.sdk.generated.SubagentSelectedEvent
- SubagentSelectedEvent.SubagentSelectedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SubagentSelectedEvent. - SubagentSelectedEventData(String, String, List<String>) - Constructor for record class com.github.copilot.sdk.generated.SubagentSelectedEvent.SubagentSelectedEventData
-
Creates an instance of a
SubagentSelectedEventDatarecord class. - SubagentStartedEvent - Class in com.github.copilot.sdk.generated
-
The
subagent.startedsession event. - SubagentStartedEvent() - Constructor for class com.github.copilot.sdk.generated.SubagentStartedEvent
- SubagentStartedEvent.SubagentStartedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SubagentStartedEvent. - SubagentStartedEventData(String, String, String, String) - Constructor for record class com.github.copilot.sdk.generated.SubagentStartedEvent.SubagentStartedEventData
-
Creates an instance of a
SubagentStartedEventDatarecord class. - success() - Method in record class com.github.copilot.sdk.generated.HookEndEvent.HookEndEventData
-
Returns the value of the
successrecord component. - success() - Method in record class com.github.copilot.sdk.generated.rpc.SessionCommandsHandlePendingCommandResult
-
Returns the value of the
successrecord component. - success() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsSetProviderResult
-
Returns the value of the
successrecord component. - success() - Method in record class com.github.copilot.sdk.generated.rpc.SessionHistoryCompactResult
-
Returns the value of the
successrecord component. - success() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsHandlePendingPermissionRequestResult
-
Returns the value of the
successrecord component. - success() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsResetSessionApprovalsResult
-
Returns the value of the
successrecord component. - success() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsSetApproveAllResult
-
Returns the value of the
successrecord component. - success() - Method in record class com.github.copilot.sdk.generated.rpc.SessionToolsHandlePendingToolCallResult
-
Returns the value of the
successrecord component. - success() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUiHandlePendingElicitationResult
-
Returns the value of the
successrecord component. - success() - Method in record class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent.SessionCompactionCompleteEventData
-
Returns the value of the
successrecord component. - success() - Method in record class com.github.copilot.sdk.generated.SessionTaskCompleteEvent.SessionTaskCompleteEventData
-
Returns the value of the
successrecord component. - success() - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteEvent.ToolExecutionCompleteEventData
-
Returns the value of the
successrecord component. - success() - Method in record class com.github.copilot.sdk.json.DeleteSessionResponse
-
Returns the value of the
successrecord component. - success() - Method in record class com.github.copilot.sdk.json.SetForegroundSessionResponse
-
Returns the value of the
successrecord component. - success(String) - Static method in record class com.github.copilot.sdk.json.ToolResultObject
-
Creates a success result with the given text.
- summary() - Method in record class com.github.copilot.sdk.generated.ExitPlanModeRequestedEvent.ExitPlanModeRequestedEventData
-
Returns the value of the
summaryrecord component. - summary() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
-
Returns the value of the
summaryrecord component. - summary() - Method in record class com.github.copilot.sdk.generated.SessionHandoffEvent.SessionHandoffEventData
-
Returns the value of the
summaryrecord component. - summary() - Method in record class com.github.copilot.sdk.generated.SessionTaskCompleteEvent.SessionTaskCompleteEventData
-
Returns the value of the
summaryrecord component. - summary() - Method in record class com.github.copilot.sdk.json.SessionLifecycleEventMetadata
-
Returns the value of the
summaryrecord component. - summaryContent() - Method in record class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent.SessionCompactionCompleteEventData
-
Returns the value of the
summaryContentrecord component. - summaryCount() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
-
Returns the value of the
summaryCountrecord component. - supportedMediaTypes() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesLimitsVision
-
Returns the value of the
supportedMediaTypesrecord component. - supportedMediaTypes() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverrideLimitsVision
-
Returns the value of the
supportedMediaTypesrecord component. - supportedNativeDocumentMimeTypes() - Method in record class com.github.copilot.sdk.generated.UserMessageEvent.UserMessageEventData
-
Returns the value of the
supportedNativeDocumentMimeTypesrecord component. - supportedReasoningEfforts() - Method in record class com.github.copilot.sdk.generated.rpc.Model
-
Returns the value of the
supportedReasoningEffortsrecord component. - supports() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilities
-
Returns the value of the
supportsrecord component. - supports() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverride
-
Returns the value of the
supportsrecord component. - Supports() - Constructor for class com.github.copilot.sdk.json.ModelCapabilitiesOverride.Supports
- SUPPRESS_AND_LOG_ERRORS - Enum constant in enum class com.github.copilot.sdk.EventErrorPolicy
-
Suppress errors: log the error and continue dispatching to remaining listeners.
- suppressOutput() - Method in record class com.github.copilot.sdk.json.PostToolUseHookOutput
-
Returns the value of the
suppressOutputrecord component. - suppressOutput() - Method in record class com.github.copilot.sdk.json.PreToolUseHookOutput
-
Returns the value of the
suppressOutputrecord component. - suppressOutput() - Method in record class com.github.copilot.sdk.json.SessionEndHookOutput
-
Returns the value of the
suppressOutputrecord component. - suppressOutput() - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookOutput
-
Returns the value of the
suppressOutputrecord component. - switchTo(SessionModelSwitchToParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionModelApi
-
Invokes
session.model.switchTo. - SYSTEM - Enum constant in enum class com.github.copilot.sdk.generated.SystemMessageRole
-
The
systemvariant. - SystemMessageConfig - Class in com.github.copilot.sdk.json
-
Configuration for customizing the system message.
- SystemMessageConfig() - Constructor for class com.github.copilot.sdk.json.SystemMessageConfig
- SystemMessageEvent - Class in com.github.copilot.sdk.generated
-
The
system.messagesession event. - SystemMessageEvent() - Constructor for class com.github.copilot.sdk.generated.SystemMessageEvent
- SystemMessageEvent.SystemMessageEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SystemMessageEvent. - SystemMessageEventData(String, SystemMessageRole, String, SystemMessageMetadata) - Constructor for record class com.github.copilot.sdk.generated.SystemMessageEvent.SystemMessageEventData
-
Creates an instance of a
SystemMessageEventDatarecord class. - SystemMessageMetadata - Record Class in com.github.copilot.sdk.generated
-
Metadata about the prompt template and its construction
- SystemMessageMetadata(String, Map<String, Object>) - Constructor for record class com.github.copilot.sdk.generated.SystemMessageMetadata
-
Creates an instance of a
SystemMessageMetadatarecord class. - SystemMessageMode - Enum Class in com.github.copilot.sdk
-
Specifies how the system message should be applied to a session.
- SystemMessageRole - Enum Class in com.github.copilot.sdk.generated
-
Message role: "system" for system prompts, "developer" for developer-injected instructions
- SystemNotificationEvent - Class in com.github.copilot.sdk.generated
-
The
system.notificationsession event. - SystemNotificationEvent() - Constructor for class com.github.copilot.sdk.generated.SystemNotificationEvent
- SystemNotificationEvent.SystemNotificationEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
SystemNotificationEvent. - SystemNotificationEventData(String, Object) - Constructor for record class com.github.copilot.sdk.generated.SystemNotificationEvent.SystemNotificationEventData
-
Creates an instance of a
SystemNotificationEventDatarecord class. - SystemPromptSections - Class in com.github.copilot.sdk.json
-
Well-known system prompt section identifiers for use with
SystemMessageMode#CUSTOMIZEmode. - systemTokens() - Method in record class com.github.copilot.sdk.generated.rpc.HistoryCompactContextWindow
-
Returns the value of the
systemTokensrecord component. - systemTokens() - Method in record class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent.SessionCompactionCompleteEventData
-
Returns the value of the
systemTokensrecord component. - systemTokens() - Method in record class com.github.copilot.sdk.generated.SessionCompactionStartEvent.SessionCompactionStartEventData
-
Returns the value of the
systemTokensrecord component. - systemTokens() - Method in record class com.github.copilot.sdk.generated.SessionShutdownEvent.SessionShutdownEventData
-
Returns the value of the
systemTokensrecord component. - systemTokens() - Method in record class com.github.copilot.sdk.generated.SessionUsageInfoEvent.SessionUsageInfoEventData
-
Returns the value of the
systemTokensrecord component.
T
- TelemetryConfig - Class in com.github.copilot.sdk.json
-
OpenTelemetry configuration for the Copilot CLI server.
- TelemetryConfig() - Constructor for class com.github.copilot.sdk.json.TelemetryConfig
- terms() - Method in record class com.github.copilot.sdk.generated.rpc.ModelPolicy
-
Returns the value of the
termsrecord component. - textResultForLlm() - Method in record class com.github.copilot.sdk.json.ToolResultObject
-
Returns the value of the
textResultForLlmrecord component. - timeout() - Method in record class com.github.copilot.sdk.generated.rpc.SessionShellExecParams
-
Returns the value of the
timeoutrecord component. - timestamp() - Method in record class com.github.copilot.sdk.generated.rpc.PingResult
-
Returns the value of the
timestamprecord component. - timestamp() - Method in record class com.github.copilot.sdk.json.PingResponse
-
Returns the value of the
timestamprecord component. - timestamp() - Method in record class com.github.copilot.sdk.json.SessionEndHookInput
-
Returns the value of the
timestamprecord component. - timestamp() - Method in record class com.github.copilot.sdk.json.SessionStartHookInput
-
Returns the value of the
timestamprecord component. - timestamp() - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookInput
-
Returns the value of the
timestamprecord component. - title() - Method in record class com.github.copilot.sdk.generated.SessionTitleChangedEvent.SessionTitleChangedEventData
-
Returns the value of the
titlerecord component. - toEventId() - Method in record class com.github.copilot.sdk.generated.rpc.SessionsForkParams
-
Returns the value of the
toEventIdrecord component. - TOKEN - Enum constant in enum class com.github.copilot.sdk.generated.rpc.AuthInfoType
-
The
tokenvariant. - tokenCount() - Method in record class com.github.copilot.sdk.generated.AssistantUsageCopilotUsageTokenDetail
-
Returns the value of the
tokenCountrecord component. - tokenCount() - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail
-
Returns the value of the
tokenCountrecord component. - tokenDetails() - Method in record class com.github.copilot.sdk.generated.AssistantUsageCopilotUsage
-
Returns the value of the
tokenDetailsrecord component. - tokenDetails() - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsedCopilotUsage
-
Returns the value of the
tokenDetailsrecord component. - tokenLimit() - Method in record class com.github.copilot.sdk.generated.rpc.HistoryCompactContextWindow
-
Returns the value of the
tokenLimitrecord component. - tokenLimit() - Method in record class com.github.copilot.sdk.generated.SessionTruncationEvent.SessionTruncationEventData
-
Returns the value of the
tokenLimitrecord component. - tokenLimit() - Method in record class com.github.copilot.sdk.generated.SessionUsageInfoEvent.SessionUsageInfoEventData
-
Returns the value of the
tokenLimitrecord component. - tokensRemoved() - Method in record class com.github.copilot.sdk.generated.rpc.SessionHistoryCompactResult
-
Returns the value of the
tokensRemovedrecord component. - tokensRemoved() - Method in record class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent.SessionCompactionCompleteEventData
-
Returns the value of the
tokensRemovedrecord component. - tokensRemovedDuringTruncation() - Method in record class com.github.copilot.sdk.generated.SessionTruncationEvent.SessionTruncationEventData
-
Returns the value of the
tokensRemovedDuringTruncationrecord component. - tokenType() - Method in record class com.github.copilot.sdk.generated.AssistantUsageCopilotUsageTokenDetail
-
Returns the value of the
tokenTyperecord component. - tokenType() - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail
-
Returns the value of the
tokenTyperecord component. - TONE - Static variable in class com.github.copilot.sdk.json.SystemPromptSections
-
Response style, conciseness rules, output formatting preferences.
- Tool - Record Class in com.github.copilot.sdk.generated.rpc
- Tool(String, String, String, Map<String, Object>, String) - Constructor for record class com.github.copilot.sdk.generated.rpc.Tool
-
Creates an instance of a
Toolrecord class. - TOOL_EFFICIENCY - Static variable in class com.github.copilot.sdk.json.SystemPromptSections
-
Tool usage patterns, parallel calling, batching guidelines.
- TOOL_INSTRUCTIONS - Static variable in class com.github.copilot.sdk.json.SystemPromptSections
-
Per-tool usage instructions.
- ToolBinaryResult - Record Class in com.github.copilot.sdk.json
-
Binary result from a tool execution.
- ToolBinaryResult(String, String, String, String) - Constructor for record class com.github.copilot.sdk.json.ToolBinaryResult
-
Creates an instance of a
ToolBinaryResultrecord class. - toolCallId() - Method in record class com.github.copilot.sdk.generated.AssistantMessageToolRequest
-
Returns the value of the
toolCallIdrecord component. - toolCallId() - Method in record class com.github.copilot.sdk.generated.ElicitationRequestedEvent.ElicitationRequestedEventData
-
Returns the value of the
toolCallIdrecord component. - toolCallId() - Method in record class com.github.copilot.sdk.generated.ExternalToolRequestedEvent.ExternalToolRequestedEventData
-
Returns the value of the
toolCallIdrecord component. - toolCallId() - Method in record class com.github.copilot.sdk.generated.PermissionCompletedEvent.PermissionCompletedEventData
-
Returns the value of the
toolCallIdrecord component. - toolCallId() - Method in record class com.github.copilot.sdk.generated.SubagentCompletedEvent.SubagentCompletedEventData
-
Returns the value of the
toolCallIdrecord component. - toolCallId() - Method in record class com.github.copilot.sdk.generated.SubagentFailedEvent.SubagentFailedEventData
-
Returns the value of the
toolCallIdrecord component. - toolCallId() - Method in record class com.github.copilot.sdk.generated.SubagentStartedEvent.SubagentStartedEventData
-
Returns the value of the
toolCallIdrecord component. - toolCallId() - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteEvent.ToolExecutionCompleteEventData
-
Returns the value of the
toolCallIdrecord component. - toolCallId() - Method in record class com.github.copilot.sdk.generated.ToolExecutionPartialResultEvent.ToolExecutionPartialResultEventData
-
Returns the value of the
toolCallIdrecord component. - toolCallId() - Method in record class com.github.copilot.sdk.generated.ToolExecutionProgressEvent.ToolExecutionProgressEventData
-
Returns the value of the
toolCallIdrecord component. - toolCallId() - Method in record class com.github.copilot.sdk.generated.ToolExecutionStartEvent.ToolExecutionStartEventData
-
Returns the value of the
toolCallIdrecord component. - toolCallId() - Method in record class com.github.copilot.sdk.generated.ToolUserRequestedEvent.ToolUserRequestedEventData
-
Returns the value of the
toolCallIdrecord component. - toolCallId() - Method in record class com.github.copilot.sdk.generated.UserInputRequestedEvent.UserInputRequestedEventData
-
Returns the value of the
toolCallIdrecord component. - ToolDefinition - Record Class in com.github.copilot.sdk.json
-
Defines a tool that can be invoked by the AI assistant.
- ToolDefinition(String, String, Object, ToolHandler, Boolean, Boolean) - Constructor for record class com.github.copilot.sdk.json.ToolDefinition
-
Creates an instance of a
ToolDefinitionrecord class. - toolDefinitionsTokens() - Method in record class com.github.copilot.sdk.generated.rpc.HistoryCompactContextWindow
-
Returns the value of the
toolDefinitionsTokensrecord component. - toolDefinitionsTokens() - Method in record class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent.SessionCompactionCompleteEventData
-
Returns the value of the
toolDefinitionsTokensrecord component. - toolDefinitionsTokens() - Method in record class com.github.copilot.sdk.generated.SessionCompactionStartEvent.SessionCompactionStartEventData
-
Returns the value of the
toolDefinitionsTokensrecord component. - toolDefinitionsTokens() - Method in record class com.github.copilot.sdk.generated.SessionShutdownEvent.SessionShutdownEventData
-
Returns the value of the
toolDefinitionsTokensrecord component. - toolDefinitionsTokens() - Method in record class com.github.copilot.sdk.generated.SessionUsageInfoEvent.SessionUsageInfoEventData
-
Returns the value of the
toolDefinitionsTokensrecord component. - ToolExecutionCompleteError - Record Class in com.github.copilot.sdk.generated
-
Error details when the tool execution failed
- ToolExecutionCompleteError(String, String) - Constructor for record class com.github.copilot.sdk.generated.ToolExecutionCompleteError
-
Creates an instance of a
ToolExecutionCompleteErrorrecord class. - ToolExecutionCompleteEvent - Class in com.github.copilot.sdk.generated
-
The
tool.execution_completesession event. - ToolExecutionCompleteEvent() - Constructor for class com.github.copilot.sdk.generated.ToolExecutionCompleteEvent
- ToolExecutionCompleteEvent.ToolExecutionCompleteEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
ToolExecutionCompleteEvent. - ToolExecutionCompleteEventData(String, Boolean, String, String, Boolean, ToolExecutionCompleteResult, ToolExecutionCompleteError, Map<String, Object>, String) - Constructor for record class com.github.copilot.sdk.generated.ToolExecutionCompleteEvent.ToolExecutionCompleteEventData
-
Creates an instance of a
ToolExecutionCompleteEventDatarecord class. - ToolExecutionCompleteResult - Record Class in com.github.copilot.sdk.generated
-
Tool execution result on success
- ToolExecutionCompleteResult(String, String, List<Object>) - Constructor for record class com.github.copilot.sdk.generated.ToolExecutionCompleteResult
-
Creates an instance of a
ToolExecutionCompleteResultrecord class. - ToolExecutionPartialResultEvent - Class in com.github.copilot.sdk.generated
-
The
tool.execution_partial_resultsession event. - ToolExecutionPartialResultEvent() - Constructor for class com.github.copilot.sdk.generated.ToolExecutionPartialResultEvent
- ToolExecutionPartialResultEvent.ToolExecutionPartialResultEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
ToolExecutionPartialResultEvent. - ToolExecutionPartialResultEventData(String, String) - Constructor for record class com.github.copilot.sdk.generated.ToolExecutionPartialResultEvent.ToolExecutionPartialResultEventData
-
Creates an instance of a
ToolExecutionPartialResultEventDatarecord class. - ToolExecutionProgressEvent - Class in com.github.copilot.sdk.generated
-
The
tool.execution_progresssession event. - ToolExecutionProgressEvent() - Constructor for class com.github.copilot.sdk.generated.ToolExecutionProgressEvent
- ToolExecutionProgressEvent.ToolExecutionProgressEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
ToolExecutionProgressEvent. - ToolExecutionProgressEventData(String, String) - Constructor for record class com.github.copilot.sdk.generated.ToolExecutionProgressEvent.ToolExecutionProgressEventData
-
Creates an instance of a
ToolExecutionProgressEventDatarecord class. - ToolExecutionStartEvent - Class in com.github.copilot.sdk.generated
-
The
tool.execution_startsession event. - ToolExecutionStartEvent() - Constructor for class com.github.copilot.sdk.generated.ToolExecutionStartEvent
- ToolExecutionStartEvent.ToolExecutionStartEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
ToolExecutionStartEvent. - ToolExecutionStartEventData(String, String, Object, String, String, String) - Constructor for record class com.github.copilot.sdk.generated.ToolExecutionStartEvent.ToolExecutionStartEventData
-
Creates an instance of a
ToolExecutionStartEventDatarecord class. - ToolHandler - Interface in com.github.copilot.sdk.json
-
Functional interface for handling tool invocations from the AI assistant.
- ToolInvocation - Class in com.github.copilot.sdk.json
-
Represents a tool invocation request from the AI assistant.
- ToolInvocation() - Constructor for class com.github.copilot.sdk.json.ToolInvocation
- toolName() - Method in record class com.github.copilot.sdk.generated.ExternalToolRequestedEvent.ExternalToolRequestedEventData
-
Returns the value of the
toolNamerecord component. - toolName() - Method in record class com.github.copilot.sdk.generated.ToolExecutionStartEvent.ToolExecutionStartEventData
-
Returns the value of the
toolNamerecord component. - toolName() - Method in record class com.github.copilot.sdk.generated.ToolUserRequestedEvent.ToolUserRequestedEventData
-
Returns the value of the
toolNamerecord component. - toolRequests() - Method in record class com.github.copilot.sdk.generated.AssistantMessageEvent.AssistantMessageEventData
-
Returns the value of the
toolRequestsrecord component. - ToolResultObject - Record Class in com.github.copilot.sdk.json
-
Result object returned from a tool execution.
- ToolResultObject(String, String, List<ToolBinaryResult>, String, String, Map<String, Object>) - Constructor for record class com.github.copilot.sdk.json.ToolResultObject
-
Creates an instance of a
ToolResultObjectrecord class. - tools - Variable in class com.github.copilot.sdk.generated.rpc.ServerRpc
-
API methods for the
toolsnamespace. - tools - Variable in class com.github.copilot.sdk.generated.rpc.SessionRpc
-
API methods for the
toolsnamespace. - tools() - Method in record class com.github.copilot.sdk.generated.CustomAgentsUpdatedAgent
-
Returns the value of the
toolsrecord component. - tools() - Method in record class com.github.copilot.sdk.generated.rpc.ToolsListResult
-
Returns the value of the
toolsrecord component. - tools() - Method in record class com.github.copilot.sdk.generated.SubagentSelectedEvent.SubagentSelectedEventData
-
Returns the value of the
toolsrecord component. - ToolsListParams - Record Class in com.github.copilot.sdk.generated.rpc
-
Request parameters for the
tools.listRPC method. - ToolsListParams(String) - Constructor for record class com.github.copilot.sdk.generated.rpc.ToolsListParams
-
Creates an instance of a
ToolsListParamsrecord class. - ToolsListResult - Record Class in com.github.copilot.sdk.generated.rpc
-
Result for the
tools.listRPC method. - ToolsListResult(List<Tool>) - Constructor for record class com.github.copilot.sdk.generated.rpc.ToolsListResult
-
Creates an instance of a
ToolsListResultrecord class. - toolTelemetry() - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteEvent.ToolExecutionCompleteEventData
-
Returns the value of the
toolTelemetryrecord component. - toolTelemetry() - Method in record class com.github.copilot.sdk.json.ToolResultObject
-
Returns the value of the
toolTelemetryrecord component. - toolTitle() - Method in record class com.github.copilot.sdk.generated.AssistantMessageToolRequest
-
Returns the value of the
toolTitlerecord component. - ToolUserRequestedEvent - Class in com.github.copilot.sdk.generated
-
The
tool.user_requestedsession event. - ToolUserRequestedEvent() - Constructor for class com.github.copilot.sdk.generated.ToolUserRequestedEvent
- ToolUserRequestedEvent.ToolUserRequestedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
ToolUserRequestedEvent. - ToolUserRequestedEventData(String, String, Object) - Constructor for record class com.github.copilot.sdk.generated.ToolUserRequestedEvent.ToolUserRequestedEventData
-
Creates an instance of a
ToolUserRequestedEventDatarecord class. - toString() - Method in record class com.github.copilot.sdk.generated.AbortEvent.AbortEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.AssistantIntentEvent.AssistantIntentEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.AssistantMessageDeltaEvent.AssistantMessageDeltaEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.AssistantMessageEvent.AssistantMessageEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.AssistantMessageToolRequest
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.AssistantReasoningDeltaEvent.AssistantReasoningDeltaEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.AssistantReasoningEvent.AssistantReasoningEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.AssistantStreamingDeltaEvent.AssistantStreamingDeltaEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.AssistantTurnEndEvent.AssistantTurnEndEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.AssistantTurnStartEvent.AssistantTurnStartEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.AssistantUsageCopilotUsage
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.AssistantUsageCopilotUsageTokenDetail
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.AssistantUsageEvent.AssistantUsageEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.AssistantUsageQuotaSnapshot
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.AutoModeSwitchCompletedEvent.AutoModeSwitchCompletedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.AutoModeSwitchRequestedEvent.AutoModeSwitchRequestedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.CapabilitiesChangedEvent.CapabilitiesChangedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.CapabilitiesChangedUI
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.CommandCompletedEvent.CommandCompletedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.CommandExecuteEvent.CommandExecuteEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.CommandQueuedEvent.CommandQueuedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.CommandsChangedCommand
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.CommandsChangedEvent.CommandsChangedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsed
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsedCopilotUsage
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.CustomAgentsUpdatedAgent
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.ElicitationCompletedEvent.ElicitationCompletedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.ElicitationRequestedEvent.ElicitationRequestedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.ElicitationRequestedSchema
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.ExitPlanModeCompletedEvent.ExitPlanModeCompletedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.ExitPlanModeRequestedEvent.ExitPlanModeRequestedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.ExtensionsLoadedExtension
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.ExternalToolCompletedEvent.ExternalToolCompletedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.ExternalToolRequestedEvent.ExternalToolRequestedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.HandoffRepository
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.HookEndError
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.HookEndEvent.HookEndEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.HookStartEvent.HookStartEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.McpOauthCompletedEvent.McpOauthCompletedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.McpOauthRequiredEvent.McpOauthRequiredEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.McpOauthRequiredStaticClientConfig
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.McpServersLoadedServer
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.PendingMessagesModifiedEvent.PendingMessagesModifiedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.PermissionCompletedEvent.PermissionCompletedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.PermissionCompletedResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.PermissionRequestedEvent.PermissionRequestedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.AccountGetQuotaResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.AccountQuotaSnapshot
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.AgentInfo
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServer
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.Extension
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.HistoryCompactContextWindow
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.InstructionsSources
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigAddParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigDisableParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigEnableParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigListResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigRemoveParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.McpConfigUpdateParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.McpDiscoverParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.McpDiscoverResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.McpServer
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.Model
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.ModelBilling
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilities
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesLimits
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesLimitsVision
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverride
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverrideLimits
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverrideLimitsVision
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverrideSupports
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesSupports
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.ModelPolicy
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.ModelsListResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.PingParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.PingResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.Plugin
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.ServerSkill
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentDeselectParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentDeselectResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentGetCurrentParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentGetCurrentResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentListParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentListResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentReloadParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentReloadResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentSelectParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAgentSelectResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAuthGetStatusParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionAuthGetStatusResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionCommandsHandlePendingCommandParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionCommandsHandlePendingCommandResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsDisableParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsDisableResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsEnableParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsEnableResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsListParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsListResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsReloadParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionExtensionsReloadResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFleetStartParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFleetStartResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsAppendFileParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsError
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsExistsParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsExistsResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsMkdirParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesEntry
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReadFileParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReadFileResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsRenameParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsRmParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsSetProviderParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsSetProviderResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsStatParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsStatResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsWriteFileParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionHistoryCompactParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionHistoryCompactResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionHistoryTruncateParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionHistoryTruncateResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionInstructionsGetSourcesParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionInstructionsGetSourcesResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionLogParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionLogResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpDisableParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpDisableResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpEnableParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpEnableResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpListParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpListResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpOauthLoginParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpOauthLoginResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpReloadParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionMcpReloadResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModeGetParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModeGetResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModelGetCurrentParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModelGetCurrentResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModelSwitchToParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModelSwitchToResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModeSetParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionModeSetResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionNameGetParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionNameGetResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionNameSetParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsHandlePendingPermissionRequestParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsHandlePendingPermissionRequestResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsResetSessionApprovalsParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsResetSessionApprovalsResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsSetApproveAllParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPermissionsSetApproveAllResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanDeleteParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanDeleteResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanReadParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanReadResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanUpdateParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPlanUpdateResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPluginsListParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionPluginsListResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionsForkParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionsForkResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionShellExecParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionShellExecResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionShellKillParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionShellKillResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsDisableParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsDisableResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsEnableParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsEnableResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsListParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsListResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsReloadParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionSkillsReloadResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionToolsHandlePendingToolCallParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionToolsHandlePendingToolCallResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUiElicitationParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUiElicitationResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUiHandlePendingElicitationParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUiHandlePendingElicitationResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUsageGetMetricsParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUsageGetMetricsResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceCreateFileParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceCreateFileResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceListFilesParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceListFilesResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceReadFileParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspaceReadFileResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesCreateFileParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesListFilesParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesListFilesResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesReadFileParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesReadFileResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.Skill
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SkillsConfigSetDisabledSkillsParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SkillsDiscoverParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.SkillsDiscoverResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.Tool
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.ToolsListParams
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.ToolsListResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.UIElicitationResponse
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.UIElicitationSchema
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsCodeChanges
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsModelMetric
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsModelMetricRequests
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsModelMetricUsage
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SamplingCompletedEvent.SamplingCompletedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SamplingRequestedEvent.SamplingRequestedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionBackgroundTasksChangedEvent.SessionBackgroundTasksChangedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionCompactionCompleteEvent.SessionCompactionCompleteEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionCompactionStartEvent.SessionCompactionStartEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionContextChangedEvent.SessionContextChangedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionCustomAgentsUpdatedEvent.SessionCustomAgentsUpdatedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionErrorEvent.SessionErrorEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionExtensionsLoadedEvent.SessionExtensionsLoadedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionHandoffEvent.SessionHandoffEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionIdleEvent.SessionIdleEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionInfoEvent.SessionInfoEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionMcpServersLoadedEvent.SessionMcpServersLoadedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionMcpServerStatusChangedEvent.SessionMcpServerStatusChangedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionModeChangedEvent.SessionModeChangedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionModelChangeEvent.SessionModelChangeEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionPlanChangedEvent.SessionPlanChangedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionRemoteSteerableChangedEvent.SessionRemoteSteerableChangedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionResumeEvent.SessionResumeEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionShutdownEvent.SessionShutdownEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionSkillsLoadedEvent.SessionSkillsLoadedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionSnapshotRewindEvent.SessionSnapshotRewindEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionStartEvent.SessionStartEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionTaskCompleteEvent.SessionTaskCompleteEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionTitleChangedEvent.SessionTitleChangedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionToolsUpdatedEvent.SessionToolsUpdatedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionTruncationEvent.SessionTruncationEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionUsageInfoEvent.SessionUsageInfoEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionWarningEvent.SessionWarningEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SessionWorkspaceFileChangedEvent.SessionWorkspaceFileChangedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.ShutdownCodeChanges
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.ShutdownModelMetric
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.ShutdownModelMetricRequests
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.ShutdownModelMetricUsage
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SkillInvokedEvent.SkillInvokedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SkillsLoadedSkill
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SubagentCompletedEvent.SubagentCompletedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SubagentDeselectedEvent.SubagentDeselectedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SubagentFailedEvent.SubagentFailedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SubagentSelectedEvent.SubagentSelectedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SubagentStartedEvent.SubagentStartedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SystemMessageEvent.SystemMessageEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SystemMessageMetadata
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.SystemNotificationEvent.SystemNotificationEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteError
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteEvent.ToolExecutionCompleteEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.ToolExecutionCompleteResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.ToolExecutionPartialResultEvent.ToolExecutionPartialResultEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.ToolExecutionProgressEvent.ToolExecutionProgressEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.ToolExecutionStartEvent.ToolExecutionStartEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.ToolUserRequestedEvent.ToolUserRequestedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.UserInputCompletedEvent.UserInputCompletedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.UserInputRequestedEvent.UserInputRequestedEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.UserMessageEvent.UserMessageEventData
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.generated.WorkingDirectoryContext
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.Attachment
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.CreateSessionResponse
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.DeleteSessionResponse
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.GetForegroundSessionResponse
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.GetLastSessionIdResponse
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.GetMessagesResponse
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.GetSessionMetadataResponse
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.ListSessionsResponse
-
Returns a string representation of this record class.
- toString() - Method in class com.github.copilot.sdk.json.PermissionRequestResultKind
- toString() - Method in record class com.github.copilot.sdk.json.PingResponse
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.PostToolUseHookOutput
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.PreToolUseHookOutput
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.ResumeSessionResponse
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.SendMessageResponse
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.SessionEndHookInput
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.SessionEndHookOutput
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.SessionLifecycleEventMetadata
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.SessionStartHookInput
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.SessionStartHookOutput
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.SetForegroundSessionResponse
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.ToolBinaryResult
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.ToolDefinition
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.ToolResultObject
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookInput
-
Returns a string representation of this record class.
- toString() - Method in record class com.github.copilot.sdk.json.UserPromptSubmittedHookOutput
-
Returns a string representation of this record class.
- totalApiDurationMs() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUsageGetMetricsResult
-
Returns the value of the
totalApiDurationMsrecord component. - totalApiDurationMs() - Method in record class com.github.copilot.sdk.generated.SessionShutdownEvent.SessionShutdownEventData
-
Returns the value of the
totalApiDurationMsrecord component. - totalNanoAiu() - Method in record class com.github.copilot.sdk.generated.AssistantUsageCopilotUsage
-
Returns the value of the
totalNanoAiurecord component. - totalNanoAiu() - Method in record class com.github.copilot.sdk.generated.CompactionCompleteCompactionTokensUsedCopilotUsage
-
Returns the value of the
totalNanoAiurecord component. - totalPremiumRequestCost() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUsageGetMetricsResult
-
Returns the value of the
totalPremiumRequestCostrecord component. - totalPremiumRequests() - Method in record class com.github.copilot.sdk.generated.SessionShutdownEvent.SessionShutdownEventData
-
Returns the value of the
totalPremiumRequestsrecord component. - totalResponseSizeBytes() - Method in record class com.github.copilot.sdk.generated.AssistantStreamingDeltaEvent.AssistantStreamingDeltaEventData
-
Returns the value of the
totalResponseSizeBytesrecord component. - totalTokens() - Method in record class com.github.copilot.sdk.generated.SubagentCompletedEvent.SubagentCompletedEventData
-
Returns the value of the
totalTokensrecord component. - totalTokens() - Method in record class com.github.copilot.sdk.generated.SubagentFailedEvent.SubagentFailedEventData
-
Returns the value of the
totalTokensrecord component. - totalToolCalls() - Method in record class com.github.copilot.sdk.generated.SubagentCompletedEvent.SubagentCompletedEventData
-
Returns the value of the
totalToolCallsrecord component. - totalToolCalls() - Method in record class com.github.copilot.sdk.generated.SubagentFailedEvent.SubagentFailedEventData
-
Returns the value of the
totalToolCallsrecord component. - totalUserRequests() - Method in record class com.github.copilot.sdk.generated.rpc.SessionUsageGetMetricsResult
-
Returns the value of the
totalUserRequestsrecord component. - traceparent() - Method in record class com.github.copilot.sdk.generated.ExternalToolRequestedEvent.ExternalToolRequestedEventData
-
Returns the value of the
traceparentrecord component. - tracestate() - Method in record class com.github.copilot.sdk.generated.ExternalToolRequestedEvent.ExternalToolRequestedEventData
-
Returns the value of the
tracestaterecord component. - TRANSFORM - Enum constant in enum class com.github.copilot.sdk.json.SectionOverrideAction
-
Transform the section content via a callback.
- transformedContent() - Method in record class com.github.copilot.sdk.generated.UserMessageEvent.UserMessageEventData
-
Returns the value of the
transformedContentrecord component. - truncate(SessionHistoryTruncateParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionHistoryApi
-
Invokes
session.history.truncate. - ttftMs() - Method in record class com.github.copilot.sdk.generated.AssistantUsageEvent.AssistantUsageEventData
-
Returns the value of the
ttftMsrecord component. - turnId() - Method in record class com.github.copilot.sdk.generated.AssistantTurnEndEvent.AssistantTurnEndEventData
-
Returns the value of the
turnIdrecord component. - turnId() - Method in record class com.github.copilot.sdk.generated.AssistantTurnStartEvent.AssistantTurnStartEventData
-
Returns the value of the
turnIdrecord component. - type() - Method in record class com.github.copilot.sdk.generated.AssistantMessageToolRequest
-
Returns the value of the
typerecord component. - type() - Method in record class com.github.copilot.sdk.generated.ElicitationRequestedSchema
-
Returns the value of the
typerecord component. - type() - Method in record class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServer
-
Returns the value of the
typerecord component. - type() - Method in record class com.github.copilot.sdk.generated.rpc.InstructionsSources
-
Returns the value of the
typerecord component. - type() - Method in record class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesEntry
-
Returns the value of the
typerecord component. - type() - Method in record class com.github.copilot.sdk.generated.rpc.UIElicitationSchema
-
Returns the value of the
typerecord component. - type() - Method in record class com.github.copilot.sdk.json.Attachment
-
Returns the value of the
typerecord component. - type() - Method in record class com.github.copilot.sdk.json.ToolBinaryResult
-
Returns the value of the
typerecord component.
U
- ui - Variable in class com.github.copilot.sdk.generated.rpc.SessionRpc
-
API methods for the
uinamespace. - ui() - Method in record class com.github.copilot.sdk.generated.CapabilitiesChangedEvent.CapabilitiesChangedEventData
-
Returns the value of the
uirecord component. - UIElicitationResponse - Record Class in com.github.copilot.sdk.generated.rpc
-
The elicitation response (accept with form values, decline, or cancel)
- UIElicitationResponse(UIElicitationResponseAction, Map<String, Object>) - Constructor for record class com.github.copilot.sdk.generated.rpc.UIElicitationResponse
-
Creates an instance of a
UIElicitationResponserecord class. - UIElicitationResponseAction - Enum Class in com.github.copilot.sdk.generated.rpc
-
The user's response: accept (submitted), decline (rejected), or cancel (dismissed)
- UIElicitationSchema - Record Class in com.github.copilot.sdk.generated.rpc
-
JSON Schema describing the form fields to present to the user
- UIElicitationSchema(String, Map<String, Object>, List<String>) - Constructor for record class com.github.copilot.sdk.generated.rpc.UIElicitationSchema
-
Creates an instance of a
UIElicitationSchemarecord class. - UNKNOWN - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionFsErrorCode
-
The
UNKNOWNvariant. - UnknownSessionEvent - Class in com.github.copilot.sdk.generated
-
Fallback for event types not yet known to this SDK version.
- UnknownSessionEvent() - Constructor for class com.github.copilot.sdk.generated.UnknownSessionEvent
- update(McpConfigUpdateParams) - Method in class com.github.copilot.sdk.generated.rpc.ServerMcpConfigApi
-
Invokes
mcp.config.update. - update(SessionPlanUpdateParams) - Method in class com.github.copilot.sdk.generated.rpc.SessionPlanApi
-
Invokes
session.plan.update. - UPDATE - Enum constant in enum class com.github.copilot.sdk.generated.PlanChangedOperation
-
The
updatevariant. - UPDATE - Enum constant in enum class com.github.copilot.sdk.generated.WorkspaceFileChangedOperation
-
The
updatevariant. - UPDATED - Static variable in class com.github.copilot.sdk.json.SessionLifecycleEventTypes
-
Event fired when a session is updated.
- updatedAt() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace
-
Returns the value of the
updatedAtrecord component. - upToEventId() - Method in record class com.github.copilot.sdk.generated.SessionSnapshotRewindEvent.SessionSnapshotRewindEventData
-
Returns the value of the
upToEventIdrecord component. - url() - Method in record class com.github.copilot.sdk.generated.ElicitationRequestedEvent.ElicitationRequestedEventData
-
Returns the value of the
urlrecord component. - url() - Method in record class com.github.copilot.sdk.generated.rpc.SessionLogParams
-
Returns the value of the
urlrecord component. - url() - Method in record class com.github.copilot.sdk.generated.SessionErrorEvent.SessionErrorEventData
-
Returns the value of the
urlrecord component. - url() - Method in record class com.github.copilot.sdk.generated.SessionInfoEvent.SessionInfoEventData
-
Returns the value of the
urlrecord component. - url() - Method in record class com.github.copilot.sdk.generated.SessionWarningEvent.SessionWarningEventData
-
Returns the value of the
urlrecord component. - URL - Enum constant in enum class com.github.copilot.sdk.generated.ElicitationRequestedMode
-
The
urlvariant. - usage - Variable in class com.github.copilot.sdk.generated.rpc.SessionRpc
-
API methods for the
usagenamespace. - usage() - Method in record class com.github.copilot.sdk.generated.rpc.UsageMetricsModelMetric
-
Returns the value of the
usagerecord component. - usage() - Method in record class com.github.copilot.sdk.generated.ShutdownModelMetric
-
Returns the value of the
usagerecord component. - usageAllowedWithExhaustedQuota() - Method in record class com.github.copilot.sdk.generated.AssistantUsageQuotaSnapshot
-
Returns the value of the
usageAllowedWithExhaustedQuotarecord component. - usageAllowedWithExhaustedQuota() - Method in record class com.github.copilot.sdk.generated.rpc.AccountQuotaSnapshot
-
Returns the value of the
usageAllowedWithExhaustedQuotarecord component. - UsageMetricsCodeChanges - Record Class in com.github.copilot.sdk.generated.rpc
-
Aggregated code change metrics
- UsageMetricsCodeChanges(Long, Long, Long) - Constructor for record class com.github.copilot.sdk.generated.rpc.UsageMetricsCodeChanges
-
Creates an instance of a
UsageMetricsCodeChangesrecord class. - UsageMetricsModelMetric - Record Class in com.github.copilot.sdk.generated.rpc
- UsageMetricsModelMetric(UsageMetricsModelMetricRequests, UsageMetricsModelMetricUsage) - Constructor for record class com.github.copilot.sdk.generated.rpc.UsageMetricsModelMetric
-
Creates an instance of a
UsageMetricsModelMetricrecord class. - UsageMetricsModelMetricRequests - Record Class in com.github.copilot.sdk.generated.rpc
-
Request count and cost metrics for this model
- UsageMetricsModelMetricRequests(Long, Double) - Constructor for record class com.github.copilot.sdk.generated.rpc.UsageMetricsModelMetricRequests
-
Creates an instance of a
UsageMetricsModelMetricRequestsrecord class. - UsageMetricsModelMetricUsage - Record Class in com.github.copilot.sdk.generated.rpc
-
Token usage metrics for this model
- UsageMetricsModelMetricUsage(Long, Long, Long, Long, Long) - Constructor for record class com.github.copilot.sdk.generated.rpc.UsageMetricsModelMetricUsage
-
Creates an instance of a
UsageMetricsModelMetricUsagerecord class. - usedRequests() - Method in record class com.github.copilot.sdk.generated.AssistantUsageQuotaSnapshot
-
Returns the value of the
usedRequestsrecord component. - usedRequests() - Method in record class com.github.copilot.sdk.generated.rpc.AccountQuotaSnapshot
-
Returns the value of the
usedRequestsrecord component. - USER - Enum constant in enum class com.github.copilot.sdk.generated.ExtensionsLoadedExtensionSource
-
The
uservariant. - USER - Enum constant in enum class com.github.copilot.sdk.generated.rpc.AuthInfoType
-
The
uservariant. - USER - Enum constant in enum class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServerSource
-
The
uservariant. - USER - Enum constant in enum class com.github.copilot.sdk.generated.rpc.ExtensionSource
-
The
uservariant. - USER - Enum constant in enum class com.github.copilot.sdk.generated.rpc.InstructionsSourcesLocation
-
The
uservariant. - USER - Enum constant in enum class com.github.copilot.sdk.generated.rpc.McpServerSource
-
The
uservariant. - USER - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace.SessionWorkspacesGetWorkspaceResultWorkspaceSessionSyncLevel
-
The
uservariant. - USER_NOT_AVAILABLE - Static variable in class com.github.copilot.sdk.json.PermissionRequestResultKind
-
The permission was denied because user confirmation was unavailable.
- UserInputCompletedEvent - Class in com.github.copilot.sdk.generated
-
The
user_input.completedsession event. - UserInputCompletedEvent() - Constructor for class com.github.copilot.sdk.generated.UserInputCompletedEvent
- UserInputCompletedEvent.UserInputCompletedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
UserInputCompletedEvent. - UserInputCompletedEventData(String, String, Boolean) - Constructor for record class com.github.copilot.sdk.generated.UserInputCompletedEvent.UserInputCompletedEventData
-
Creates an instance of a
UserInputCompletedEventDatarecord class. - UserInputHandler - Interface in com.github.copilot.sdk.json
-
Handler for user input requests from the agent.
- UserInputInvocation - Class in com.github.copilot.sdk.json
-
Context for a user input request invocation.
- UserInputInvocation() - Constructor for class com.github.copilot.sdk.json.UserInputInvocation
- UserInputRequest - Class in com.github.copilot.sdk.json
-
Request for user input from the agent.
- UserInputRequest() - Constructor for class com.github.copilot.sdk.json.UserInputRequest
- UserInputRequestedEvent - Class in com.github.copilot.sdk.generated
-
The
user_input.requestedsession event. - UserInputRequestedEvent() - Constructor for class com.github.copilot.sdk.generated.UserInputRequestedEvent
- UserInputRequestedEvent.UserInputRequestedEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
UserInputRequestedEvent. - UserInputRequestedEventData(String, String, List<String>, Boolean, String) - Constructor for record class com.github.copilot.sdk.generated.UserInputRequestedEvent.UserInputRequestedEventData
-
Creates an instance of a
UserInputRequestedEventDatarecord class. - UserInputResponse - Class in com.github.copilot.sdk.json
-
Response to a user input request.
- UserInputResponse() - Constructor for class com.github.copilot.sdk.json.UserInputResponse
- userInvocable() - Method in record class com.github.copilot.sdk.generated.CustomAgentsUpdatedAgent
-
Returns the value of the
userInvocablerecord component. - userInvocable() - Method in record class com.github.copilot.sdk.generated.rpc.ServerSkill
-
Returns the value of the
userInvocablerecord component. - userInvocable() - Method in record class com.github.copilot.sdk.generated.rpc.Skill
-
Returns the value of the
userInvocablerecord component. - userInvocable() - Method in record class com.github.copilot.sdk.generated.SkillsLoadedSkill
-
Returns the value of the
userInvocablerecord component. - UserMessageAgentMode - Enum Class in com.github.copilot.sdk.generated
-
The agent mode that was active when this message was sent
- UserMessageEvent - Class in com.github.copilot.sdk.generated
-
The
user.messagesession event. - UserMessageEvent() - Constructor for class com.github.copilot.sdk.generated.UserMessageEvent
- UserMessageEvent.UserMessageEventData - Record Class in com.github.copilot.sdk.generated
-
Data payload for
UserMessageEvent. - UserMessageEventData(String, String, List<Object>, List<String>, List<String>, String, UserMessageAgentMode, String) - Constructor for record class com.github.copilot.sdk.generated.UserMessageEvent.UserMessageEventData
-
Creates an instance of a
UserMessageEventDatarecord class. - UserPromptSubmittedHandler - Interface in com.github.copilot.sdk.json
-
Handler for user-prompt-submitted hooks.
- UserPromptSubmittedHookInput - Record Class in com.github.copilot.sdk.json
-
Input for a user-prompt-submitted hook.
- UserPromptSubmittedHookInput(long, String, String) - Constructor for record class com.github.copilot.sdk.json.UserPromptSubmittedHookInput
-
Creates an instance of a
UserPromptSubmittedHookInputrecord class. - UserPromptSubmittedHookOutput - Record Class in com.github.copilot.sdk.json
-
Output for a user-prompt-submitted hook.
- UserPromptSubmittedHookOutput(String, String, Boolean) - Constructor for record class com.github.copilot.sdk.json.UserPromptSubmittedHookOutput
-
Creates an instance of a
UserPromptSubmittedHookOutputrecord class.
V
- valueOf(String) - Static method in enum class com.github.copilot.sdk.ConnectionState
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.EventErrorPolicy
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.AssistantMessageToolRequestType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.ElicitationCompletedAction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.ElicitationRequestedMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.ExtensionsLoadedExtensionSource
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.ExtensionsLoadedExtensionStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.HandoffSourceType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.McpServersLoadedServerStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.McpServerStatusChangedStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.PermissionCompletedKind
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.PlanChangedOperation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.AuthInfoType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServerSource
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServerType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.ExtensionSource
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.ExtensionStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.InstructionsSourcesLocation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.InstructionsSourcesType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.McpServerSource
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.McpServerStatus
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionFsErrorCode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesEntryType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionFsSetProviderConventions
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionLogLevel
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionModeGetResult.SessionModeGetResultMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionModeSetResult.SessionModeSetResultMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace.SessionWorkspacesGetWorkspaceResultWorkspaceHostType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace.SessionWorkspacesGetWorkspaceResultWorkspaceSessionSyncLevel
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.ShellKillSignal
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.rpc.UIElicitationResponseAction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.ShutdownType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.SystemMessageRole
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.UserMessageAgentMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.WorkingDirectoryContextHostType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.generated.WorkspaceFileChangedOperation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.json.ElicitationResultAction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.json.SectionOverrideAction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.SdkProtocolVersion
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.github.copilot.sdk.SystemMessageMode
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.github.copilot.sdk.ConnectionState
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.EventErrorPolicy
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.AssistantMessageToolRequestType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.ElicitationCompletedAction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.ElicitationRequestedMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.ExtensionsLoadedExtensionSource
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.ExtensionsLoadedExtensionStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.HandoffSourceType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.McpServersLoadedServerStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.McpServerStatusChangedStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.PermissionCompletedKind
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.PlanChangedOperation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.rpc.AuthInfoType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServerSource
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServerType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.rpc.ExtensionSource
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.rpc.ExtensionStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.rpc.InstructionsSourcesLocation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.rpc.InstructionsSourcesType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.rpc.McpServerSource
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.rpc.McpServerStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionFsErrorCode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionFsReaddirWithTypesEntryType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionFsSetProviderConventions
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionLogLevel
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionModeGetResult.SessionModeGetResultMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionModeSetResult.SessionModeSetResultMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace.SessionWorkspacesGetWorkspaceResultWorkspaceHostType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult.SessionWorkspacesGetWorkspaceResultWorkspace.SessionWorkspacesGetWorkspaceResultWorkspaceSessionSyncLevel
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.rpc.ShellKillSignal
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.rpc.UIElicitationResponseAction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.ShutdownType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.SystemMessageRole
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.UserMessageAgentMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.WorkingDirectoryContextHostType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.generated.WorkspaceFileChangedOperation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.json.ElicitationResultAction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.json.SectionOverrideAction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.SdkProtocolVersion
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.github.copilot.sdk.SystemMessageMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- variables() - Method in record class com.github.copilot.sdk.generated.SystemMessageMetadata
-
Returns the value of the
variablesrecord component. - version() - Method in record class com.github.copilot.sdk.generated.rpc.Plugin
-
Returns the value of the
versionrecord component. - version() - Method in record class com.github.copilot.sdk.generated.SessionStartEvent.SessionStartEventData
-
Returns the value of the
versionrecord component. - vision() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesLimits
-
Returns the value of the
visionrecord component. - vision() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverrideLimits
-
Returns the value of the
visionrecord component. - vision() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesOverrideSupports
-
Returns the value of the
visionrecord component. - vision() - Method in record class com.github.copilot.sdk.generated.rpc.ModelCapabilitiesSupports
-
Returns the value of the
visionrecord component. - VSCODE - Enum constant in enum class com.github.copilot.sdk.generated.rpc.InstructionsSourcesType
-
The
vscodevariant.
W
- WARNING - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionLogLevel
-
The
warningvariant. - warnings() - Method in record class com.github.copilot.sdk.generated.SessionCustomAgentsUpdatedEvent.SessionCustomAgentsUpdatedEventData
-
Returns the value of the
warningsrecord component. - warningType() - Method in record class com.github.copilot.sdk.generated.SessionWarningEvent.SessionWarningEventData
-
Returns the value of the
warningTyperecord component. - wasFreeform() - Method in record class com.github.copilot.sdk.generated.UserInputCompletedEvent.UserInputCompletedEventData
-
Returns the value of the
wasFreeformrecord component. - WINDOWS - Enum constant in enum class com.github.copilot.sdk.generated.rpc.SessionFsSetProviderConventions
-
The
windowsvariant. - withModifiedArgs(String, JsonNode) - Static method in record class com.github.copilot.sdk.json.PreToolUseHookOutput
-
Creates an output with modified tool arguments.
- WORKING_DIRECTORY - Enum constant in enum class com.github.copilot.sdk.generated.rpc.InstructionsSourcesLocation
-
The
working-directoryvariant. - workingDirectory() - Method in record class com.github.copilot.sdk.generated.rpc.McpDiscoverParams
-
Returns the value of the
workingDirectoryrecord component. - WorkingDirectoryContext - Record Class in com.github.copilot.sdk.generated
-
Working directory and git context at session start
- WorkingDirectoryContext(String, String, String, WorkingDirectoryContextHostType, String, String, String, String) - Constructor for record class com.github.copilot.sdk.generated.WorkingDirectoryContext
-
Creates an instance of a
WorkingDirectoryContextrecord class. - WorkingDirectoryContextHostType - Enum Class in com.github.copilot.sdk.generated
-
Hosting platform type of the repository (github or ado)
- workspace() - Method in record class com.github.copilot.sdk.generated.rpc.SessionWorkspacesGetWorkspaceResult
-
Returns the value of the
workspacerecord component. - WORKSPACE - Enum constant in enum class com.github.copilot.sdk.generated.rpc.DiscoveredMcpServerSource
-
The
workspacevariant. - WORKSPACE - Enum constant in enum class com.github.copilot.sdk.generated.rpc.McpServerSource
-
The
workspacevariant. - WorkspaceFileChangedOperation - Enum Class in com.github.copilot.sdk.generated
-
Whether the file was newly created or updated
- workspacePath() - Method in record class com.github.copilot.sdk.json.CreateSessionResponse
-
Returns the value of the
workspacePathrecord component. - workspacePath() - Method in record class com.github.copilot.sdk.json.GetForegroundSessionResponse
-
Returns the value of the
workspacePathrecord component. - workspacePath() - Method in record class com.github.copilot.sdk.json.ResumeSessionResponse
-
Returns the value of the
workspacePathrecord component. - workspaces - Variable in class com.github.copilot.sdk.generated.rpc.SessionRpc
-
API methods for the
workspacesnamespace.
All Classes and Interfaces|All Packages|Constant Field Values
PermissionRequestResultKind.USER_NOT_AVAILABLEinstead.