@gitpod/sdk
Version:
Public TypeScript SDK for Ona.
1,469 lines (1,468 loc) • 139 kB
TypeScript
import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
import type { ServiceMetadata, ServiceSpec } from "./environment_automation_pb";
import type { Subject } from "./identity_pb";
import type { SupportedModel } from "./model_pb";
import type { PaginationRequest, PaginationResponse } from "./pagination_pb";
import type { Duration, Timestamp } from "@bufbuild/protobuf/wkt";
import type { Message } from "@bufbuild/protobuf";
/**
* Describes the file gitpod/v1/agent.proto.
*/
export declare const file_gitpod_v1_agent: GenFile;
/**
* PullRequest represents pull request metadata from source control systems.
* This message is used across workflow triggers, executions, and agent contexts
* to maintain consistent PR information throughout the system.
*
* @generated from message gitpod.v1.PullRequest
*/
export type PullRequest = Message<"gitpod.v1.PullRequest"> & {
/**
* Unique identifier from the source system (e.g., "123" for GitHub PR #123)
*
* @generated from field: string id = 1;
*/
id: string;
/**
* Pull request title
*
* @generated from field: string title = 2;
*/
title: string;
/**
* Source branch name (the branch being merged from)
*
* @generated from field: string from_branch = 3;
*/
fromBranch: string;
/**
* Target branch name (the branch being merged into)
*
* @generated from field: string to_branch = 4;
*/
toBranch: string;
/**
* Pull request URL (e.g., "https://github.com/owner/repo/pull/123")
*
* @generated from field: string url = 5;
*/
url: string;
/**
* Author name as provided by the SCM system
*
* @generated from field: string author = 6;
*/
author: string;
/**
* @generated from field: gitpod.v1.PullRequest.Repository repository = 7;
*/
repository?: PullRequest_Repository;
/**
* Whether this is a draft pull request
*
* @generated from field: bool draft = 8;
*/
draft: boolean;
/**
* @generated from field: gitpod.v1.PullRequest.State state = 9;
*/
state: PullRequest_State;
/**
* Current revision identity for the PR head commit. Used internally for
* workflow execution deduplication and excluded from customer SDKs.
*
* @generated from field: string head_sha = 10;
*/
headSha: string;
};
/**
* Describes the message gitpod.v1.PullRequest.
* Use `create(PullRequestSchema)` to create a new message.
*/
export declare const PullRequestSchema: GenMessage<PullRequest>;
/**
* Repository information
*
* @generated from message gitpod.v1.PullRequest.Repository
*/
export type PullRequest_Repository = Message<"gitpod.v1.PullRequest.Repository"> & {
/**
* @generated from field: string clone_url = 1;
*/
cloneUrl: string;
/**
* @generated from field: string host = 2;
*/
host: string;
/**
* @generated from field: string owner = 3;
*/
owner: string;
/**
* @generated from field: string name = 4;
*/
name: string;
};
/**
* Describes the message gitpod.v1.PullRequest.Repository.
* Use `create(PullRequest_RepositorySchema)` to create a new message.
*/
export declare const PullRequest_RepositorySchema: GenMessage<PullRequest_Repository>;
/**
* Current state of the pull request
*
* @generated from enum gitpod.v1.PullRequest.State
*/
export declare enum PullRequest_State {
/**
* @generated from enum value: STATE_UNSPECIFIED = 0;
*/
UNSPECIFIED = 0,
/**
* @generated from enum value: STATE_OPEN = 1;
*/
OPEN = 1,
/**
* @generated from enum value: STATE_CLOSED = 2;
*/
CLOSED = 2,
/**
* @generated from enum value: STATE_MERGED = 3;
*/
MERGED = 3
}
/**
* Describes the enum gitpod.v1.PullRequest.State.
*/
export declare const PullRequest_StateSchema: GenEnum<PullRequest_State>;
/**
* CodexSettings contains settings consumed only by the Codex app agent.
*
* @generated from message gitpod.v1.CodexSettings
*/
export type CodexSettings = Message<"gitpod.v1.CodexSettings"> & {
/**
* @generated from field: gitpod.v1.CodexOpenAIModel model = 1;
*/
model: CodexOpenAIModel;
/**
* @generated from field: gitpod.v1.CodexReasoningEffort reasoning_effort = 2;
*/
reasoningEffort: CodexReasoningEffort;
/**
* @generated from field: gitpod.v1.CodexServiceTier service_tier = 3;
*/
serviceTier: CodexServiceTier;
};
/**
* Describes the message gitpod.v1.CodexSettings.
* Use `create(CodexSettingsSchema)` to create a new message.
*/
export declare const CodexSettingsSchema: GenMessage<CodexSettings>;
/**
* @generated from message gitpod.v1.Agent
*/
export type Agent = Message<"gitpod.v1.Agent"> & {
/**
* @generated from field: string id = 1;
*/
id: string;
/**
* @generated from field: gitpod.v1.AgentMetadata metadata = 2;
*/
metadata?: AgentMetadata;
/**
* @generated from field: gitpod.v1.RunnerSideAgentSpec spec = 3 [deprecated = true];
* @deprecated
*/
spec?: RunnerSideAgentSpec;
/**
* @generated from oneof gitpod.v1.Agent.agent_spec
*/
agentSpec: {
/**
* @generated from field: gitpod.v1.RunnerSideAgentSpec runner_side = 4;
*/
value: RunnerSideAgentSpec;
case: "runnerSide";
} | {
/**
* @generated from field: gitpod.v1.InEnvironmentAgentSpec in_environment = 5;
*/
value: InEnvironmentAgentSpec;
case: "inEnvironment";
} | {
case: undefined;
value?: undefined;
};
};
/**
* Describes the message gitpod.v1.Agent.
* Use `create(AgentSchema)` to create a new message.
*/
export declare const AgentSchema: GenMessage<Agent>;
/**
* @generated from message gitpod.v1.AgentMetadata
*/
export type AgentMetadata = Message<"gitpod.v1.AgentMetadata"> & {
/**
* @generated from field: string name = 1;
*/
name: string;
/**
* @generated from field: string description = 2;
*/
description: string;
};
/**
* Describes the message gitpod.v1.AgentMetadata.
* Use `create(AgentMetadataSchema)` to create a new message.
*/
export declare const AgentMetadataSchema: GenMessage<AgentMetadata>;
/**
* @generated from message gitpod.v1.AgentCodeContext
*/
export type AgentCodeContext = Message<"gitpod.v1.AgentCodeContext"> & {
/**
* @generated from oneof gitpod.v1.AgentCodeContext.context
*/
context: {
/**
* @generated from field: string project_id = 1;
*/
value: string;
case: "projectId";
} | {
/**
* @generated from field: string environment_id = 2;
*/
value: string;
case: "environmentId";
} | {
/**
* @generated from field: gitpod.v1.AgentCodeContext.ContextURL context_url = 3;
*/
value: AgentCodeContext_ContextURL;
case: "contextUrl";
} | {
case: undefined;
value?: undefined;
};
/**
* Pull request context - optional metadata about the PR being worked on
* This is populated when the agent execution is triggered by a PR workflow
* or when explicitly provided through the browser extension
*
* @generated from field: optional gitpod.v1.PullRequest pull_request = 4;
*/
pullRequest?: PullRequest;
};
/**
* Describes the message gitpod.v1.AgentCodeContext.
* Use `create(AgentCodeContextSchema)` to create a new message.
*/
export declare const AgentCodeContextSchema: GenMessage<AgentCodeContext>;
/**
* @generated from message gitpod.v1.AgentCodeContext.ContextURL
*/
export type AgentCodeContext_ContextURL = Message<"gitpod.v1.AgentCodeContext.ContextURL"> & {
/**
* @generated from field: string url = 1;
*/
url: string;
/**
* @generated from field: string environment_class_id = 2;
*/
environmentClassId: string;
};
/**
* Describes the message gitpod.v1.AgentCodeContext.ContextURL.
* Use `create(AgentCodeContext_ContextURLSchema)` to create a new message.
*/
export declare const AgentCodeContext_ContextURLSchema: GenMessage<AgentCodeContext_ContextURL>;
/**
* @generated from message gitpod.v1.StartAgentRequest
*/
export type StartAgentRequest = Message<"gitpod.v1.StartAgentRequest"> & {
/**
* agent_id identifies the agent to start. If omitted, the backend uses the
* configured default agent ID, or the Ona in-environment agent when no
* default is configured.
*
* @generated from field: string agent_id = 1;
*/
agentId: string;
/**
* @generated from field: gitpod.v1.AgentCodeContext code_context = 2;
*/
codeContext?: AgentCodeContext;
/**
* @generated from field: string name = 3;
*/
name: string;
/**
* workflow_action_id is an optional reference to the workflow execution action
* that created this agent execution. Used for tracking and event correlation.
*
* @generated from field: optional string workflow_action_id = 4;
*/
workflowActionId?: string;
/**
* mode specifies the operational mode for this agent execution
* If not specified, defaults to AGENT_MODE_EXECUTION
*
* @generated from field: gitpod.v1.AgentMode mode = 5;
*/
mode: AgentMode;
/**
* runner_id specifies a runner for this agent execution.
* When set, the agent execution is routed to this runner instead of the
* runner associated with the environment.
*
* @generated from field: string runner_id = 6;
*/
runnerId: string;
/**
* annotations are key-value pairs for tracking external context
* (e.g., integration session IDs, GitHub issue references).
* Keys should follow domain/name convention (e.g., "agent-client-session/id").
*
* @generated from field: map<string, string> annotations = 7;
*/
annotations: {
[key: string]: string;
};
/**
* session_id is the ID of the session this agent execution belongs to.
* If empty, a new session is created implicitly.
*
* @generated from field: string session_id = 8;
*/
sessionId: string;
/**
* codex_settings contains desired manual settings for the Codex app agent.
*
* @generated from field: gitpod.v1.CodexSettings codex_settings = 9;
*/
codexSettings?: CodexSettings;
/**
* turn_options contains options for the initial turn. It is not persisted as
* durable execution state.
*
* @generated from field: gitpod.v1.TurnOptions turn_options = 10;
*/
turnOptions?: TurnOptions;
};
/**
* Describes the message gitpod.v1.StartAgentRequest.
* Use `create(StartAgentRequestSchema)` to create a new message.
*/
export declare const StartAgentRequestSchema: GenMessage<StartAgentRequest>;
/**
* @generated from message gitpod.v1.StartAgentResponse
*/
export type StartAgentResponse = Message<"gitpod.v1.StartAgentResponse"> & {
/**
* @generated from field: string agent_execution_id = 1;
*/
agentExecutionId: string;
};
/**
* Describes the message gitpod.v1.StartAgentResponse.
* Use `create(StartAgentResponseSchema)` to create a new message.
*/
export declare const StartAgentResponseSchema: GenMessage<StartAgentResponse>;
/**
* @generated from message gitpod.v1.ListAgentExecutionsRequest
*/
export type ListAgentExecutionsRequest = Message<"gitpod.v1.ListAgentExecutionsRequest"> & {
/**
* @generated from field: gitpod.v1.PaginationRequest pagination = 1;
*/
pagination?: PaginationRequest;
/**
* @generated from field: gitpod.v1.ListAgentExecutionsRequest.Filter filter = 2;
*/
filter?: ListAgentExecutionsRequest_Filter;
};
/**
* Describes the message gitpod.v1.ListAgentExecutionsRequest.
* Use `create(ListAgentExecutionsRequestSchema)` to create a new message.
*/
export declare const ListAgentExecutionsRequestSchema: GenMessage<ListAgentExecutionsRequest>;
/**
* @generated from message gitpod.v1.ListAgentExecutionsRequest.Filter
*/
export type ListAgentExecutionsRequest_Filter = Message<"gitpod.v1.ListAgentExecutionsRequest.Filter"> & {
/**
* @generated from field: repeated string agent_ids = 1;
*/
agentIds: string[];
/**
* @generated from field: repeated string project_ids = 2;
*/
projectIds: string[];
/**
* @generated from field: repeated string environment_ids = 3;
*/
environmentIds: string[];
/**
* @generated from field: repeated string creator_ids = 4;
*/
creatorIds: string[];
/**
* @generated from field: repeated gitpod.v1.AgentExecution.Phase status_phases = 5;
*/
statusPhases: AgentExecution_Phase[];
/**
* @generated from field: repeated gitpod.v1.AgentExecutionRole roles = 6;
*/
roles: AgentExecutionRole[];
/**
* annotations filters by key-value pairs. Only executions containing
* all specified annotations (with matching values) are returned.
*
* @generated from field: map<string, string> annotations = 7;
*/
annotations: {
[key: string]: string;
};
/**
* session_ids filters the response to only executions belonging to the specified sessions
*
* @generated from field: repeated string session_ids = 8;
*/
sessionIds: string[];
/**
* agent_execution_ids filters the response to only the specified executions.
* Useful for checking existence of a known set of execution IDs.
*
* @generated from field: repeated string agent_execution_ids = 9;
*/
agentExecutionIds: string[];
};
/**
* Describes the message gitpod.v1.ListAgentExecutionsRequest.Filter.
* Use `create(ListAgentExecutionsRequest_FilterSchema)` to create a new message.
*/
export declare const ListAgentExecutionsRequest_FilterSchema: GenMessage<ListAgentExecutionsRequest_Filter>;
/**
* @generated from message gitpod.v1.ListAgentExecutionsResponse
*/
export type ListAgentExecutionsResponse = Message<"gitpod.v1.ListAgentExecutionsResponse"> & {
/**
* @generated from field: gitpod.v1.PaginationResponse pagination = 1;
*/
pagination?: PaginationResponse;
/**
* @generated from field: repeated gitpod.v1.AgentExecution agent_executions = 2;
*/
agentExecutions: AgentExecution[];
};
/**
* Describes the message gitpod.v1.ListAgentExecutionsResponse.
* Use `create(ListAgentExecutionsResponseSchema)` to create a new message.
*/
export declare const ListAgentExecutionsResponseSchema: GenMessage<ListAgentExecutionsResponse>;
/**
* @generated from message gitpod.v1.GetAgentExecutionRequest
*/
export type GetAgentExecutionRequest = Message<"gitpod.v1.GetAgentExecutionRequest"> & {
/**
* @generated from field: string agent_execution_id = 1;
*/
agentExecutionId: string;
};
/**
* Describes the message gitpod.v1.GetAgentExecutionRequest.
* Use `create(GetAgentExecutionRequestSchema)` to create a new message.
*/
export declare const GetAgentExecutionRequestSchema: GenMessage<GetAgentExecutionRequest>;
/**
* @generated from message gitpod.v1.GetAgentExecutionResponse
*/
export type GetAgentExecutionResponse = Message<"gitpod.v1.GetAgentExecutionResponse"> & {
/**
* @generated from field: gitpod.v1.AgentExecution agent_execution = 1;
*/
agentExecution?: AgentExecution;
};
/**
* Describes the message gitpod.v1.GetAgentExecutionResponse.
* Use `create(GetAgentExecutionResponseSchema)` to create a new message.
*/
export declare const GetAgentExecutionResponseSchema: GenMessage<GetAgentExecutionResponse>;
/**
* @generated from message gitpod.v1.DeleteAgentExecutionRequest
*/
export type DeleteAgentExecutionRequest = Message<"gitpod.v1.DeleteAgentExecutionRequest"> & {
/**
* @generated from field: string agent_execution_id = 1;
*/
agentExecutionId: string;
};
/**
* Describes the message gitpod.v1.DeleteAgentExecutionRequest.
* Use `create(DeleteAgentExecutionRequestSchema)` to create a new message.
*/
export declare const DeleteAgentExecutionRequestSchema: GenMessage<DeleteAgentExecutionRequest>;
/**
* @generated from message gitpod.v1.DeleteAgentExecutionResponse
*/
export type DeleteAgentExecutionResponse = Message<"gitpod.v1.DeleteAgentExecutionResponse"> & {};
/**
* Describes the message gitpod.v1.DeleteAgentExecutionResponse.
* Use `create(DeleteAgentExecutionResponseSchema)` to create a new message.
*/
export declare const DeleteAgentExecutionResponseSchema: GenMessage<DeleteAgentExecutionResponse>;
/**
* @generated from message gitpod.v1.AgentExecution
*/
export type AgentExecution = Message<"gitpod.v1.AgentExecution"> & {
/**
* ID is a unique identifier of this agent run. No other agent run with the
* same name must be managed by this agent manager
*
* @generated from field: string id = 1;
*/
id: string;
/**
* Metadata is data associated with this agent that's required for other
* parts of Gitpod to function
*
* @generated from field: gitpod.v1.AgentExecution.Metadata metadata = 2;
*/
metadata?: AgentExecution_Metadata;
/**
* Spec is the configuration of the agent that's required for the
* runner to start the agent
*
* @generated from field: gitpod.v1.AgentExecution.Spec spec = 3;
*/
spec?: AgentExecution_Spec;
/**
* Status is the current status of the agent
*
* @generated from field: gitpod.v1.AgentExecution.Status status = 4;
*/
status?: AgentExecution_Status;
};
/**
* Describes the message gitpod.v1.AgentExecution.
* Use `create(AgentExecutionSchema)` to create a new message.
*/
export declare const AgentExecutionSchema: GenMessage<AgentExecution>;
/**
* @generated from message gitpod.v1.AgentExecution.Metadata
*/
export type AgentExecution_Metadata = Message<"gitpod.v1.AgentExecution.Metadata"> & {
/**
* @generated from field: string name = 1;
*/
name: string;
/**
* @generated from field: string description = 2;
*/
description: string;
/**
* @generated from field: gitpod.v1.Subject creator = 3;
*/
creator?: Subject;
/**
* @generated from field: google.protobuf.Timestamp created_at = 4;
*/
createdAt?: Timestamp;
/**
* @generated from field: google.protobuf.Timestamp updated_at = 5;
*/
updatedAt?: Timestamp;
/**
* role is the role of the agent execution
*
* @generated from field: gitpod.v1.AgentExecutionRole role = 6;
*/
role: AgentExecutionRole;
/**
* workflow_action_id is set when this agent execution was created as part of a workflow.
* Used to correlate agent executions with their parent workflow execution action.
*
* @generated from field: optional string workflow_action_id = 7;
*/
workflowActionId?: string;
/**
* annotations are key-value pairs for tracking external context.
*
* @generated from field: map<string, string> annotations = 8;
*/
annotations: {
[key: string]: string;
};
/**
* session_id is the ID of the session this agent execution belongs to.
*
* @generated from field: string session_id = 9;
*/
sessionId: string;
};
/**
* Describes the message gitpod.v1.AgentExecution.Metadata.
* Use `create(AgentExecution_MetadataSchema)` to create a new message.
*/
export declare const AgentExecution_MetadataSchema: GenMessage<AgentExecution_Metadata>;
/**
* @generated from message gitpod.v1.AgentExecution.Spec
*/
export type AgentExecution_Spec = Message<"gitpod.v1.AgentExecution.Spec"> & {
/**
* version of the spec. The value of this field has no semantic
* meaning (e.g. don't interpret it as as a timestamp),
* but it can be used to impose a partial order. If a.spec_version <
* b.spec_version then a was the spec before b.
*
* @generated from field: uint64 spec_version = 1;
*/
specVersion: bigint;
/**
* @generated from field: string session = 2;
*/
session: string;
/**
* desired_phase is the desired phase of the agent run
*
* @generated from field: gitpod.v1.AgentExecution.Phase desired_phase = 3;
*/
desiredPhase: AgentExecution_Phase;
/**
* @generated from field: string agent_id = 4;
*/
agentId: string;
/**
* @generated from field: gitpod.v1.AgentCodeContext code_context = 5;
*/
codeContext?: AgentCodeContext;
/**
* @generated from field: gitpod.v1.AgentExecution.Spec.Limits limits = 6;
*/
limits?: AgentExecution_Spec_Limits;
/**
* codex_settings contains persisted desired/manual settings for the Codex app agent.
*
* @generated from field: gitpod.v1.CodexSettings codex_settings = 9;
*/
codexSettings?: CodexSettings;
};
/**
* Describes the message gitpod.v1.AgentExecution.Spec.
* Use `create(AgentExecution_SpecSchema)` to create a new message.
*/
export declare const AgentExecution_SpecSchema: GenMessage<AgentExecution_Spec>;
/**
* @generated from message gitpod.v1.AgentExecution.Spec.Limits
*/
export type AgentExecution_Spec_Limits = Message<"gitpod.v1.AgentExecution.Spec.Limits"> & {
/**
* @generated from field: int64 max_iterations = 1;
*/
maxIterations: bigint;
/**
* @generated from field: int64 max_output_tokens = 2;
*/
maxOutputTokens: bigint;
/**
* @generated from field: int64 max_input_tokens = 3;
*/
maxInputTokens: bigint;
};
/**
* Describes the message gitpod.v1.AgentExecution.Spec.Limits.
* Use `create(AgentExecution_Spec_LimitsSchema)` to create a new message.
*/
export declare const AgentExecution_Spec_LimitsSchema: GenMessage<AgentExecution_Spec_Limits>;
/**
* @generated from message gitpod.v1.AgentExecution.Status
*/
export type AgentExecution_Status = Message<"gitpod.v1.AgentExecution.Status"> & {
/**
* version of the status. The value of this field has no semantic
* meaning (e.g. don't interpret it as as a timestamp),
* but it can be used to impose a partial order. If a.status_version <
* b.status_version then a was the status before b.
*
* @generated from field: uint64 status_version = 1;
*/
statusVersion: bigint;
/**
* @generated from field: string session = 2;
*/
session: string;
/**
* @generated from field: gitpod.v1.AgentExecution.Phase phase = 3;
*/
phase: AgentExecution_Phase;
/**
* failure_message contains the reason the agent run failed to operate.
*
* @generated from field: string failure_message = 4;
*/
failureMessage: string;
/**
* warning_message contains warnings, e.g. when the LLM is overloaded.
*
* @generated from field: string warning_message = 5;
*/
warningMessage: string;
/**
* failure_reason contains a structured reason code for the failure.
*
* @generated from field: gitpod.v1.AgentExecutionFailureReason failure_reason = 6;
*/
failureReason: AgentExecutionFailureReason;
/**
* conversation_url is the URL to the conversation (all messages exchanged between the agent and the user) of the agent run.
*
* @generated from field: string conversation_url = 10;
*/
conversationUrl: string;
/**
* transcript_url is the URL to the LLM transcript (all messages exchanged between the agent and the LLM) of the agent run.
*
* @generated from field: string transcript_url = 11;
*/
transcriptUrl: string;
/**
* support_bundle_url is the URL to download a diagnostic bundle for this agent execution.
*
* @generated from field: string support_bundle_url = 12;
*/
supportBundleUrl: string;
/**
* conversation_urls contains the v2 conversation streaming endpoints. When
* present, clients should use these URLs instead of conversation_url.
*
* @generated from field: gitpod.v1.AgentExecution.Status.ConversationURLs conversation_urls = 13;
*/
conversationUrls?: AgentExecution_Status_ConversationURLs;
/**
* @generated from field: int64 iterations = 20;
*/
iterations: bigint;
/**
* @generated from field: int64 input_tokens_used = 21;
*/
inputTokensUsed: bigint;
/**
* @generated from field: int64 output_tokens_used = 22;
*/
outputTokensUsed: bigint;
/**
* @generated from field: int64 context_window_length = 23;
*/
contextWindowLength: bigint;
/**
* @generated from field: int64 cached_creation_tokens_used = 24;
*/
cachedCreationTokensUsed: bigint;
/**
* @generated from field: int64 cached_input_tokens_used = 25;
*/
cachedInputTokensUsed: bigint;
/**
* context_window_limit is the selected model's maximum context window size in tokens.
*
* @generated from field: int64 context_window_limit = 26;
*/
contextWindowLimit: bigint;
/**
* judgement is the judgement of the agent run produced by the judgement prompt.
*
* @generated from field: string judgement = 30;
*/
judgement: string;
/**
* current_operation is the current operation of the agent execution.
*
* @generated from field: gitpod.v1.AgentExecution.Status.CurrentOperation current_operation = 40;
*/
currentOperation?: AgentExecution_Status_CurrentOperation;
/**
* used_environments is the list of environments that were used by the agent execution.
*
* @generated from field: repeated gitpod.v1.AgentExecution.Status.EnvironmentUsage used_environments = 50;
*/
usedEnvironments: AgentExecution_Status_EnvironmentUsage[];
/**
* current_activity is the current activity description of the agent execution.
*
* @generated from field: string current_activity = 60;
*/
currentActivity: string;
/**
* outputs is a map of key-value pairs that can be set by the agent during execution.
* Similar to task execution outputs, but with typed values for structured data.
*
* @generated from field: map<string, gitpod.v1.AgentExecution.Status.OutputValue> outputs = 70;
*/
outputs: {
[key: string]: AgentExecution_Status_OutputValue;
};
/**
* supported_model is the LLM model being used by the agent execution.
*
* @generated from field: gitpod.v1.SupportedModel supported_model = 80;
*/
supportedModel: SupportedModel;
/**
* llm_capabilities describes provider capabilities for the selected LLM integration.
*
* @generated from field: gitpod.v1.AgentExecution.Status.LLMCapabilities llm_capabilities = 81;
*/
llmCapabilities?: AgentExecution_Status_LLMCapabilities;
/**
* mode is the current operational mode of the agent execution.
* This is set by the agent when entering different modes (e.g., Ralph mode via /ona:ralph command).
*
* @generated from field: gitpod.v1.AgentMode mode = 90;
*/
mode: AgentMode;
/**
* mcp_integration_statuses contains the status of all MCP integrations used by this agent execution
*
* @generated from field: repeated gitpod.v1.AgentExecution.Status.MCPIntegrationStatus mcp_integration_statuses = 100;
*/
mcpIntegrationStatuses: AgentExecution_Status_MCPIntegrationStatus[];
/**
* waiting_info is set when phase is PHASE_WAITING_FOR_INPUT and the agent
* has registered interests (timers, sub-agent completions, user messages).
*
* @generated from field: gitpod.v1.AgentExecution.WaitingInfo waiting_info = 110;
*/
waitingInfo?: AgentExecution_WaitingInfo;
/**
* terminal_id is the ID of the terminal running the agent, if the agent runs as a terminal service (runsOn: terminal).
*
* @generated from field: string terminal_id = 130;
*/
terminalId: string;
/**
* goal projects the current agent goal, if any.
*
* @generated from field: gitpod.v1.AgentExecution.Status.Goal goal = 140;
*/
goal?: AgentExecution_Status_Goal;
/**
* codex_settings contains runtime effective settings reported by the Codex app agent.
*
* @generated from field: gitpod.v1.CodexSettings codex_settings = 150;
*/
codexSettings?: CodexSettings;
/**
* @generated from field: repeated gitpod.v1.AgentExecution.Status.Subagent subagents = 160;
*/
subagents: AgentExecution_Status_Subagent[];
};
/**
* Describes the message gitpod.v1.AgentExecution.Status.
* Use `create(AgentExecution_StatusSchema)` to create a new message.
*/
export declare const AgentExecution_StatusSchema: GenMessage<AgentExecution_Status>;
/**
* @generated from message gitpod.v1.AgentExecution.Status.ToolUse
*/
export type AgentExecution_Status_ToolUse = Message<"gitpod.v1.AgentExecution.Status.ToolUse"> & {
/**
* @generated from field: string tool_name = 1;
*/
toolName: string;
/**
* @generated from field: bool complete = 2;
*/
complete: boolean;
};
/**
* Describes the message gitpod.v1.AgentExecution.Status.ToolUse.
* Use `create(AgentExecution_Status_ToolUseSchema)` to create a new message.
*/
export declare const AgentExecution_Status_ToolUseSchema: GenMessage<AgentExecution_Status_ToolUse>;
/**
* @generated from message gitpod.v1.AgentExecution.Status.LLM
*/
export type AgentExecution_Status_LLM = Message<"gitpod.v1.AgentExecution.Status.LLM"> & {
/**
* @generated from field: bool complete = 1;
*/
complete: boolean;
};
/**
* Describes the message gitpod.v1.AgentExecution.Status.LLM.
* Use `create(AgentExecution_Status_LLMSchema)` to create a new message.
*/
export declare const AgentExecution_Status_LLMSchema: GenMessage<AgentExecution_Status_LLM>;
/**
* @generated from message gitpod.v1.AgentExecution.Status.CurrentOperation
*/
export type AgentExecution_Status_CurrentOperation = Message<"gitpod.v1.AgentExecution.Status.CurrentOperation"> & {
/**
* @generated from field: string session = 1;
*/
session: string;
/**
* retries is the number of times the agent run has retried one or more steps
*
* @generated from field: int64 retries = 2;
*/
retries: bigint;
/**
* @generated from oneof gitpod.v1.AgentExecution.Status.CurrentOperation.operation
*/
operation: {
/**
* @generated from field: gitpod.v1.AgentExecution.Status.ToolUse tool_use = 3;
*/
value: AgentExecution_Status_ToolUse;
case: "toolUse";
} | {
/**
* @generated from field: gitpod.v1.AgentExecution.Status.LLM llm = 4;
*/
value: AgentExecution_Status_LLM;
case: "llm";
} | {
case: undefined;
value?: undefined;
};
};
/**
* Describes the message gitpod.v1.AgentExecution.Status.CurrentOperation.
* Use `create(AgentExecution_Status_CurrentOperationSchema)` to create a new message.
*/
export declare const AgentExecution_Status_CurrentOperationSchema: GenMessage<AgentExecution_Status_CurrentOperation>;
/**
* @generated from message gitpod.v1.AgentExecution.Status.EnvironmentUsage
*/
export type AgentExecution_Status_EnvironmentUsage = Message<"gitpod.v1.AgentExecution.Status.EnvironmentUsage"> & {
/**
* @generated from field: string environment_id = 1;
*/
environmentId: string;
/**
* @generated from field: bool created_by_agent = 2;
*/
createdByAgent: boolean;
};
/**
* Describes the message gitpod.v1.AgentExecution.Status.EnvironmentUsage.
* Use `create(AgentExecution_Status_EnvironmentUsageSchema)` to create a new message.
*/
export declare const AgentExecution_Status_EnvironmentUsageSchema: GenMessage<AgentExecution_Status_EnvironmentUsage>;
/**
* @generated from message gitpod.v1.AgentExecution.Status.ConversationURLs
*/
export type AgentExecution_Status_ConversationURLs = Message<"gitpod.v1.AgentExecution.Status.ConversationURLs"> & {
/**
* history is the v2 durable conversation history endpoint.
*
* @generated from field: string history = 1;
*/
history: string;
/**
* live is the v2 live Server-Sent Events endpoint.
*
* @generated from field: string live = 2;
*/
live: string;
/**
* blobs is the v2 blob endpoint prefix for offloaded conversation payloads.
*
* @generated from field: string blobs = 3;
*/
blobs: string;
};
/**
* Describes the message gitpod.v1.AgentExecution.Status.ConversationURLs.
* Use `create(AgentExecution_Status_ConversationURLsSchema)` to create a new message.
*/
export declare const AgentExecution_Status_ConversationURLsSchema: GenMessage<AgentExecution_Status_ConversationURLs>;
/**
* @generated from message gitpod.v1.AgentExecution.Status.Subagent
*/
export type AgentExecution_Status_Subagent = Message<"gitpod.v1.AgentExecution.Status.Subagent"> & {
/**
* @generated from field: string id = 1;
*/
id: string;
/**
* @generated from field: string parent_id = 2;
*/
parentId: string;
/**
* @generated from field: string name = 3;
*/
name: string;
/**
* @generated from field: string current_activity = 4;
*/
currentActivity: string;
/**
* @generated from field: string status_message = 5;
*/
statusMessage: string;
/**
* @generated from field: gitpod.v1.AgentExecution.Phase phase = 6;
*/
phase: AgentExecution_Phase;
/**
* @generated from field: gitpod.v1.AgentExecution.Status.ConversationURLs conversation_urls = 7;
*/
conversationUrls?: AgentExecution_Status_ConversationURLs;
/**
* @generated from field: google.protobuf.Timestamp created_at = 8;
*/
createdAt?: Timestamp;
/**
* @generated from field: google.protobuf.Timestamp updated_at = 9;
*/
updatedAt?: Timestamp;
};
/**
* Describes the message gitpod.v1.AgentExecution.Status.Subagent.
* Use `create(AgentExecution_Status_SubagentSchema)` to create a new message.
*/
export declare const AgentExecution_Status_SubagentSchema: GenMessage<AgentExecution_Status_Subagent>;
/**
* @generated from message gitpod.v1.AgentExecution.Status.OutputValue
*/
export type AgentExecution_Status_OutputValue = Message<"gitpod.v1.AgentExecution.Status.OutputValue"> & {
/**
* @generated from oneof gitpod.v1.AgentExecution.Status.OutputValue.value
*/
value: {
/**
* @generated from field: string string_value = 1;
*/
value: string;
case: "stringValue";
} | {
/**
* @generated from field: int64 int_value = 2;
*/
value: bigint;
case: "intValue";
} | {
/**
* @generated from field: double float_value = 3;
*/
value: number;
case: "floatValue";
} | {
/**
* @generated from field: bool bool_value = 4;
*/
value: boolean;
case: "boolValue";
} | {
case: undefined;
value?: undefined;
};
};
/**
* Describes the message gitpod.v1.AgentExecution.Status.OutputValue.
* Use `create(AgentExecution_Status_OutputValueSchema)` to create a new message.
*/
export declare const AgentExecution_Status_OutputValueSchema: GenMessage<AgentExecution_Status_OutputValue>;
/**
* @generated from message gitpod.v1.AgentExecution.Status.LLMCapabilities
*/
export type AgentExecution_Status_LLMCapabilities = Message<"gitpod.v1.AgentExecution.Status.LLMCapabilities"> & {
/**
* disabled_capabilities lists provider capabilities unavailable for this
* execution's selected LLM integration.
*
* @generated from field: repeated gitpod.v1.LLMDisabledCapability disabled_capabilities = 1;
*/
disabledCapabilities: LLMDisabledCapability[];
};
/**
* Describes the message gitpod.v1.AgentExecution.Status.LLMCapabilities.
* Use `create(AgentExecution_Status_LLMCapabilitiesSchema)` to create a new message.
*/
export declare const AgentExecution_Status_LLMCapabilitiesSchema: GenMessage<AgentExecution_Status_LLMCapabilities>;
/**
* MCPIntegrationStatus represents the status of a single MCP integration
* within an agent execution context
*
* @generated from message gitpod.v1.AgentExecution.Status.MCPIntegrationStatus
*/
export type AgentExecution_Status_MCPIntegrationStatus = Message<"gitpod.v1.AgentExecution.Status.MCPIntegrationStatus"> & {
/**
* id is the unique name of the MCP integration
*
* @generated from field: string id = 1;
*/
id: string;
/**
* name is the unique name of the MCP integration (e.g., "linear", "notion")
*
* @generated from field: string name = 2;
*/
name: string;
/**
* phase is the current connection/health phase
*
* @generated from field: gitpod.v1.MCPIntegrationPhase phase = 3;
*/
phase: MCPIntegrationPhase;
/**
* failure_message contains the reason the MCP integration failed to connect or operate
*
* @generated from field: string failure_message = 4;
*/
failureMessage: string;
/**
* warning_message contains warnings (e.g., rate limiting, degraded performance)
*
* @generated from field: string warning_message = 5;
*/
warningMessage: string;
};
/**
* Describes the message gitpod.v1.AgentExecution.Status.MCPIntegrationStatus.
* Use `create(AgentExecution_Status_MCPIntegrationStatusSchema)` to create a new message.
*/
export declare const AgentExecution_Status_MCPIntegrationStatusSchema: GenMessage<AgentExecution_Status_MCPIntegrationStatus>;
/**
* Goal projects the current agent goal onto the execution status.
*
* @generated from message gitpod.v1.AgentExecution.Status.Goal
*/
export type AgentExecution_Status_Goal = Message<"gitpod.v1.AgentExecution.Status.Goal"> & {
/**
* objective is the current goal text tracked by the agent.
*
* @generated from field: string objective = 1;
*/
objective: string;
/**
* status is the lifecycle state of the current goal.
*
* @generated from field: gitpod.v1.AgentExecution.Status.Goal.GoalStatus status = 2;
*/
status: AgentExecution_Status_Goal_GoalStatus;
/**
* updated_at is the most recent goal update timestamp, when available.
*
* @generated from field: google.protobuf.Timestamp updated_at = 3;
*/
updatedAt?: Timestamp;
/**
* created_at is when the current goal was created, when available.
*
* @generated from field: google.protobuf.Timestamp created_at = 4;
*/
createdAt?: Timestamp;
/**
* time_used is the elapsed wall-clock time reported by the agent for this goal.
*
* @generated from field: google.protobuf.Duration time_used = 5;
*/
timeUsed?: Duration;
/**
* tokens_used is the token usage reported by the agent for this goal.
*
* @generated from field: int64 tokens_used = 6;
*/
tokensUsed: bigint;
/**
* token_budget is the token budget reported by the agent for this goal, when one exists.
*
* @generated from field: optional int64 token_budget = 7;
*/
tokenBudget?: bigint;
};
/**
* Describes the message gitpod.v1.AgentExecution.Status.Goal.
* Use `create(AgentExecution_Status_GoalSchema)` to create a new message.
*/
export declare const AgentExecution_Status_GoalSchema: GenMessage<AgentExecution_Status_Goal>;
/**
* @generated from enum gitpod.v1.AgentExecution.Status.Goal.GoalStatus
*/
export declare enum AgentExecution_Status_Goal_GoalStatus {
/**
* The agent did not report a goal status.
*
* @generated from enum value: GOAL_STATUS_UNSPECIFIED = 0;
*/
UNSPECIFIED = 0,
/**
* The goal is active and the agent may continue working toward it.
*
* @generated from enum value: GOAL_STATUS_ACTIVE = 1;
*/
ACTIVE = 1,
/**
* The goal is paused and should not continue until resumed.
*
* @generated from enum value: GOAL_STATUS_PAUSED = 2;
*/
PAUSED = 2,
/**
* The goal is complete and no further work is required.
*
* @generated from enum value: GOAL_STATUS_COMPLETED = 3;
*/
COMPLETED = 3,
/**
* The goal stopped because its configured token budget was exhausted.
*
* @generated from enum value: GOAL_STATUS_BUDGET_EXHAUSTED = 4;
*/
BUDGET_EXHAUSTED = 4,
/**
* The goal is blocked because the agent needs user input or an external state change before it can make progress.
*
* @generated from enum value: GOAL_STATUS_BLOCKED = 5;
*/
BLOCKED = 5,
/**
* The goal stopped because execution was limited by account, plan, or system usage limits rather than its explicit token budget.
*
* @generated from enum value: GOAL_STATUS_USAGE_LIMITED = 6;
*/
USAGE_LIMITED = 6
}
/**
* Describes the enum gitpod.v1.AgentExecution.Status.Goal.GoalStatus.
*/
export declare const AgentExecution_Status_Goal_GoalStatusSchema: GenEnum<AgentExecution_Status_Goal_GoalStatus>;
/**
* WaitingInfo describes what an agent is waiting for when in PHASE_WAITING_FOR_INPUT.
*
* @generated from message gitpod.v1.AgentExecution.WaitingInfo
*/
export type AgentExecution_WaitingInfo = Message<"gitpod.v1.AgentExecution.WaitingInfo"> & {
/**
* @generated from field: string wait_id = 1;
*/
waitId: string;
/**
* @generated from field: repeated gitpod.v1.AgentExecution.WaitingInfo.Interest interests = 2;
*/
interests: AgentExecution_WaitingInfo_Interest[];
/**
* @generated from field: google.protobuf.Timestamp waiting_since = 3;
*/
waitingSince?: Timestamp;
};
/**
* Describes the message gitpod.v1.AgentExecution.WaitingInfo.
* Use `create(AgentExecution_WaitingInfoSchema)` to create a new message.
*/
export declare const AgentExecution_WaitingInfoSchema: GenMessage<AgentExecution_WaitingInfo>;
/**
* @generated from message gitpod.v1.AgentExecution.WaitingInfo.TimerInterest
*/
export type AgentExecution_WaitingInfo_TimerInterest = Message<"gitpod.v1.AgentExecution.WaitingInfo.TimerInterest"> & {
/**
* duration is the original duration spec (e.g. "5m"), if interval-based.
*
* @generated from field: string duration = 1;
*/
duration: string;
/**
* cron is the cron expression, if cron-based.
*
* @generated from field: string cron = 2;
*/
cron: string;
/**
* fires_at is the next fire time.
*
* @generated from field: google.protobuf.Timestamp fires_at = 3;
*/
firesAt?: Timestamp;
};
/**
* Describes the message gitpod.v1.AgentExecution.WaitingInfo.TimerInterest.
* Use `create(AgentExecution_WaitingInfo_TimerInterestSchema)` to create a new message.
*/
export declare const AgentExecution_WaitingInfo_TimerInterestSchema: GenMessage<AgentExecution_WaitingInfo_TimerInterest>;
/**
* @generated from message gitpod.v1.AgentExecution.WaitingInfo.SubAgentInterest
*/
export type AgentExecution_WaitingInfo_SubAgentInterest = Message<"gitpod.v1.AgentExecution.WaitingInfo.SubAgentInterest"> & {
/**
* @generated from field: string execution_id = 1;
*/
executionId: string;
};
/**
* Describes the message gitpod.v1.AgentExecution.WaitingInfo.SubAgentInterest.
* Use `create(AgentExecution_WaitingInfo_SubAgentInterestSchema)` to create a new message.
*/
export declare const AgentExecution_WaitingInfo_SubAgentInterestSchema: GenMessage<AgentExecution_WaitingInfo_SubAgentInterest>;
/**
* @generated from message gitpod.v1.AgentExecution.WaitingInfo.UserMessageInterest
*/
export type AgentExecution_WaitingInfo_UserMessageInterest = Message<"gitpod.v1.AgentExecution.WaitingInfo.UserMessageInterest"> & {};
/**
* Describes the message gitpod.v1.AgentExecution.WaitingInfo.UserMessageInterest.
* Use `create(AgentExecution_WaitingInfo_UserMessageInterestSchema)` to create a new message.
*/
export declare const AgentExecution_WaitingInfo_UserMessageInterestSchema: GenMessage<AgentExecution_WaitingInfo_UserMessageInterest>;
/**
* @generated from message gitpod.v1.AgentExecution.WaitingInfo.EnvironmentInterest
*/
export type AgentExecution_WaitingInfo_EnvironmentInterest = Message<"gitpod.v1.AgentExecution.WaitingInfo.EnvironmentInterest"> & {
/**
* @generated from field: string environment_id = 1;
*/
environmentId: string;
/**
* Optional. When empty, any terminal phase (running, stopped, deleted)
* fires the interest. Valid values: "running", "stopped", "deleted".
*
* @generated from field: string phase = 2;
*/
phase: string;
};
/**
* Describes the message gitpod.v1.AgentExecution.WaitingInfo.EnvironmentInterest.
* Use `create(AgentExecution_WaitingInfo_EnvironmentInterestSchema)` to create a new message.
*/
export declare const AgentExecution_WaitingInfo_EnvironmentInterestSchema: GenMessage<AgentExecution_WaitingInfo_EnvironmentInterest>;
/**
* @generated from message gitpod.v1.AgentExecution.WaitingInfo.DevcontainerRebuildInterest
*/
export type AgentExecution_WaitingInfo_DevcontainerRebuildInterest = Message<"gitpod.v1.AgentExecution.WaitingInfo.DevcontainerRebuildInterest"> & {
/**
* @generated from field: string environment_id = 1;
*/
environmentId: string;
/**
* session_id is the devcontainer session this wait is targeting.
*
* @generated from field: string session_id = 2;
*/
sessionId: string;
/**
* phases are the devcontainer phases that satisfy the wait for the
* targeted session. For a rebuild completion wait, specify "running" and
* "failed".
*
* @generated from field: repeated string phases = 3;
*/
phases: string[];
};
/**
* Describes the message gitpod.v1.AgentExecution.WaitingInfo.DevcontainerRebuildInterest.
* Use `create(AgentExecution_WaitingInfo_DevcontainerRebuildInterestSchema)` to create a new message.
*/
export declare const AgentExecution_WaitingInfo_DevcontainerRebuildInterestSchema: GenMessage<AgentExecution_WaitingInfo_DevcontainerRebuildInterest>;
/**
* @generated from message gitpod.v1.AgentExecution.WaitingInfo.Interest
*/
export type AgentExecution_WaitingInfo_Interest = Message<"gitpod.v1.AgentExecution.WaitingInfo.Interest"> & {
/**
* @generated from field: string id = 1;
*/
id: string;
/**
* @generated from oneof gitpod.v1.AgentExecution.WaitingInfo.Interest.interest
*/
interest: {
/**
* @generated from field: gitpod.v1.AgentExecution.WaitingInfo.TimerInterest timer = 2;
*/
value: AgentExecution_WaitingInfo_TimerInterest;
case: "timer";
} | {
/**
* @generated from field: gitpod.v1.AgentExecution.WaitingInfo.SubAgentInterest sub_agent = 3;
*/
value: AgentExecution_WaitingInfo_SubAgentInterest;
case: "subAgent";
} | {
/**
* @generated from field: gitpod.v1.AgentExecution.WaitingInfo.UserMessageInterest user_message = 4;
*/
value: AgentExecution_WaitingInfo_UserMessageInterest;
case: "userMessage";
} | {
/**
* @generated from field: gitpod.v1.AgentExecution.WaitingInfo.EnvironmentInterest environment = 5;
*/
value: AgentExecution_WaitingInfo_EnvironmentInterest;
case: "environment";
} | {
/**
* @generated from field: gitpod.v1.AgentExecution.WaitingInfo.DevcontainerRebuildInterest devcontainer_rebuild = 6;
*/
value: AgentExecution_WaitingInfo_DevcontainerRebuildInterest;
case: "devcontainerRebuild";
} | {
case: undefined;
value?: undefined;
};
};
/**
* Describes the message gitpod.v1.AgentExecution.WaitingInfo.Interest.
* Use `create(AgentExecution_WaitingInfo_InterestSchema)` to create a new message.
*/
export declare const AgentExecution_WaitingInfo_InterestSchema: GenMessage<AgentExecution_WaitingInfo_Interest>;
/**
* @generated from enum gitpod.v1.AgentExecution.Phase
*/
export declare enum AgentExecution_Phase {
/**
* The phase is not set.
*
* @generated from enum value: PHASE_UNSPECIFIED = 0;
*/
UNSPECIFIED = 0,
/**
* The agent run is pending.
*
* @generated from enum value: PHASE_PENDING = 10;
*/
PENDING = 10,
/**
* The agent run is active.
*
* @generated from enum value: PHASE_RUNNING = 20;
*/
RUNNING = 20,
/**
* The agent run is waiting for input.
*
* @generated from enum value: PHASE_WAITING_FOR_INPUT = 30;
*/
WAITING_FOR_INPUT = 30,
/**
* The agent run is inactive.
*
* @generated from enum value: PHASE_STOPPED = 40;
*/
STOPPED = 40
}
/**
* Describes the enum gitpod.v1.AgentExecution.Phase.
*/
export declare const AgentExecution_PhaseSchema: GenEnum<AgentExecution_Phase>;
/**
* @generated from message gitpod.v1.ClarifyingQuestions
*/
export type ClarifyingQuestions = Message<"gitpod.v1.ClarifyingQuestions"> & {
/**
* @generated from field: repeated gitpod.v1.ClarifyingQuestions.Question questions = 1;
*/
questions: ClarifyingQuestions_Question[];
};
/**
* Describes the message gitpod.v1.ClarifyingQuestions.
* Use `create(ClarifyingQuestionsSchema)` to create a new message.
*/
export declare const ClarifyingQuestionsSchema: GenMessage<ClarifyingQuestions>;
/**
* @generated from message gitpod.v1.ClarifyingQuestions.Choice
*/
export type ClarifyingQuestions_Choice = Message<"gitpod.v1.ClarifyingQuestions.Choice"> & {