UNPKG

@gitpod/sdk

Version:
1,410 lines 78.4 kB
import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2"; import type { PullRequest } from "./agent_pb"; import type { Gateway } from "./gateway_pb"; import type { Subject } from "./identity_pb"; import type { PaginationRequest, PaginationResponse } from "./pagination_pb"; import type { FieldValue, RunnerKind, RunnerProvider } from "./runner_configuration_pb"; import type { Duration, Timestamp } from "@bufbuild/protobuf/wkt"; import type { Message } from "@bufbuild/protobuf"; /** * Describes the file gitpod/v1/runner.proto. */ export declare const file_gitpod_v1_runner: GenFile; /** * @generated from message gitpod.v1.CreateRunnerRequest */ export type CreateRunnerRequest = Message<"gitpod.v1.CreateRunnerRequest"> & { /** * The runner name for humans * * @generated from field: string name = 1; */ name: string; /** * The runner's kind * This field is optional and here for backwards-compatibility. Use the provider field instead. * If provider is set, the runner's kind will be deduced from the provider. * Only one of kind and provider must be set. * * @generated from field: gitpod.v1.RunnerKind kind = 2; */ kind: RunnerKind; /** * @generated from field: gitpod.v1.RunnerSpec spec = 3; */ spec?: RunnerSpec; /** * The specific implementation type of the runner * This field is optional for backwards compatibility but will be required in the future. * When specified, kind must not be specified (will be deduced from provider) * * @generated from field: gitpod.v1.RunnerProvider provider = 4; */ provider: RunnerProvider; /** * The runner manager id specifies the runner manager for the managed runner. * This field is mandatory for managed runners, otheriwse should not be set. * * @generated from field: string runner_manager_id = 5; */ runnerManagerId: string; }; /** * Describes the message gitpod.v1.CreateRunnerRequest. * Use `create(CreateRunnerRequestSchema)` to create a new message. */ export declare const CreateRunnerRequestSchema: GenMessage<CreateRunnerRequest>; /** * @generated from message gitpod.v1.CreateRunnerResponse */ export type CreateRunnerResponse = Message<"gitpod.v1.CreateRunnerResponse"> & { /** * @generated from field: gitpod.v1.Runner runner = 1; */ runner?: Runner; /** * deprecated, will be removed. Use exchange_token instead. * * @generated from field: string access_token = 2 [deprecated = true]; * @deprecated */ accessToken: string; /** * exchange_token is a one-time use token that should be exchanged by the runner for an access token, * using the IdentityService.ExchangeToken rpc. The token expires after 24 hours. * * @generated from field: string exchange_token = 3; */ exchangeToken: string; }; /** * Describes the message gitpod.v1.CreateRunnerResponse. * Use `create(CreateRunnerResponseSchema)` to create a new message. */ export declare const CreateRunnerResponseSchema: GenMessage<CreateRunnerResponse>; /** * @generated from message gitpod.v1.GetRunnerRequest */ export type GetRunnerRequest = Message<"gitpod.v1.GetRunnerRequest"> & { /** * @generated from field: string runner_id = 1; */ runnerId: string; }; /** * Describes the message gitpod.v1.GetRunnerRequest. * Use `create(GetRunnerRequestSchema)` to create a new message. */ export declare const GetRunnerRequestSchema: GenMessage<GetRunnerRequest>; /** * @generated from message gitpod.v1.GetRunnerResponse */ export type GetRunnerResponse = Message<"gitpod.v1.GetRunnerResponse"> & { /** * @generated from field: gitpod.v1.Runner runner = 1; */ runner?: Runner; }; /** * Describes the message gitpod.v1.GetRunnerResponse. * Use `create(GetRunnerResponseSchema)` to create a new message. */ export declare const GetRunnerResponseSchema: GenMessage<GetRunnerResponse>; /** * @generated from message gitpod.v1.ListRunnersRequest */ export type ListRunnersRequest = Message<"gitpod.v1.ListRunnersRequest"> & { /** * pagination contains the pagination options for listing runners * * @generated from field: gitpod.v1.PaginationRequest pagination = 1; */ pagination?: PaginationRequest; /** * @generated from field: gitpod.v1.ListRunnersRequest.Filter filter = 2; */ filter?: ListRunnersRequest_Filter; }; /** * Describes the message gitpod.v1.ListRunnersRequest. * Use `create(ListRunnersRequestSchema)` to create a new message. */ export declare const ListRunnersRequestSchema: GenMessage<ListRunnersRequest>; /** * @generated from message gitpod.v1.ListRunnersRequest.Filter */ export type ListRunnersRequest_Filter = Message<"gitpod.v1.ListRunnersRequest.Filter"> & { /** * creator_ids filters the response to only runner created by specified users * * @generated from field: repeated string creator_ids = 1; */ creatorIds: string[]; /** * kinds filters the response to only runners of the specified kinds * * @generated from field: repeated gitpod.v1.RunnerKind kinds = 2; */ kinds: RunnerKind[]; /** * providers filters the response to only runners of the specified providers * * @generated from field: repeated gitpod.v1.RunnerProvider providers = 3; */ providers: RunnerProvider[]; }; /** * Describes the message gitpod.v1.ListRunnersRequest.Filter. * Use `create(ListRunnersRequest_FilterSchema)` to create a new message. */ export declare const ListRunnersRequest_FilterSchema: GenMessage<ListRunnersRequest_Filter>; /** * @generated from message gitpod.v1.ListRunnersResponse */ export type ListRunnersResponse = Message<"gitpod.v1.ListRunnersResponse"> & { /** * pagination contains the pagination options for listing runners * * @generated from field: gitpod.v1.PaginationResponse pagination = 1; */ pagination?: PaginationResponse; /** * The runners registered in the scope * * @generated from field: repeated gitpod.v1.Runner runners = 2; */ runners: Runner[]; }; /** * Describes the message gitpod.v1.ListRunnersResponse. * Use `create(ListRunnersResponseSchema)` to create a new message. */ export declare const ListRunnersResponseSchema: GenMessage<ListRunnersResponse>; /** * @generated from message gitpod.v1.UpdateRunnerRequest */ export type UpdateRunnerRequest = Message<"gitpod.v1.UpdateRunnerRequest"> & { /** * runner_id specifies which runner to be updated. * * +required * * @generated from field: string runner_id = 1; */ runnerId: string; /** * The runner's name which is shown to users * * @generated from field: optional string name = 2; */ name?: string; /** * @generated from field: optional gitpod.v1.UpdateRunnerRequest.Spec spec = 3; */ spec?: UpdateRunnerRequest_Spec; }; /** * Describes the message gitpod.v1.UpdateRunnerRequest. * Use `create(UpdateRunnerRequestSchema)` to create a new message. */ export declare const UpdateRunnerRequestSchema: GenMessage<UpdateRunnerRequest>; /** * @generated from message gitpod.v1.UpdateRunnerRequest.RunnerConfiguration */ export type UpdateRunnerRequest_RunnerConfiguration = Message<"gitpod.v1.UpdateRunnerRequest.RunnerConfiguration"> & { /** * The release channel the runner is on * * @generated from field: optional gitpod.v1.RunnerReleaseChannel release_channel = 1; */ releaseChannel?: RunnerReleaseChannel; /** * auto_update indicates whether the runner should automatically update itself. * * @generated from field: optional bool auto_update = 2; */ autoUpdate?: boolean; /** * metrics contains configuration for the runner's metrics collection * * @generated from field: optional gitpod.v1.UpdateRunnerRequest.MetricsConfiguration metrics = 3; */ metrics?: UpdateRunnerRequest_MetricsConfiguration; /** * log_level is the log level for the runner * * @generated from field: optional gitpod.v1.LogLevel log_level = 4; */ logLevel?: LogLevel; /** * devcontainer_image_cache_enabled controls whether the shared devcontainer build cache is enabled for this runner. * * @generated from field: optional bool devcontainer_image_cache_enabled = 5; */ devcontainerImageCacheEnabled?: boolean; /** * update_window defines the daily time window (UTC) during which auto-updates are allowed. * start_hour is required. If end_hour is omitted, it defaults to start_hour + 2. * Send an empty UpdateWindow (no start_hour or end_hour) to clear a custom window * and allow updates at any time. * * @generated from field: optional gitpod.v1.UpdateWindow update_window = 6; */ updateWindow?: UpdateWindow; /** * honeycomb_api_key is the plaintext API key for Honeycomb tracing. * The backend encrypts it with the runner's public key before storing. * This is an internal-only field used for debugging. * * @generated from field: optional string honeycomb_api_key = 7; */ honeycombApiKey?: string; /** * continuous_profiling enables continuous profiling on the runner. * This is an internal-only field used for debugging. * * @generated from field: optional bool continuous_profiling = 8; */ continuousProfiling?: boolean; }; /** * Describes the message gitpod.v1.UpdateRunnerRequest.RunnerConfiguration. * Use `create(UpdateRunnerRequest_RunnerConfigurationSchema)` to create a new message. */ export declare const UpdateRunnerRequest_RunnerConfigurationSchema: GenMessage<UpdateRunnerRequest_RunnerConfiguration>; /** * @generated from message gitpod.v1.UpdateRunnerRequest.MetricsConfiguration */ export type UpdateRunnerRequest_MetricsConfiguration = Message<"gitpod.v1.UpdateRunnerRequest.MetricsConfiguration"> & { /** * enabled indicates whether the runner should collect metrics * * @generated from field: optional bool enabled = 1; */ enabled?: boolean; /** * url is the URL of the metrics collector * * @generated from field: optional string url = 2; */ url?: string; /** * username is the username to use for the metrics collector * * @generated from field: optional string username = 3; */ username?: string; /** * password is the password to use for the metrics collector * * @generated from field: optional string password = 4; */ password?: string; /** * When true, the runner pushes metrics to the management plane via * ReportRunnerMetrics instead of directly to the remote_write endpoint. * * @generated from field: optional bool managed_metrics_enabled = 5; */ managedMetricsEnabled?: boolean; /** * When true, the runner also forwards verbose * metrics (e.g. aws_sdk_go_*) via the managed metrics pipeline. * Disabled by default to control metrics volume. Internal-only, set via CLI. * * @generated from field: optional bool include_verbose_metrics = 6; */ includeVerboseMetrics?: boolean; }; /** * Describes the message gitpod.v1.UpdateRunnerRequest.MetricsConfiguration. * Use `create(UpdateRunnerRequest_MetricsConfigurationSchema)` to create a new message. */ export declare const UpdateRunnerRequest_MetricsConfigurationSchema: GenMessage<UpdateRunnerRequest_MetricsConfiguration>; /** * @generated from message gitpod.v1.UpdateRunnerRequest.Spec */ export type UpdateRunnerRequest_Spec = Message<"gitpod.v1.UpdateRunnerRequest.Spec"> & { /** * @generated from field: optional gitpod.v1.UpdateRunnerRequest.RunnerConfiguration configuration = 1; */ configuration?: UpdateRunnerRequest_RunnerConfiguration; /** * desired_phase can currently only be updated on local-configuration runners, * to toggle whether local runners are allowed for running environments in the * organization. * Set to: * - ACTIVE to enable local runners. * - INACTIVE to disable all local runners. Existing local runners and their * environments will stop, and cannot be started again until the desired_phase * is set to ACTIVE. Use this carefully, as it will affect all users in the * organization who use local runners. * * @generated from field: optional gitpod.v1.RunnerPhase desired_phase = 2; */ desiredPhase?: RunnerPhase; }; /** * Describes the message gitpod.v1.UpdateRunnerRequest.Spec. * Use `create(UpdateRunnerRequest_SpecSchema)` to create a new message. */ export declare const UpdateRunnerRequest_SpecSchema: GenMessage<UpdateRunnerRequest_Spec>; /** * @generated from message gitpod.v1.UpdateRunnerResponse */ export type UpdateRunnerResponse = Message<"gitpod.v1.UpdateRunnerResponse"> & {}; /** * Describes the message gitpod.v1.UpdateRunnerResponse. * Use `create(UpdateRunnerResponseSchema)` to create a new message. */ export declare const UpdateRunnerResponseSchema: GenMessage<UpdateRunnerResponse>; /** * @generated from message gitpod.v1.DeleteRunnerRequest */ export type DeleteRunnerRequest = Message<"gitpod.v1.DeleteRunnerRequest"> & { /** * @generated from field: string runner_id = 1; */ runnerId: string; /** * force indicates whether the runner should be deleted forcefully. * When force deleting a Runner, all Environments on the runner are also force deleted and * regular Runner lifecycle is not respected. * Force deleting can result in data loss. * * @generated from field: bool force = 2; */ force: boolean; }; /** * Describes the message gitpod.v1.DeleteRunnerRequest. * Use `create(DeleteRunnerRequestSchema)` to create a new message. */ export declare const DeleteRunnerRequestSchema: GenMessage<DeleteRunnerRequest>; /** * @generated from message gitpod.v1.DeleteRunnerResponse */ export type DeleteRunnerResponse = Message<"gitpod.v1.DeleteRunnerResponse"> & {}; /** * Describes the message gitpod.v1.DeleteRunnerResponse. * Use `create(DeleteRunnerResponseSchema)` to create a new message. */ export declare const DeleteRunnerResponseSchema: GenMessage<DeleteRunnerResponse>; /** * @generated from message gitpod.v1.CreateRunnerTokenRequest */ export type CreateRunnerTokenRequest = Message<"gitpod.v1.CreateRunnerTokenRequest"> & { /** * @generated from field: string runner_id = 1; */ runnerId: string; }; /** * Describes the message gitpod.v1.CreateRunnerTokenRequest. * Use `create(CreateRunnerTokenRequestSchema)` to create a new message. */ export declare const CreateRunnerTokenRequestSchema: GenMessage<CreateRunnerTokenRequest>; /** * @generated from message gitpod.v1.CreateRunnerTokenResponse */ export type CreateRunnerTokenResponse = Message<"gitpod.v1.CreateRunnerTokenResponse"> & { /** * deprecated, will be removed. Use exchange_token instead. * * @generated from field: string access_token = 1 [deprecated = true]; * @deprecated */ accessToken: string; /** * exchange_token is a one-time use token that should be exchanged by the runner for an access token, * using the IdentityService.ExchangeToken rpc. The token expires after 24 hours. * * @generated from field: string exchange_token = 2; */ exchangeToken: string; }; /** * Describes the message gitpod.v1.CreateRunnerTokenResponse. * Use `create(CreateRunnerTokenResponseSchema)` to create a new message. */ export declare const CreateRunnerTokenResponseSchema: GenMessage<CreateRunnerTokenResponse>; /** * @generated from message gitpod.v1.CreateRunnerLogsTokenRequest */ export type CreateRunnerLogsTokenRequest = Message<"gitpod.v1.CreateRunnerLogsTokenRequest"> & { /** * runner_id specifies the runner for which the logs token should be created. * * +required * * @generated from field: string runner_id = 1; */ runnerId: string; }; /** * Describes the message gitpod.v1.CreateRunnerLogsTokenRequest. * Use `create(CreateRunnerLogsTokenRequestSchema)` to create a new message. */ export declare const CreateRunnerLogsTokenRequestSchema: GenMessage<CreateRunnerLogsTokenRequest>; /** * @generated from message gitpod.v1.CreateRunnerLogsTokenResponse */ export type CreateRunnerLogsTokenResponse = Message<"gitpod.v1.CreateRunnerLogsTokenResponse"> & { /** * access_token is the token that can be used to access the logs and support bundle of the runner * * @generated from field: string access_token = 1; */ accessToken: string; }; /** * Describes the message gitpod.v1.CreateRunnerLogsTokenResponse. * Use `create(CreateRunnerLogsTokenResponseSchema)` to create a new message. */ export declare const CreateRunnerLogsTokenResponseSchema: GenMessage<CreateRunnerLogsTokenResponse>; /** * @generated from message gitpod.v1.ParseContextURLRequest */ export type ParseContextURLRequest = Message<"gitpod.v1.ParseContextURLRequest"> & { /** * @generated from field: string runner_id = 1; */ runnerId: string; /** * @generated from field: string context_url = 2; */ contextUrl: string; }; /** * Describes the message gitpod.v1.ParseContextURLRequest. * Use `create(ParseContextURLRequestSchema)` to create a new message. */ export declare const ParseContextURLRequestSchema: GenMessage<ParseContextURLRequest>; /** * @generated from message gitpod.v1.ParseContextURLResponse */ export type ParseContextURLResponse = Message<"gitpod.v1.ParseContextURLResponse"> & { /** * @generated from field: string original_context_url = 1; */ originalContextUrl: string; /** * @generated from field: gitpod.v1.ParseContextURLResponse.GitContext git = 2; */ git?: ParseContextURLResponse_GitContext; /** * @generated from field: gitpod.v1.ParseContextURLResponse.PullRequest pr = 4 [deprecated = true]; * @deprecated */ pr?: ParseContextURLResponse_PullRequest; /** * @generated from field: gitpod.v1.ParseContextURLResponse.Issue issue = 5; */ issue?: ParseContextURLResponse_Issue; /** * @generated from field: gitpod.v1.PullRequest pull_request = 6; */ pullRequest?: PullRequest; /** * project_ids is a list of projects to which the context URL belongs to. * * @generated from field: repeated string project_ids = 3; */ projectIds: string[]; /** * scm_id is the unique identifier of the SCM provider (e.g., "github", "gitlab", "bitbucket") * * @generated from field: string scm_id = 7; */ scmId: string; /** * recommended_environment_classes is an ordered list of environment class IDs * that are suitable for creating an environment for this context URL. * * @generated from field: repeated string recommended_environment_classes = 8; */ recommendedEnvironmentClasses: string[]; }; /** * Describes the message gitpod.v1.ParseContextURLResponse. * Use `create(ParseContextURLResponseSchema)` to create a new message. */ export declare const ParseContextURLResponseSchema: GenMessage<ParseContextURLResponse>; /** * @generated from message gitpod.v1.ParseContextURLResponse.GitContext */ export type ParseContextURLResponse_GitContext = Message<"gitpod.v1.ParseContextURLResponse.GitContext"> & { /** * @generated from field: string clone_url = 1; */ cloneUrl: string; /** * @generated from field: string branch = 2; */ branch: string; /** * @generated from field: string commit = 3; */ commit: string; /** * @generated from field: string host = 4; */ host: string; /** * @generated from field: string owner = 5; */ owner: string; /** * @generated from field: string repo = 6; */ repo: string; /** * @generated from field: string upstream_remote_url = 7; */ upstreamRemoteUrl: string; /** * @generated from field: string tag = 8; */ tag: string; }; /** * Describes the message gitpod.v1.ParseContextURLResponse.GitContext. * Use `create(ParseContextURLResponse_GitContextSchema)` to create a new message. */ export declare const ParseContextURLResponse_GitContextSchema: GenMessage<ParseContextURLResponse_GitContext>; /** * Deprecated: Use top-level PullRequest message instead * * @generated from message gitpod.v1.ParseContextURLResponse.PullRequest */ export type ParseContextURLResponse_PullRequest = Message<"gitpod.v1.ParseContextURLResponse.PullRequest"> & { /** * @generated from field: string id = 1; */ id: string; /** * @generated from field: string title = 2; */ title: string; /** * @generated from field: string from_branch = 3; */ fromBranch: string; /** * @generated from field: string to_branch = 4; */ toBranch: string; }; /** * Describes the message gitpod.v1.ParseContextURLResponse.PullRequest. * Use `create(ParseContextURLResponse_PullRequestSchema)` to create a new message. */ export declare const ParseContextURLResponse_PullRequestSchema: GenMessage<ParseContextURLResponse_PullRequest>; /** * @generated from message gitpod.v1.ParseContextURLResponse.Issue */ export type ParseContextURLResponse_Issue = Message<"gitpod.v1.ParseContextURLResponse.Issue"> & { /** * id is the source system's ID of this issue, e.g. BNFRD-6100 * * @generated from field: string id = 1; */ id: string; /** * @generated from field: string title = 2; */ title: string; }; /** * Describes the message gitpod.v1.ParseContextURLResponse.Issue. * Use `create(ParseContextURLResponse_IssueSchema)` to create a new message. */ export declare const ParseContextURLResponse_IssueSchema: GenMessage<ParseContextURLResponse_Issue>; /** * @generated from message gitpod.v1.ParseContextURLPreconditionFailureDetails */ export type ParseContextURLPreconditionFailureDetails = Message<"gitpod.v1.ParseContextURLPreconditionFailureDetails"> & { /** * @generated from field: string authentication_required_url = 1; */ authenticationRequiredUrl: string; /** * @generated from field: string scm_id = 2; */ scmId: string; /** * if trying to parse a context URL without specifying a runner, runner_ids will be populated * with possible runners that can be authenticated against to access the context URL. * This is only populated if no authenticated runner against the context URL is found for the user. * * @generated from field: repeated string runner_ids = 3; */ runnerIds: string[]; }; /** * Describes the message gitpod.v1.ParseContextURLPreconditionFailureDetails. * Use `create(ParseContextURLPreconditionFailureDetailsSchema)` to create a new message. */ export declare const ParseContextURLPreconditionFailureDetailsSchema: GenMessage<ParseContextURLPreconditionFailureDetails>; /** * @generated from message gitpod.v1.SearchRepositoriesRequest */ export type SearchRepositoriesRequest = Message<"gitpod.v1.SearchRepositoriesRequest"> & { /** * @generated from field: string runner_id = 1; */ runnerId: string; /** * Search query - interpretation depends on search_mode * * @generated from field: string search_string = 2; */ searchString: string; /** * Maximum number of repositories to return. * Default: 25, Maximum: 100 * Deprecated: Use pagination.page_size instead * * @generated from field: int32 limit = 3 [deprecated = true]; * @deprecated */ limit: number; /** * Pagination parameters for repository search * * @generated from field: gitpod.v1.PaginationRequest pagination = 4; */ pagination?: PaginationRequest; /** * The SCM's host to retrieve repositories from * * @generated from field: string scm_host = 5; */ scmHost: string; /** * Search mode determines how search_string is interpreted * * @generated from field: gitpod.v1.SearchMode search_mode = 6; */ searchMode: SearchMode; }; /** * Describes the message gitpod.v1.SearchRepositoriesRequest. * Use `create(SearchRepositoriesRequestSchema)` to create a new message. */ export declare const SearchRepositoriesRequestSchema: GenMessage<SearchRepositoriesRequest>; /** * @generated from message gitpod.v1.SearchRepositoriesResponse */ export type SearchRepositoriesResponse = Message<"gitpod.v1.SearchRepositoriesResponse"> & { /** * List of repositories matching the search criteria * * @generated from field: repeated gitpod.v1.SearchRepositoriesResponse.Repository repositories = 1; */ repositories: SearchRepositoriesResponse_Repository[]; /** * Pagination information for the response. * Token format: "NEXT_PAGE/TOTAL_PAGES/TOTAL_COUNT" (e.g., "2/40/1000"). * Use -1 for unknown values (e.g., "2/-1/-1" when totals unavailable). * Empty token means no more pages. * * @generated from field: gitpod.v1.PaginationResponse pagination = 2; */ pagination?: PaginationResponse; /** * Deprecated: Use pagination token instead. Total pages can be extracted from token. * * @generated from field: int32 last_page = 3 [deprecated = true]; * @deprecated */ lastPage: number; }; /** * Describes the message gitpod.v1.SearchRepositoriesResponse. * Use `create(SearchRepositoriesResponseSchema)` to create a new message. */ export declare const SearchRepositoriesResponseSchema: GenMessage<SearchRepositoriesResponse>; /** * @generated from message gitpod.v1.SearchRepositoriesResponse.Repository */ export type SearchRepositoriesResponse_Repository = Message<"gitpod.v1.SearchRepositoriesResponse.Repository"> & { /** * Repository name (e.g., "my-project") * * @generated from field: string name = 1; */ name: string; /** * Repository URL (e.g., "https://github.com/owner/my-project") * * @generated from field: string url = 2; */ url: string; }; /** * Describes the message gitpod.v1.SearchRepositoriesResponse.Repository. * Use `create(SearchRepositoriesResponse_RepositorySchema)` to create a new message. */ export declare const SearchRepositoriesResponse_RepositorySchema: GenMessage<SearchRepositoriesResponse_Repository>; /** * @generated from message gitpod.v1.ListSCMOrganizationsRequest */ export type ListSCMOrganizationsRequest = Message<"gitpod.v1.ListSCMOrganizationsRequest"> & { /** * @generated from field: string runner_id = 1; */ runnerId: string; /** * The SCM host to list organizations from (e.g., "github.com", "gitlab.com") * * @generated from field: string scm_host = 2; */ scmHost: string; /** * Optional substring filter applied to the organization name. * - GitLab: forwarded to the upstream `search` parameter (server-side, case-insensitive substring on name/path). * - GitHub and Bitbucket: not implemented as they don't support searching * Empty value means no filter. * * @generated from field: string query = 3; */ query: string; /** * Pagination parameters. When unset, defaults to the standard PaginationRequest defaults * (page_size 25, max 100). Tokens are opaque and provider-specific. * * @generated from field: gitpod.v1.PaginationRequest pagination = 4; */ pagination?: PaginationRequest; }; /** * Describes the message gitpod.v1.ListSCMOrganizationsRequest. * Use `create(ListSCMOrganizationsRequestSchema)` to create a new message. */ export declare const ListSCMOrganizationsRequestSchema: GenMessage<ListSCMOrganizationsRequest>; /** * @generated from message gitpod.v1.ListSCMOrganizationsResponse */ export type ListSCMOrganizationsResponse = Message<"gitpod.v1.ListSCMOrganizationsResponse"> & { /** * List of organizations the user belongs to * * @generated from field: repeated gitpod.v1.ListSCMOrganizationsResponse.SCMOrganization organizations = 1; */ organizations: ListSCMOrganizationsResponse_SCMOrganization[]; /** * Pagination cursor for fetching the next page. Empty `next_token` means no more results. * * @generated from field: gitpod.v1.PaginationResponse pagination = 2; */ pagination?: PaginationResponse; }; /** * Describes the message gitpod.v1.ListSCMOrganizationsResponse. * Use `create(ListSCMOrganizationsResponseSchema)` to create a new message. */ export declare const ListSCMOrganizationsResponseSchema: GenMessage<ListSCMOrganizationsResponse>; /** * @generated from message gitpod.v1.ListSCMOrganizationsResponse.SCMOrganization */ export type ListSCMOrganizationsResponse_SCMOrganization = Message<"gitpod.v1.ListSCMOrganizationsResponse.SCMOrganization"> & { /** * Organization name/slug (e.g., "gitpod-io") * * @generated from field: string name = 1; */ name: string; /** * Organization URL (e.g., "https://github.com/gitpod-io") * * @generated from field: string url = 2; */ url: string; /** * Deprecated: this field is unused by all known consumers and is * scheduled for removal in a future release. Do not read it. * * Originally intended to gate organization-level webhook creation in the * dashboard, but that gating was never implemented. Populating this field * on the GitLab path requires a second fully-paginated ListGroups call, * which is the main reason we are deprecating it. * * @generated from field: bool is_admin = 3 [deprecated = true]; * @deprecated */ isAdmin: boolean; }; /** * Describes the message gitpod.v1.ListSCMOrganizationsResponse.SCMOrganization. * Use `create(ListSCMOrganizationsResponse_SCMOrganizationSchema)` to create a new message. */ export declare const ListSCMOrganizationsResponse_SCMOrganizationSchema: GenMessage<ListSCMOrganizationsResponse_SCMOrganization>; /** * @generated from message gitpod.v1.CheckAuthenticationForHostRequest */ export type CheckAuthenticationForHostRequest = Message<"gitpod.v1.CheckAuthenticationForHostRequest"> & { /** * @generated from field: string runner_id = 1; */ runnerId: string; /** * @generated from field: string host = 2; */ host: string; }; /** * Describes the message gitpod.v1.CheckAuthenticationForHostRequest. * Use `create(CheckAuthenticationForHostRequestSchema)` to create a new message. */ export declare const CheckAuthenticationForHostRequestSchema: GenMessage<CheckAuthenticationForHostRequest>; /** * @generated from message gitpod.v1.CheckAuthenticationForHostResponse */ export type CheckAuthenticationForHostResponse = Message<"gitpod.v1.CheckAuthenticationForHostResponse"> & { /** * @generated from field: bool authenticated = 1; */ authenticated: boolean; /** * @generated from field: string authentication_url = 2 [deprecated = true]; * @deprecated */ authenticationUrl: string; /** * @generated from field: bool pat_supported = 3 [deprecated = true]; * @deprecated */ patSupported: boolean; /** * scm_id is the unique identifier of the SCM provider * * @generated from field: string scm_id = 4; */ scmId: string; /** * scm_name is the human-readable name of the SCM provider (e.g., "GitHub", "GitLab") * * @generated from field: string scm_name = 5; */ scmName: string; /** * supports_oauth2 indicates that the host supports OAuth2 authentication * * @generated from field: gitpod.v1.CheckAuthenticationForHostResponse.AuthenticationMethodOAuth2 supports_oauth2 = 6; */ supportsOauth2?: CheckAuthenticationForHostResponse_AuthenticationMethodOAuth2; /** * supports_pat indicates that the host supports Personal Access Token authentication * * @generated from field: gitpod.v1.CheckAuthenticationForHostResponse.AuthenticationMethodPersonalAccessToken supports_pat = 7; */ supportsPat?: CheckAuthenticationForHostResponse_AuthenticationMethodPersonalAccessToken; }; /** * Describes the message gitpod.v1.CheckAuthenticationForHostResponse. * Use `create(CheckAuthenticationForHostResponseSchema)` to create a new message. */ export declare const CheckAuthenticationForHostResponseSchema: GenMessage<CheckAuthenticationForHostResponse>; /** * @generated from message gitpod.v1.CheckAuthenticationForHostResponse.AuthenticationMethodOAuth2 */ export type CheckAuthenticationForHostResponse_AuthenticationMethodOAuth2 = Message<"gitpod.v1.CheckAuthenticationForHostResponse.AuthenticationMethodOAuth2"> & { /** * auth_url is the URL where users can authenticate * * @generated from field: string auth_url = 1; */ authUrl: string; /** * docs_url is the URL to the documentation explaining this authentication method * * @generated from field: string docs_url = 2; */ docsUrl: string; }; /** * Describes the message gitpod.v1.CheckAuthenticationForHostResponse.AuthenticationMethodOAuth2. * Use `create(CheckAuthenticationForHostResponse_AuthenticationMethodOAuth2Schema)` to create a new message. */ export declare const CheckAuthenticationForHostResponse_AuthenticationMethodOAuth2Schema: GenMessage<CheckAuthenticationForHostResponse_AuthenticationMethodOAuth2>; /** * @generated from message gitpod.v1.CheckAuthenticationForHostResponse.AuthenticationMethodPersonalAccessToken */ export type CheckAuthenticationForHostResponse_AuthenticationMethodPersonalAccessToken = Message<"gitpod.v1.CheckAuthenticationForHostResponse.AuthenticationMethodPersonalAccessToken"> & { /** * create_url is the URL where users can create a new Personal Access Token * * @generated from field: string create_url = 1; */ createUrl: string; /** * docs_url is the URL to the documentation explaining PAT usage for this host * * @generated from field: string docs_url = 2; */ docsUrl: string; /** * example is an example of a Personal Access Token * * @generated from field: string example = 3; */ example: string; /** * required_scopes is the list of permissions required for the Personal Access Token * * @generated from field: repeated string required_scopes = 4; */ requiredScopes: string[]; }; /** * Describes the message gitpod.v1.CheckAuthenticationForHostResponse.AuthenticationMethodPersonalAccessToken. * Use `create(CheckAuthenticationForHostResponse_AuthenticationMethodPersonalAccessTokenSchema)` to create a new message. */ export declare const CheckAuthenticationForHostResponse_AuthenticationMethodPersonalAccessTokenSchema: GenMessage<CheckAuthenticationForHostResponse_AuthenticationMethodPersonalAccessToken>; /** * @generated from message gitpod.v1.CheckRepositoryAccessRequest */ export type CheckRepositoryAccessRequest = Message<"gitpod.v1.CheckRepositoryAccessRequest"> & { /** * @generated from field: string runner_id = 1; */ runnerId: string; /** * repository_url is the URL of the repository to check access for. * Can be a clone URL (https://github.com/org/repo.git) or web URL (https://github.com/org/repo). * * @generated from field: string repository_url = 2; */ repositoryUrl: string; }; /** * Describes the message gitpod.v1.CheckRepositoryAccessRequest. * Use `create(CheckRepositoryAccessRequestSchema)` to create a new message. */ export declare const CheckRepositoryAccessRequestSchema: GenMessage<CheckRepositoryAccessRequest>; /** * @generated from message gitpod.v1.CheckRepositoryAccessResponse */ export type CheckRepositoryAccessResponse = Message<"gitpod.v1.CheckRepositoryAccessResponse"> & { /** * has_access indicates whether the principal has read access to the repository. * * @generated from field: bool has_access = 1; */ hasAccess: boolean; /** * error_message provides details when access check fails. * Empty when has_access is true. * * @generated from field: string error_message = 2; */ errorMessage: string; }; /** * Describes the message gitpod.v1.CheckRepositoryAccessResponse. * Use `create(CheckRepositoryAccessResponseSchema)` to create a new message. */ export declare const CheckRepositoryAccessResponseSchema: GenMessage<CheckRepositoryAccessResponse>; /** * ListRunnerPoliciesRequest lists policies for a project. * * @generated from message gitpod.v1.ListRunnerPoliciesRequest */ export type ListRunnerPoliciesRequest = Message<"gitpod.v1.ListRunnerPoliciesRequest"> & { /** * pagination contains the pagination options for listing project policies * * @generated from field: gitpod.v1.PaginationRequest pagination = 1; */ pagination?: PaginationRequest; /** * runner_id specifies the project identifier * * @generated from field: string runner_id = 2; */ runnerId: string; }; /** * Describes the message gitpod.v1.ListRunnerPoliciesRequest. * Use `create(ListRunnerPoliciesRequestSchema)` to create a new message. */ export declare const ListRunnerPoliciesRequestSchema: GenMessage<ListRunnerPoliciesRequest>; /** * @generated from message gitpod.v1.ListRunnerPoliciesResponse */ export type ListRunnerPoliciesResponse = Message<"gitpod.v1.ListRunnerPoliciesResponse"> & { /** * @generated from field: gitpod.v1.PaginationResponse pagination = 1; */ pagination?: PaginationResponse; /** * @generated from field: repeated gitpod.v1.RunnerPolicy policies = 2; */ policies: RunnerPolicy[]; }; /** * Describes the message gitpod.v1.ListRunnerPoliciesResponse. * Use `create(ListRunnerPoliciesResponseSchema)` to create a new message. */ export declare const ListRunnerPoliciesResponseSchema: GenMessage<ListRunnerPoliciesResponse>; /** * CreateRunnerPolicyRequest creates a Runner Policy. * * @generated from message gitpod.v1.CreateRunnerPolicyRequest */ export type CreateRunnerPolicyRequest = Message<"gitpod.v1.CreateRunnerPolicyRequest"> & { /** * runner_id specifies the project identifier * * @generated from field: string runner_id = 1; */ runnerId: string; /** * group_id specifies the group_id identifier * * @generated from field: string group_id = 2; */ groupId: string; /** * @generated from field: gitpod.v1.RunnerRole role = 3; */ role: RunnerRole; }; /** * Describes the message gitpod.v1.CreateRunnerPolicyRequest. * Use `create(CreateRunnerPolicyRequestSchema)` to create a new message. */ export declare const CreateRunnerPolicyRequestSchema: GenMessage<CreateRunnerPolicyRequest>; /** * @generated from message gitpod.v1.CreateRunnerPolicyResponse */ export type CreateRunnerPolicyResponse = Message<"gitpod.v1.CreateRunnerPolicyResponse"> & { /** * @generated from field: gitpod.v1.RunnerPolicy policy = 1; */ policy?: RunnerPolicy; }; /** * Describes the message gitpod.v1.CreateRunnerPolicyResponse. * Use `create(CreateRunnerPolicyResponseSchema)` to create a new message. */ export declare const CreateRunnerPolicyResponseSchema: GenMessage<CreateRunnerPolicyResponse>; /** * UpdateRunnerPolicyRequest updates a Project Policy. * * @generated from message gitpod.v1.UpdateRunnerPolicyRequest */ export type UpdateRunnerPolicyRequest = Message<"gitpod.v1.UpdateRunnerPolicyRequest"> & { /** * runner_id specifies the project identifier * * @generated from field: string runner_id = 1; */ runnerId: string; /** * group_id specifies the group_id identifier * * @generated from field: string group_id = 2; */ groupId: string; /** * @generated from field: gitpod.v1.RunnerRole role = 3; */ role: RunnerRole; }; /** * Describes the message gitpod.v1.UpdateRunnerPolicyRequest. * Use `create(UpdateRunnerPolicyRequestSchema)` to create a new message. */ export declare const UpdateRunnerPolicyRequestSchema: GenMessage<UpdateRunnerPolicyRequest>; /** * @generated from message gitpod.v1.UpdateRunnerPolicyResponse */ export type UpdateRunnerPolicyResponse = Message<"gitpod.v1.UpdateRunnerPolicyResponse"> & { /** * @generated from field: gitpod.v1.RunnerPolicy policy = 1; */ policy?: RunnerPolicy; }; /** * Describes the message gitpod.v1.UpdateRunnerPolicyResponse. * Use `create(UpdateRunnerPolicyResponseSchema)` to create a new message. */ export declare const UpdateRunnerPolicyResponseSchema: GenMessage<UpdateRunnerPolicyResponse>; /** * DeleteRunnerPolicyRequest deletes a Project Policy. * * @generated from message gitpod.v1.DeleteRunnerPolicyRequest */ export type DeleteRunnerPolicyRequest = Message<"gitpod.v1.DeleteRunnerPolicyRequest"> & { /** * runner_id specifies the project identifier * * @generated from field: string runner_id = 1; */ runnerId: string; /** * group_id specifies the group_id identifier * * @generated from field: string group_id = 2; */ groupId: string; }; /** * Describes the message gitpod.v1.DeleteRunnerPolicyRequest. * Use `create(DeleteRunnerPolicyRequestSchema)` to create a new message. */ export declare const DeleteRunnerPolicyRequestSchema: GenMessage<DeleteRunnerPolicyRequest>; /** * @generated from message gitpod.v1.DeleteRunnerPolicyResponse */ export type DeleteRunnerPolicyResponse = Message<"gitpod.v1.DeleteRunnerPolicyResponse"> & {}; /** * Describes the message gitpod.v1.DeleteRunnerPolicyResponse. * Use `create(DeleteRunnerPolicyResponseSchema)` to create a new message. */ export declare const DeleteRunnerPolicyResponseSchema: GenMessage<DeleteRunnerPolicyResponse>; /** * @generated from message gitpod.v1.Runner */ export type Runner = Message<"gitpod.v1.Runner"> & { /** * @generated from field: string runner_id = 1; */ runnerId: string; /** * Time when the Runner was created. * * @generated from field: google.protobuf.Timestamp created_at = 2; */ createdAt?: Timestamp; /** * Time when the Runner was last udpated. * * @generated from field: google.protobuf.Timestamp updated_at = 3; */ updatedAt?: Timestamp; /** * The runner's name which is shown to users * * @generated from field: string name = 4; */ name: string; /** * The runner's specification * * @generated from field: gitpod.v1.RunnerSpec spec = 5; */ spec?: RunnerSpec; /** * The runner's status * * @generated from field: gitpod.v1.RunnerStatus status = 6; */ status?: RunnerStatus; /** * creator is the identity of the creator of the environment * * @generated from field: gitpod.v1.Subject creator = 7; */ creator?: Subject; /** * The runner's kind * * @generated from field: gitpod.v1.RunnerKind kind = 8; */ kind: RunnerKind; /** * The runner's provider * * @generated from field: gitpod.v1.RunnerProvider provider = 9; */ provider: RunnerProvider; /** * The runner manager id specifies the runner manager for the managed runner. * This field is only set for managed runners. * * @generated from field: string runner_manager_id = 10; */ runnerManagerId: string; }; /** * Describes the message gitpod.v1.Runner. * Use `create(RunnerSchema)` to create a new message. */ export declare const RunnerSchema: GenMessage<Runner>; /** * @generated from message gitpod.v1.RunnerSpec */ export type RunnerSpec = Message<"gitpod.v1.RunnerSpec"> & { /** * @generated from field: gitpod.v1.RunnerPhase desired_phase = 1; */ desiredPhase: RunnerPhase; /** * The runner's configuration * * @generated from field: gitpod.v1.RunnerConfiguration configuration = 2; */ configuration?: RunnerConfiguration; /** * The runner's variant * * @generated from field: gitpod.v1.RunnerVariant variant = 3; */ variant: RunnerVariant; }; /** * Describes the message gitpod.v1.RunnerSpec. * Use `create(RunnerSpecSchema)` to create a new message. */ export declare const RunnerSpecSchema: GenMessage<RunnerSpec>; /** * @generated from message gitpod.v1.RunnerConfiguration */ export type RunnerConfiguration = Message<"gitpod.v1.RunnerConfiguration"> & { /** * Region to deploy the runner in, if applicable. * This is mainly used for remote runners, and is only a hint. The runner may be * deployed in a different region. See the runner's status for the actual region. * * @generated from field: string region = 1; */ region: string; /** * The release channel the runner is on * * @generated from field: gitpod.v1.RunnerReleaseChannel release_channel = 2; */ releaseChannel: RunnerReleaseChannel; /** * auto_update indicates whether the runner should automatically update itself. * * @generated from field: bool auto_update = 3; */ autoUpdate: boolean; /** * metrics contains configuration for the runner's metrics collection * * @generated from field: gitpod.v1.MetricsConfiguration metrics = 4; */ metrics?: MetricsConfiguration; /** * log_level is the log level for the runner * * @generated from field: gitpod.v1.LogLevel log_level = 5; */ logLevel: LogLevel; /** * devcontainer_image_cache_enabled controls whether the devcontainer build cache is * enabled for this runner. * Only takes effect on supported runners, currently only AWS EC2 and Gitpod-managed runners. * * @generated from field: bool devcontainer_image_cache_enabled = 6; */ devcontainerImageCacheEnabled: boolean; /** * update_window defines the daily time window (UTC) during which auto-updates are allowed. * If not set, updates are allowed at any time. * * @generated from field: gitpod.v1.UpdateWindow update_window = 7; */ updateWindow?: UpdateWindow; /** * encrypted_honeycomb_api_key is the Honeycomb API key encrypted with the runner's public key. * This is an internal-only field used for debugging and is not exposed in the dashboard UI. * * @generated from field: bytes encrypted_honeycomb_api_key = 8; */ encryptedHoneycombApiKey: Uint8Array; /** * continuous_profiling indicates whether continuous profiling is enabled. * This is an internal-only field used for debugging and is not exposed in the dashboard UI. * * @generated from field: bool continuous_profiling = 9; */ continuousProfiling: boolean; }; /** * Describes the message gitpod.v1.RunnerConfiguration. * Use `create(RunnerConfigurationSchema)` to create a new message. */ export declare const RunnerConfigurationSchema: GenMessage<RunnerConfiguration>; /** * UpdateWindow defines a daily time window (UTC) during which auto-updates are allowed. * The window must be at least 2 hours long. * Overnight windows are supported (e.g., start_hour=22, end_hour=4). * * @generated from message gitpod.v1.UpdateWindow */ export type UpdateWindow = Message<"gitpod.v1.UpdateWindow"> & { /** * start_hour is the beginning of the update window as a UTC hour (0-23). * +required * * @generated from field: optional uint32 start_hour = 1; */ startHour?: number; /** * end_hour is the end of the update window as a UTC hour (0-23). * If not set, defaults to start_hour + 2. * * @generated from field: optional uint32 end_hour = 2; */ endHour?: number; }; /** * Describes the message gitpod.v1.UpdateWindow. * Use `create(UpdateWindowSchema)` to create a new message. */ export declare const UpdateWindowSchema: GenMessage<UpdateWindow>; /** * @generated from message gitpod.v1.MetricsConfiguration */ export type MetricsConfiguration = Message<"gitpod.v1.MetricsConfiguration"> & { /** * enabled indicates whether the runner should collect metrics * * @generated from field: bool enabled = 1; */ enabled: boolean; /** * url is the URL of the metrics collector * * @generated from field: string url = 2; */ url: string; /** * username is the username to use for the metrics collector * * @generated from field: string username = 3; */ username: string; /** * password is the password to use for the metrics collector * * @generated from field: string password = 4; */ password: string; /** * When true, the runner pushes metrics to the management plane via * ReportRunnerMetrics instead of directly to the remote_write endpoint. * * @generated from field: bool managed_metrics_enabled = 5; */ managedMetricsEnabled: boolean; /** * When true, the runner also forwards verbose * metrics (e.g. aws_sdk_go_*) via the managed metrics pipeline. * Disabled by default to control metrics volume. Internal-only, set via CLI. * * @generated from field: bool include_verbose_metrics = 6; */ includeVerboseMetrics: boolean; }; /** * Describes the message gitpod.v1.MetricsConfiguration. * Use `create(MetricsConfigurationSchema)` to create a new message. */ export declare const MetricsConfigurati