# Projects ## CreateProjects `client.Projects.BulkNew(ctx, body) (*ProjectBulkNewResponse, error)` **post** `/gitpod.v1.ProjectService/CreateProjects` Creates multiple projects in a single request. Use this method to: - Onboard multiple repositories at once - Import a batch of projects during initial setup Returns successfully created projects and details about any failures. Each project in the request is processed independently — partial success is possible. ### Examples - Create multiple projects: Creates several projects in one request. ```yaml projects: - name: "Frontend" initializer: specs: - git: remoteUri: "https://github.com/org/frontend" - name: "Backend" initializer: specs: - git: remoteUri: "https://github.com/org/backend" ``` ### Parameters - `body ProjectBulkNewParams` - `Projects param.Field[[]ProjectBulkNewParamsProject]` - `Initializer EnvironmentInitializer` initializer is the content initializer - `Specs []EnvironmentInitializerSpec` - `ContextURL EnvironmentInitializerSpecsContextURL` - `URL string` url is the URL from which the environment is created - `Git EnvironmentInitializerSpecsGit` - `CheckoutLocation string` a path relative to the environment root in which the code will be checked out to - `CloneTarget string` the value for the clone target mode - use depends on the target mode - `RemoteUri string` remote_uri is the Git remote origin - `TargetMode EnvironmentInitializerSpecsGitTargetMode` the target mode determines what gets checked out - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeUnspecified EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_UNSPECIFIED"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteHead EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_HEAD"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteCommit EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_COMMIT"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeLocalBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_LOCAL_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteTag EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_TAG"` - `UpstreamRemoteUri string` upstream_Remote_uri is the fork upstream of a repository - `AutomationsFilePath string` automations_file_path is the path to the automations file relative to the repo root path must not be absolute (start with a /): ``` this.matches('^$|^[^/].*') ``` - `DevcontainerFilePath string` devcontainer_file_path is the path to the devcontainer file relative to the repo root path must not be absolute (start with a /): ``` this.matches('^$|^[^/].*') ``` - `Name string` - `PrebuildConfiguration ProjectPrebuildConfiguration` prebuild_configuration defines how prebuilds are created for this project. If not set, prebuilds are disabled for the project. - `Enabled bool` enabled controls whether prebuilds are created for this project. When disabled, no automatic prebuilds will be triggered. - `EnableJetbrainsWarmup bool` enable_jetbrains_warmup controls whether JetBrains IDE warmup runs during prebuilds. - `EnvironmentClassIDs []string` environment_class_ids specifies which environment classes should have prebuilds created. If empty, no prebuilds are created. - `Executor Subject` executor specifies who runs prebuilds for this project. The executor's SCM credentials are used to clone the repository. If not set, defaults to the project creator. - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"` - `const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"` - `const PrincipalUser Principal = "PRINCIPAL_USER"` - `const PrincipalRunner Principal = "PRINCIPAL_RUNNER"` - `const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"` - `const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"` - `const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"` - `Timeout string` timeout is the maximum duration allowed for a prebuild to complete. If not specified, defaults to 1 hour. Must be between 5 minutes and 2 hours. - `Trigger ProjectPrebuildConfigurationTrigger` trigger defines when prebuilds should be created. - `DailySchedule ProjectPrebuildConfigurationTriggerDailySchedule` daily_schedule triggers a prebuild once per day at the specified hour (UTC). The actual start time may vary slightly to distribute system load. - `HourUtc int64` hour_utc is the hour of day (0-23) in UTC when the prebuild should start. The actual start time may be adjusted by a few minutes to balance system load. - `TechnicalDescription string` technical_description is a detailed technical description of the project This field is not returned by default in GetProject or ListProjects responses 8KB max ### Returns - `type ProjectBulkNewResponse struct{…}` - `CreatedProjects []Project` created_projects contains the successfully created projects - `EnvironmentClass ProjectEnvironmentClass` Use `environment_classes` instead. - `EnvironmentClassID string` Use a fixed environment class on a given Runner. This cannot be a local runner's environment class. - `LocalRunner bool` Use a local runner for the user - `Order int64` order is the priority of this entry - `ID string` id is the unique identifier for the project - `AutomationsFilePath string` automations_file_path is the path to the automations file relative to the repo root - `DesiredPhase ProjectPhase` desired_phase is the desired phase of the project When set to DELETED, the project is pending deletion - `const ProjectPhaseUnspecified ProjectPhase = "PROJECT_PHASE_UNSPECIFIED"` - `const ProjectPhaseActive ProjectPhase = "PROJECT_PHASE_ACTIVE"` - `const ProjectPhaseDeleted ProjectPhase = "PROJECT_PHASE_DELETED"` - `DevcontainerFilePath string` devcontainer_file_path is the path to the devcontainer file relative to the repo root - `EnvironmentClasses []ProjectEnvironmentClass` environment_classes is the list of environment classes for the project - `EnvironmentClassID string` Use a fixed environment class on a given Runner. This cannot be a local runner's environment class. - `LocalRunner bool` Use a local runner for the user - `Order int64` order is the priority of this entry - `Initializer EnvironmentInitializer` initializer is the content initializer - `Specs []EnvironmentInitializerSpec` - `ContextURL EnvironmentInitializerSpecsContextURL` - `URL string` url is the URL from which the environment is created - `Git EnvironmentInitializerSpecsGit` - `CheckoutLocation string` a path relative to the environment root in which the code will be checked out to - `CloneTarget string` the value for the clone target mode - use depends on the target mode - `RemoteUri string` remote_uri is the Git remote origin - `TargetMode EnvironmentInitializerSpecsGitTargetMode` the target mode determines what gets checked out - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeUnspecified EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_UNSPECIFIED"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteHead EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_HEAD"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteCommit EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_COMMIT"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeLocalBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_LOCAL_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteTag EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_TAG"` - `UpstreamRemoteUri string` upstream_Remote_uri is the fork upstream of a repository - `Metadata ProjectMetadata` - `CreatedAt Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `Creator Subject` creator is the identity of the project creator - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"` - `const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"` - `const PrincipalUser Principal = "PRINCIPAL_USER"` - `const PrincipalRunner Principal = "PRINCIPAL_RUNNER"` - `const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"` - `const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"` - `const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"` - `Name string` name is the human readable name of the project - `OrganizationID string` organization_id is the ID of the organization that contains the environment - `UpdatedAt Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `PrebuildConfiguration ProjectPrebuildConfiguration` prebuild_configuration defines how prebuilds are created for this project. - `Enabled bool` enabled controls whether prebuilds are created for this project. When disabled, no automatic prebuilds will be triggered. - `EnableJetbrainsWarmup bool` enable_jetbrains_warmup controls whether JetBrains IDE warmup runs during prebuilds. - `EnvironmentClassIDs []string` environment_class_ids specifies which environment classes should have prebuilds created. If empty, no prebuilds are created. - `Executor Subject` executor specifies who runs prebuilds for this project. The executor's SCM credentials are used to clone the repository. If not set, defaults to the project creator. - `Timeout string` timeout is the maximum duration allowed for a prebuild to complete. If not specified, defaults to 1 hour. Must be between 5 minutes and 2 hours. - `Trigger ProjectPrebuildConfigurationTrigger` trigger defines when prebuilds should be created. - `DailySchedule ProjectPrebuildConfigurationTriggerDailySchedule` daily_schedule triggers a prebuild once per day at the specified hour (UTC). The actual start time may vary slightly to distribute system load. - `HourUtc int64` hour_utc is the hour of day (0-23) in UTC when the prebuild should start. The actual start time may be adjusted by a few minutes to balance system load. - `RecommendedEditors RecommendedEditors` recommended_editors specifies the editors recommended for this project. - `Editors map[string, RecommendedEditorsEditor]` editors maps editor aliases to their recommended versions. Key is the editor alias (e.g., "intellij", "goland", "vscode"). Value contains the list of recommended versions for that editor. If versions list is empty, all available versions are recommended. Example: {"intellij": {versions: ["2025.1", "2024.3"]}, "goland": {}} - `Versions []string` versions is the list of recommended versions for this editor. If empty, all available versions are recommended. Examples for JetBrains: ["2025.1", "2024.3"] - `TechnicalDescription string` technical_description is a detailed technical description of the project This field is not returned by default in GetProject or ListProjects responses - `UsedBy ProjectUsedBy` - `Subjects []Subject` Subjects are the 10 most recent subjects who have used the project to create an environment - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `TotalSubjects int64` Total number of unique subjects who have used the project - `FailedProjects []ProjectBulkNewResponseFailedProject` failed_projects contains details about projects that failed to create - `Error string` error describes why the project creation failed - `Index int64` index is the position in the request array (0-based) - `Name string` name is the project name that failed ### Example ```go package main import ( "context" "fmt" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) response, err := client.Projects.BulkNew(context.TODO(), gitpod.ProjectBulkNewParams{ Projects: gitpod.F([]gitpod.ProjectBulkNewParamsProject{gitpod.ProjectBulkNewParamsProject{ Initializer: gitpod.F(gitpod.EnvironmentInitializerParam{ Specs: gitpod.F([]gitpod.EnvironmentInitializerSpecParam{gitpod.EnvironmentInitializerSpecParam{ Git: gitpod.F(gitpod.EnvironmentInitializerSpecsGitParam{ RemoteUri: gitpod.F("https://github.com/org/frontend"), }), }}), }), Name: gitpod.F("Frontend"), }, gitpod.ProjectBulkNewParamsProject{ Initializer: gitpod.F(gitpod.EnvironmentInitializerParam{ Specs: gitpod.F([]gitpod.EnvironmentInitializerSpecParam{gitpod.EnvironmentInitializerSpecParam{ Git: gitpod.F(gitpod.EnvironmentInitializerSpecsGitParam{ RemoteUri: gitpod.F("https://github.com/org/backend"), }), }}), }), Name: gitpod.F("Backend"), }}), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.CreatedProjects) } ``` #### Response ```json { "createdProjects": [ { "environmentClass": { "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "localRunner": true, "order": 0 }, "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "automationsFilePath": "automationsFilePath", "desiredPhase": "PROJECT_PHASE_UNSPECIFIED", "devcontainerFilePath": "devcontainerFilePath", "environmentClasses": [ { "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "localRunner": true, "order": 0 } ], "initializer": { "specs": [ { "contextUrl": { "url": "https://example.com" }, "git": { "checkoutLocation": "checkoutLocation", "cloneTarget": "cloneTarget", "remoteUri": "remoteUri", "targetMode": "CLONE_TARGET_MODE_UNSPECIFIED", "upstreamRemoteUri": "upstreamRemoteUri" } } ] }, "metadata": { "createdAt": "2019-12-27T18:11:19.117Z", "creator": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "name": "x", "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "updatedAt": "2019-12-27T18:11:19.117Z" }, "prebuildConfiguration": { "enabled": true, "enableJetbrainsWarmup": true, "environmentClassIds": [ "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" ], "executor": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "timeout": "+9125115.360s", "trigger": { "dailySchedule": { "hourUtc": 23 } } }, "recommendedEditors": { "editors": { "foo": { "versions": [ "string" ] } } }, "technicalDescription": "technicalDescription", "usedBy": { "subjects": [ { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" } ], "totalSubjects": 0 } } ], "failedProjects": [ { "error": "error", "index": 0, "name": "name" } ] } ``` ## DeleteProjects `client.Projects.BulkDelete(ctx, body) (*ProjectBulkDeleteResponse, error)` **post** `/gitpod.v1.ProjectService/DeleteProjects` Deletes multiple projects in a single request. Use this method to: - Remove multiple unused projects at once - Clean up projects in batch Returns successfully deleted project IDs and details about any failures. Each project in the request is processed independently — partial success is possible. ### Examples - Delete multiple projects: Permanently removes several projects in one request. ```yaml projectIds: - "b0e12f6c-4c67-429d-a4a6-d9838b5da047" - "c1f23g7d-5d78-430e-b5b7-e0949c6eb158" ``` ### Parameters - `body ProjectBulkDeleteParams` - `ProjectIDs param.Field[[]string]` ### Returns - `type ProjectBulkDeleteResponse struct{…}` - `DeletedProjectIDs []string` deleted_project_ids contains the IDs of successfully deleted projects - `FailedProjects []ProjectBulkDeleteResponseFailedProject` failed_projects contains details about projects that failed to delete - `Error string` error describes why the project deletion failed - `Index int64` index is the position in the request array (0-based) - `ProjectID string` project_id is the project ID that failed ### Example ```go package main import ( "context" "fmt" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) response, err := client.Projects.BulkDelete(context.TODO(), gitpod.ProjectBulkDeleteParams{ ProjectIDs: gitpod.F([]string{"b0e12f6c-4c67-429d-a4a6-d9838b5da047", "c1f23g7d-5d78-430e-b5b7-e0949c6eb158"}), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.DeletedProjectIDs) } ``` #### Response ```json { "deletedProjectIds": [ "string" ], "failedProjects": [ { "error": "error", "index": 0, "projectId": "projectId" } ] } ``` ## UpdateProjects `client.Projects.BulkUpdate(ctx, body) (*ProjectBulkUpdateResponse, error)` **post** `/gitpod.v1.ProjectService/UpdateProjects` Updates multiple projects in a single request. Use this method to: - Modify settings across multiple projects at once - Apply configuration changes in batch Returns successfully updated projects and details about any failures. Each project in the request is processed independently — partial success is possible. ### Examples - Update multiple projects: Updates several projects in one request. ```yaml projects: - projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" name: "Updated Frontend" - projectId: "c1f23g7d-5d78-430e-b5b7-e0949c6eb158" name: "Updated Backend" ``` ### Parameters - `body ProjectBulkUpdateParams` - `Projects param.Field[[]ProjectBulkUpdateParamsProject]` - `AutomationsFilePath string` automations_file_path is the path to the automations file relative to the repo root path must not be absolute (start with a /): ``` this.matches('^$|^[^/].*') ``` - `DevcontainerFilePath string` devcontainer_file_path is the path to the devcontainer file relative to the repo root path must not be absolute (start with a /): ``` this.matches('^$|^[^/].*') ``` - `Initializer EnvironmentInitializer` initializer is the content initializer - `Specs []EnvironmentInitializerSpec` - `ContextURL EnvironmentInitializerSpecsContextURL` - `URL string` url is the URL from which the environment is created - `Git EnvironmentInitializerSpecsGit` - `CheckoutLocation string` a path relative to the environment root in which the code will be checked out to - `CloneTarget string` the value for the clone target mode - use depends on the target mode - `RemoteUri string` remote_uri is the Git remote origin - `TargetMode EnvironmentInitializerSpecsGitTargetMode` the target mode determines what gets checked out - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeUnspecified EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_UNSPECIFIED"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteHead EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_HEAD"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteCommit EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_COMMIT"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeLocalBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_LOCAL_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteTag EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_TAG"` - `UpstreamRemoteUri string` upstream_Remote_uri is the fork upstream of a repository - `Name string` - `PrebuildConfiguration ProjectPrebuildConfiguration` prebuild_configuration defines how prebuilds are created for this project. If not provided, the existing prebuild configuration is not modified. To disable prebuilds, set enabled to false. - `Enabled bool` enabled controls whether prebuilds are created for this project. When disabled, no automatic prebuilds will be triggered. - `EnableJetbrainsWarmup bool` enable_jetbrains_warmup controls whether JetBrains IDE warmup runs during prebuilds. - `EnvironmentClassIDs []string` environment_class_ids specifies which environment classes should have prebuilds created. If empty, no prebuilds are created. - `Executor Subject` executor specifies who runs prebuilds for this project. The executor's SCM credentials are used to clone the repository. If not set, defaults to the project creator. - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"` - `const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"` - `const PrincipalUser Principal = "PRINCIPAL_USER"` - `const PrincipalRunner Principal = "PRINCIPAL_RUNNER"` - `const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"` - `const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"` - `const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"` - `Timeout string` timeout is the maximum duration allowed for a prebuild to complete. If not specified, defaults to 1 hour. Must be between 5 minutes and 2 hours. - `Trigger ProjectPrebuildConfigurationTrigger` trigger defines when prebuilds should be created. - `DailySchedule ProjectPrebuildConfigurationTriggerDailySchedule` daily_schedule triggers a prebuild once per day at the specified hour (UTC). The actual start time may vary slightly to distribute system load. - `HourUtc int64` hour_utc is the hour of day (0-23) in UTC when the prebuild should start. The actual start time may be adjusted by a few minutes to balance system load. - `ProjectID string` project_id specifies the project identifier - `RecommendedEditors RecommendedEditors` recommended_editors specifies the editors recommended for this project. If not provided, the existing recommended editors are not modified. To clear all recommended editors, set to an empty RecommendedEditors message. - `Editors map[string, RecommendedEditorsEditor]` editors maps editor aliases to their recommended versions. Key is the editor alias (e.g., "intellij", "goland", "vscode"). Value contains the list of recommended versions for that editor. If versions list is empty, all available versions are recommended. Example: {"intellij": {versions: ["2025.1", "2024.3"]}, "goland": {}} - `Versions []string` versions is the list of recommended versions for this editor. If empty, all available versions are recommended. Examples for JetBrains: ["2025.1", "2024.3"] - `TechnicalDescription string` technical_description is a detailed technical description of the project This field is not returned by default in GetProject or ListProjects responses 8KB max ### Returns - `type ProjectBulkUpdateResponse struct{…}` - `FailedProjects []ProjectBulkUpdateResponseFailedProject` failed_projects contains details about projects that failed to update - `Error string` error describes why the project update failed - `Index int64` index is the position in the request array (0-based) - `ProjectID string` project_id is the project ID that failed - `UpdatedProjects []Project` updated_projects contains the successfully updated projects - `EnvironmentClass ProjectEnvironmentClass` Use `environment_classes` instead. - `EnvironmentClassID string` Use a fixed environment class on a given Runner. This cannot be a local runner's environment class. - `LocalRunner bool` Use a local runner for the user - `Order int64` order is the priority of this entry - `ID string` id is the unique identifier for the project - `AutomationsFilePath string` automations_file_path is the path to the automations file relative to the repo root - `DesiredPhase ProjectPhase` desired_phase is the desired phase of the project When set to DELETED, the project is pending deletion - `const ProjectPhaseUnspecified ProjectPhase = "PROJECT_PHASE_UNSPECIFIED"` - `const ProjectPhaseActive ProjectPhase = "PROJECT_PHASE_ACTIVE"` - `const ProjectPhaseDeleted ProjectPhase = "PROJECT_PHASE_DELETED"` - `DevcontainerFilePath string` devcontainer_file_path is the path to the devcontainer file relative to the repo root - `EnvironmentClasses []ProjectEnvironmentClass` environment_classes is the list of environment classes for the project - `EnvironmentClassID string` Use a fixed environment class on a given Runner. This cannot be a local runner's environment class. - `LocalRunner bool` Use a local runner for the user - `Order int64` order is the priority of this entry - `Initializer EnvironmentInitializer` initializer is the content initializer - `Specs []EnvironmentInitializerSpec` - `ContextURL EnvironmentInitializerSpecsContextURL` - `URL string` url is the URL from which the environment is created - `Git EnvironmentInitializerSpecsGit` - `CheckoutLocation string` a path relative to the environment root in which the code will be checked out to - `CloneTarget string` the value for the clone target mode - use depends on the target mode - `RemoteUri string` remote_uri is the Git remote origin - `TargetMode EnvironmentInitializerSpecsGitTargetMode` the target mode determines what gets checked out - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeUnspecified EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_UNSPECIFIED"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteHead EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_HEAD"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteCommit EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_COMMIT"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeLocalBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_LOCAL_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteTag EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_TAG"` - `UpstreamRemoteUri string` upstream_Remote_uri is the fork upstream of a repository - `Metadata ProjectMetadata` - `CreatedAt Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `Creator Subject` creator is the identity of the project creator - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"` - `const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"` - `const PrincipalUser Principal = "PRINCIPAL_USER"` - `const PrincipalRunner Principal = "PRINCIPAL_RUNNER"` - `const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"` - `const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"` - `const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"` - `Name string` name is the human readable name of the project - `OrganizationID string` organization_id is the ID of the organization that contains the environment - `UpdatedAt Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `PrebuildConfiguration ProjectPrebuildConfiguration` prebuild_configuration defines how prebuilds are created for this project. - `Enabled bool` enabled controls whether prebuilds are created for this project. When disabled, no automatic prebuilds will be triggered. - `EnableJetbrainsWarmup bool` enable_jetbrains_warmup controls whether JetBrains IDE warmup runs during prebuilds. - `EnvironmentClassIDs []string` environment_class_ids specifies which environment classes should have prebuilds created. If empty, no prebuilds are created. - `Executor Subject` executor specifies who runs prebuilds for this project. The executor's SCM credentials are used to clone the repository. If not set, defaults to the project creator. - `Timeout string` timeout is the maximum duration allowed for a prebuild to complete. If not specified, defaults to 1 hour. Must be between 5 minutes and 2 hours. - `Trigger ProjectPrebuildConfigurationTrigger` trigger defines when prebuilds should be created. - `DailySchedule ProjectPrebuildConfigurationTriggerDailySchedule` daily_schedule triggers a prebuild once per day at the specified hour (UTC). The actual start time may vary slightly to distribute system load. - `HourUtc int64` hour_utc is the hour of day (0-23) in UTC when the prebuild should start. The actual start time may be adjusted by a few minutes to balance system load. - `RecommendedEditors RecommendedEditors` recommended_editors specifies the editors recommended for this project. - `Editors map[string, RecommendedEditorsEditor]` editors maps editor aliases to their recommended versions. Key is the editor alias (e.g., "intellij", "goland", "vscode"). Value contains the list of recommended versions for that editor. If versions list is empty, all available versions are recommended. Example: {"intellij": {versions: ["2025.1", "2024.3"]}, "goland": {}} - `Versions []string` versions is the list of recommended versions for this editor. If empty, all available versions are recommended. Examples for JetBrains: ["2025.1", "2024.3"] - `TechnicalDescription string` technical_description is a detailed technical description of the project This field is not returned by default in GetProject or ListProjects responses - `UsedBy ProjectUsedBy` - `Subjects []Subject` Subjects are the 10 most recent subjects who have used the project to create an environment - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `TotalSubjects int64` Total number of unique subjects who have used the project ### Example ```go package main import ( "context" "fmt" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) response, err := client.Projects.BulkUpdate(context.TODO(), gitpod.ProjectBulkUpdateParams{ Projects: gitpod.F([]gitpod.ProjectBulkUpdateParamsProject{gitpod.ProjectBulkUpdateParamsProject{ Name: gitpod.F("Updated Frontend"), ProjectID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"), }, gitpod.ProjectBulkUpdateParamsProject{ Name: gitpod.F("Updated Backend"), ProjectID: gitpod.F("c1f23g7d-5d78-430e-b5b7-e0949c6eb158"), }}), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.FailedProjects) } ``` #### Response ```json { "failedProjects": [ { "error": "error", "index": 0, "projectId": "projectId" } ], "updatedProjects": [ { "environmentClass": { "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "localRunner": true, "order": 0 }, "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "automationsFilePath": "automationsFilePath", "desiredPhase": "PROJECT_PHASE_UNSPECIFIED", "devcontainerFilePath": "devcontainerFilePath", "environmentClasses": [ { "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "localRunner": true, "order": 0 } ], "initializer": { "specs": [ { "contextUrl": { "url": "https://example.com" }, "git": { "checkoutLocation": "checkoutLocation", "cloneTarget": "cloneTarget", "remoteUri": "remoteUri", "targetMode": "CLONE_TARGET_MODE_UNSPECIFIED", "upstreamRemoteUri": "upstreamRemoteUri" } } ] }, "metadata": { "createdAt": "2019-12-27T18:11:19.117Z", "creator": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "name": "x", "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "updatedAt": "2019-12-27T18:11:19.117Z" }, "prebuildConfiguration": { "enabled": true, "enableJetbrainsWarmup": true, "environmentClassIds": [ "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" ], "executor": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "timeout": "+9125115.360s", "trigger": { "dailySchedule": { "hourUtc": 23 } } }, "recommendedEditors": { "editors": { "foo": { "versions": [ "string" ] } } }, "technicalDescription": "technicalDescription", "usedBy": { "subjects": [ { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" } ], "totalSubjects": 0 } } ] } ``` ## CreateProject `client.Projects.New(ctx, body) (*ProjectNewResponse, error)` **post** `/gitpod.v1.ProjectService/CreateProject` Creates a new project with specified configuration. Use this method to: - Set up development projects - Configure project environments - Define project settings - Initialize project content ### Examples - Create basic project: Creates a project with minimal configuration. ```yaml name: "Web Application" initializer: specs: - git: remoteUri: "https://github.com/org/repo" ``` - Create project with devcontainer: Creates a project with custom development container. ```yaml name: "Backend Service" initializer: specs: - git: remoteUri: "https://github.com/org/backend" devcontainerFilePath: ".devcontainer/devcontainer.json" automationsFilePath: ".gitpod/automations.yaml" ``` ### Parameters - `body ProjectNewParams` - `Initializer param.Field[EnvironmentInitializer]` initializer is the content initializer - `AutomationsFilePath param.Field[string]` automations_file_path is the path to the automations file relative to the repo root path must not be absolute (start with a /): ``` this.matches('^$|^[^/].*') ``` - `DevcontainerFilePath param.Field[string]` devcontainer_file_path is the path to the devcontainer file relative to the repo root path must not be absolute (start with a /): ``` this.matches('^$|^[^/].*') ``` - `Name param.Field[string]` - `PrebuildConfiguration param.Field[ProjectPrebuildConfiguration]` prebuild_configuration defines how prebuilds are created for this project. If not set, prebuilds are disabled for the project. - `TechnicalDescription param.Field[string]` technical_description is a detailed technical description of the project This field is not returned by default in GetProject or ListProjects responses 8KB max ### Returns - `type ProjectNewResponse struct{…}` - `Project Project` - `EnvironmentClass ProjectEnvironmentClass` Use `environment_classes` instead. - `EnvironmentClassID string` Use a fixed environment class on a given Runner. This cannot be a local runner's environment class. - `LocalRunner bool` Use a local runner for the user - `Order int64` order is the priority of this entry - `ID string` id is the unique identifier for the project - `AutomationsFilePath string` automations_file_path is the path to the automations file relative to the repo root - `DesiredPhase ProjectPhase` desired_phase is the desired phase of the project When set to DELETED, the project is pending deletion - `const ProjectPhaseUnspecified ProjectPhase = "PROJECT_PHASE_UNSPECIFIED"` - `const ProjectPhaseActive ProjectPhase = "PROJECT_PHASE_ACTIVE"` - `const ProjectPhaseDeleted ProjectPhase = "PROJECT_PHASE_DELETED"` - `DevcontainerFilePath string` devcontainer_file_path is the path to the devcontainer file relative to the repo root - `EnvironmentClasses []ProjectEnvironmentClass` environment_classes is the list of environment classes for the project - `EnvironmentClassID string` Use a fixed environment class on a given Runner. This cannot be a local runner's environment class. - `LocalRunner bool` Use a local runner for the user - `Order int64` order is the priority of this entry - `Initializer EnvironmentInitializer` initializer is the content initializer - `Specs []EnvironmentInitializerSpec` - `ContextURL EnvironmentInitializerSpecsContextURL` - `URL string` url is the URL from which the environment is created - `Git EnvironmentInitializerSpecsGit` - `CheckoutLocation string` a path relative to the environment root in which the code will be checked out to - `CloneTarget string` the value for the clone target mode - use depends on the target mode - `RemoteUri string` remote_uri is the Git remote origin - `TargetMode EnvironmentInitializerSpecsGitTargetMode` the target mode determines what gets checked out - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeUnspecified EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_UNSPECIFIED"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteHead EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_HEAD"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteCommit EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_COMMIT"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeLocalBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_LOCAL_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteTag EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_TAG"` - `UpstreamRemoteUri string` upstream_Remote_uri is the fork upstream of a repository - `Metadata ProjectMetadata` - `CreatedAt Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `Creator Subject` creator is the identity of the project creator - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"` - `const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"` - `const PrincipalUser Principal = "PRINCIPAL_USER"` - `const PrincipalRunner Principal = "PRINCIPAL_RUNNER"` - `const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"` - `const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"` - `const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"` - `Name string` name is the human readable name of the project - `OrganizationID string` organization_id is the ID of the organization that contains the environment - `UpdatedAt Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `PrebuildConfiguration ProjectPrebuildConfiguration` prebuild_configuration defines how prebuilds are created for this project. - `Enabled bool` enabled controls whether prebuilds are created for this project. When disabled, no automatic prebuilds will be triggered. - `EnableJetbrainsWarmup bool` enable_jetbrains_warmup controls whether JetBrains IDE warmup runs during prebuilds. - `EnvironmentClassIDs []string` environment_class_ids specifies which environment classes should have prebuilds created. If empty, no prebuilds are created. - `Executor Subject` executor specifies who runs prebuilds for this project. The executor's SCM credentials are used to clone the repository. If not set, defaults to the project creator. - `Timeout string` timeout is the maximum duration allowed for a prebuild to complete. If not specified, defaults to 1 hour. Must be between 5 minutes and 2 hours. - `Trigger ProjectPrebuildConfigurationTrigger` trigger defines when prebuilds should be created. - `DailySchedule ProjectPrebuildConfigurationTriggerDailySchedule` daily_schedule triggers a prebuild once per day at the specified hour (UTC). The actual start time may vary slightly to distribute system load. - `HourUtc int64` hour_utc is the hour of day (0-23) in UTC when the prebuild should start. The actual start time may be adjusted by a few minutes to balance system load. - `RecommendedEditors RecommendedEditors` recommended_editors specifies the editors recommended for this project. - `Editors map[string, RecommendedEditorsEditor]` editors maps editor aliases to their recommended versions. Key is the editor alias (e.g., "intellij", "goland", "vscode"). Value contains the list of recommended versions for that editor. If versions list is empty, all available versions are recommended. Example: {"intellij": {versions: ["2025.1", "2024.3"]}, "goland": {}} - `Versions []string` versions is the list of recommended versions for this editor. If empty, all available versions are recommended. Examples for JetBrains: ["2025.1", "2024.3"] - `TechnicalDescription string` technical_description is a detailed technical description of the project This field is not returned by default in GetProject or ListProjects responses - `UsedBy ProjectUsedBy` - `Subjects []Subject` Subjects are the 10 most recent subjects who have used the project to create an environment - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `TotalSubjects int64` Total number of unique subjects who have used the project ### Example ```go package main import ( "context" "fmt" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) project, err := client.Projects.New(context.TODO(), gitpod.ProjectNewParams{ Initializer: gitpod.F(gitpod.EnvironmentInitializerParam{ Specs: gitpod.F([]gitpod.EnvironmentInitializerSpecParam{gitpod.EnvironmentInitializerSpecParam{ Git: gitpod.F(gitpod.EnvironmentInitializerSpecsGitParam{ RemoteUri: gitpod.F("https://github.com/org/repo"), }), }}), }), Name: gitpod.F("Web Application"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", project.Project) } ``` #### Response ```json { "project": { "environmentClass": { "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "localRunner": true, "order": 0 }, "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "automationsFilePath": "automationsFilePath", "desiredPhase": "PROJECT_PHASE_UNSPECIFIED", "devcontainerFilePath": "devcontainerFilePath", "environmentClasses": [ { "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "localRunner": true, "order": 0 } ], "initializer": { "specs": [ { "contextUrl": { "url": "https://example.com" }, "git": { "checkoutLocation": "checkoutLocation", "cloneTarget": "cloneTarget", "remoteUri": "remoteUri", "targetMode": "CLONE_TARGET_MODE_UNSPECIFIED", "upstreamRemoteUri": "upstreamRemoteUri" } } ] }, "metadata": { "createdAt": "2019-12-27T18:11:19.117Z", "creator": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "name": "x", "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "updatedAt": "2019-12-27T18:11:19.117Z" }, "prebuildConfiguration": { "enabled": true, "enableJetbrainsWarmup": true, "environmentClassIds": [ "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" ], "executor": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "timeout": "+9125115.360s", "trigger": { "dailySchedule": { "hourUtc": 23 } } }, "recommendedEditors": { "editors": { "foo": { "versions": [ "string" ] } } }, "technicalDescription": "technicalDescription", "usedBy": { "subjects": [ { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" } ], "totalSubjects": 0 } } } ``` ## CreateProjectFromEnvironment `client.Projects.NewFromEnvironment(ctx, body) (*ProjectNewFromEnvironmentResponse, error)` **post** `/gitpod.v1.ProjectService/CreateProjectFromEnvironment` Creates a new project using an existing environment as a template. Use this method to: - Clone environment configurations - Create projects from templates - Share environment setups ### Examples - Create from environment: Creates a project based on existing environment. ```yaml name: "Frontend Project" environmentId: "07e03a28-65a5-4d98-b532-8ea67b188048" ``` ### Parameters - `body ProjectNewFromEnvironmentParams` - `EnvironmentID param.Field[string]` environment_id specifies the environment identifier - `Name param.Field[string]` ### Returns - `type ProjectNewFromEnvironmentResponse struct{…}` - `Project Project` - `EnvironmentClass ProjectEnvironmentClass` Use `environment_classes` instead. - `EnvironmentClassID string` Use a fixed environment class on a given Runner. This cannot be a local runner's environment class. - `LocalRunner bool` Use a local runner for the user - `Order int64` order is the priority of this entry - `ID string` id is the unique identifier for the project - `AutomationsFilePath string` automations_file_path is the path to the automations file relative to the repo root - `DesiredPhase ProjectPhase` desired_phase is the desired phase of the project When set to DELETED, the project is pending deletion - `const ProjectPhaseUnspecified ProjectPhase = "PROJECT_PHASE_UNSPECIFIED"` - `const ProjectPhaseActive ProjectPhase = "PROJECT_PHASE_ACTIVE"` - `const ProjectPhaseDeleted ProjectPhase = "PROJECT_PHASE_DELETED"` - `DevcontainerFilePath string` devcontainer_file_path is the path to the devcontainer file relative to the repo root - `EnvironmentClasses []ProjectEnvironmentClass` environment_classes is the list of environment classes for the project - `EnvironmentClassID string` Use a fixed environment class on a given Runner. This cannot be a local runner's environment class. - `LocalRunner bool` Use a local runner for the user - `Order int64` order is the priority of this entry - `Initializer EnvironmentInitializer` initializer is the content initializer - `Specs []EnvironmentInitializerSpec` - `ContextURL EnvironmentInitializerSpecsContextURL` - `URL string` url is the URL from which the environment is created - `Git EnvironmentInitializerSpecsGit` - `CheckoutLocation string` a path relative to the environment root in which the code will be checked out to - `CloneTarget string` the value for the clone target mode - use depends on the target mode - `RemoteUri string` remote_uri is the Git remote origin - `TargetMode EnvironmentInitializerSpecsGitTargetMode` the target mode determines what gets checked out - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeUnspecified EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_UNSPECIFIED"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteHead EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_HEAD"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteCommit EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_COMMIT"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeLocalBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_LOCAL_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteTag EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_TAG"` - `UpstreamRemoteUri string` upstream_Remote_uri is the fork upstream of a repository - `Metadata ProjectMetadata` - `CreatedAt Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `Creator Subject` creator is the identity of the project creator - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"` - `const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"` - `const PrincipalUser Principal = "PRINCIPAL_USER"` - `const PrincipalRunner Principal = "PRINCIPAL_RUNNER"` - `const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"` - `const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"` - `const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"` - `Name string` name is the human readable name of the project - `OrganizationID string` organization_id is the ID of the organization that contains the environment - `UpdatedAt Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `PrebuildConfiguration ProjectPrebuildConfiguration` prebuild_configuration defines how prebuilds are created for this project. - `Enabled bool` enabled controls whether prebuilds are created for this project. When disabled, no automatic prebuilds will be triggered. - `EnableJetbrainsWarmup bool` enable_jetbrains_warmup controls whether JetBrains IDE warmup runs during prebuilds. - `EnvironmentClassIDs []string` environment_class_ids specifies which environment classes should have prebuilds created. If empty, no prebuilds are created. - `Executor Subject` executor specifies who runs prebuilds for this project. The executor's SCM credentials are used to clone the repository. If not set, defaults to the project creator. - `Timeout string` timeout is the maximum duration allowed for a prebuild to complete. If not specified, defaults to 1 hour. Must be between 5 minutes and 2 hours. - `Trigger ProjectPrebuildConfigurationTrigger` trigger defines when prebuilds should be created. - `DailySchedule ProjectPrebuildConfigurationTriggerDailySchedule` daily_schedule triggers a prebuild once per day at the specified hour (UTC). The actual start time may vary slightly to distribute system load. - `HourUtc int64` hour_utc is the hour of day (0-23) in UTC when the prebuild should start. The actual start time may be adjusted by a few minutes to balance system load. - `RecommendedEditors RecommendedEditors` recommended_editors specifies the editors recommended for this project. - `Editors map[string, RecommendedEditorsEditor]` editors maps editor aliases to their recommended versions. Key is the editor alias (e.g., "intellij", "goland", "vscode"). Value contains the list of recommended versions for that editor. If versions list is empty, all available versions are recommended. Example: {"intellij": {versions: ["2025.1", "2024.3"]}, "goland": {}} - `Versions []string` versions is the list of recommended versions for this editor. If empty, all available versions are recommended. Examples for JetBrains: ["2025.1", "2024.3"] - `TechnicalDescription string` technical_description is a detailed technical description of the project This field is not returned by default in GetProject or ListProjects responses - `UsedBy ProjectUsedBy` - `Subjects []Subject` Subjects are the 10 most recent subjects who have used the project to create an environment - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `TotalSubjects int64` Total number of unique subjects who have used the project ### Example ```go package main import ( "context" "fmt" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) response, err := client.Projects.NewFromEnvironment(context.TODO(), gitpod.ProjectNewFromEnvironmentParams{ EnvironmentID: gitpod.F("07e03a28-65a5-4d98-b532-8ea67b188048"), Name: gitpod.F("Frontend Project"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", response.Project) } ``` #### Response ```json { "project": { "environmentClass": { "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "localRunner": true, "order": 0 }, "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "automationsFilePath": "automationsFilePath", "desiredPhase": "PROJECT_PHASE_UNSPECIFIED", "devcontainerFilePath": "devcontainerFilePath", "environmentClasses": [ { "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "localRunner": true, "order": 0 } ], "initializer": { "specs": [ { "contextUrl": { "url": "https://example.com" }, "git": { "checkoutLocation": "checkoutLocation", "cloneTarget": "cloneTarget", "remoteUri": "remoteUri", "targetMode": "CLONE_TARGET_MODE_UNSPECIFIED", "upstreamRemoteUri": "upstreamRemoteUri" } } ] }, "metadata": { "createdAt": "2019-12-27T18:11:19.117Z", "creator": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "name": "x", "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "updatedAt": "2019-12-27T18:11:19.117Z" }, "prebuildConfiguration": { "enabled": true, "enableJetbrainsWarmup": true, "environmentClassIds": [ "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" ], "executor": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "timeout": "+9125115.360s", "trigger": { "dailySchedule": { "hourUtc": 23 } } }, "recommendedEditors": { "editors": { "foo": { "versions": [ "string" ] } } }, "technicalDescription": "technicalDescription", "usedBy": { "subjects": [ { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" } ], "totalSubjects": 0 } } } ``` ## DeleteProject `client.Projects.Delete(ctx, body) (*ProjectDeleteResponse, error)` **post** `/gitpod.v1.ProjectService/DeleteProject` Deletes a project permanently. Use this method to: - Remove unused projects - Clean up test projects - Delete obsolete configurations ### Examples - Delete project: Permanently removes a project. ```yaml projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" ``` ### Parameters - `body ProjectDeleteParams` - `ProjectID param.Field[string]` project_id specifies the project identifier ### Returns - `type ProjectDeleteResponse interface{…}` ### Example ```go package main import ( "context" "fmt" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) project, err := client.Projects.Delete(context.TODO(), gitpod.ProjectDeleteParams{ ProjectID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", project) } ``` #### Response ```json {} ``` ## ListProjects `client.Projects.List(ctx, params) (*ProjectsPage[Project], error)` **post** `/gitpod.v1.ProjectService/ListProjects` Lists projects with optional filtering. Use this method to: - View all accessible projects - Browse project configurations - Monitor project status ### Examples - List projects: Shows all projects with pagination. ```yaml pagination: pageSize: 20 ``` ### Parameters - `params ProjectListParams` - `Token param.Field[string]` Query param - `PageSize param.Field[int64]` Query param - `Filter param.Field[ProjectListParamsFilter]` Body param - `ProjectIDs []string` project_ids filters the response to only projects with these IDs - `RunnerIDs []string` runner_ids filters the response to only projects that use environment classes from these runners - `RunnerKinds []RunnerKind` runner_kinds filters the response to only projects that use environment classes from runners of these kinds - `const RunnerKindUnspecified RunnerKind = "RUNNER_KIND_UNSPECIFIED"` - `const RunnerKindLocal RunnerKind = "RUNNER_KIND_LOCAL"` - `const RunnerKindRemote RunnerKind = "RUNNER_KIND_REMOTE"` - `const RunnerKindLocalConfiguration RunnerKind = "RUNNER_KIND_LOCAL_CONFIGURATION"` - `Search string` search performs case-insensitive search across project name, project ID, and repository name - `Pagination param.Field[ProjectListParamsPagination]` Body param: pagination contains the pagination options for listing organizations - `Token string` Token for the next set of results that was returned as next_token of a PaginationResponse - `PageSize int64` Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100. - `Sort param.Field[Sort]` Body param: sort specifies the order of results. Defaults to popularity descending. Supported fields: - "id": Sort by project ID (UUID v7, effectively creation order). Produces a stable, deterministic result set suitable for consistent pagination. - "popularity": Sort by popularity — a precomputed score based on recent environment creation activity. Updated periodically by a background job. ### Returns - `type Project struct{…}` - `EnvironmentClass ProjectEnvironmentClass` Use `environment_classes` instead. - `EnvironmentClassID string` Use a fixed environment class on a given Runner. This cannot be a local runner's environment class. - `LocalRunner bool` Use a local runner for the user - `Order int64` order is the priority of this entry - `ID string` id is the unique identifier for the project - `AutomationsFilePath string` automations_file_path is the path to the automations file relative to the repo root - `DesiredPhase ProjectPhase` desired_phase is the desired phase of the project When set to DELETED, the project is pending deletion - `const ProjectPhaseUnspecified ProjectPhase = "PROJECT_PHASE_UNSPECIFIED"` - `const ProjectPhaseActive ProjectPhase = "PROJECT_PHASE_ACTIVE"` - `const ProjectPhaseDeleted ProjectPhase = "PROJECT_PHASE_DELETED"` - `DevcontainerFilePath string` devcontainer_file_path is the path to the devcontainer file relative to the repo root - `EnvironmentClasses []ProjectEnvironmentClass` environment_classes is the list of environment classes for the project - `EnvironmentClassID string` Use a fixed environment class on a given Runner. This cannot be a local runner's environment class. - `LocalRunner bool` Use a local runner for the user - `Order int64` order is the priority of this entry - `Initializer EnvironmentInitializer` initializer is the content initializer - `Specs []EnvironmentInitializerSpec` - `ContextURL EnvironmentInitializerSpecsContextURL` - `URL string` url is the URL from which the environment is created - `Git EnvironmentInitializerSpecsGit` - `CheckoutLocation string` a path relative to the environment root in which the code will be checked out to - `CloneTarget string` the value for the clone target mode - use depends on the target mode - `RemoteUri string` remote_uri is the Git remote origin - `TargetMode EnvironmentInitializerSpecsGitTargetMode` the target mode determines what gets checked out - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeUnspecified EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_UNSPECIFIED"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteHead EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_HEAD"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteCommit EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_COMMIT"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeLocalBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_LOCAL_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteTag EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_TAG"` - `UpstreamRemoteUri string` upstream_Remote_uri is the fork upstream of a repository - `Metadata ProjectMetadata` - `CreatedAt Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `Creator Subject` creator is the identity of the project creator - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"` - `const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"` - `const PrincipalUser Principal = "PRINCIPAL_USER"` - `const PrincipalRunner Principal = "PRINCIPAL_RUNNER"` - `const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"` - `const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"` - `const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"` - `Name string` name is the human readable name of the project - `OrganizationID string` organization_id is the ID of the organization that contains the environment - `UpdatedAt Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `PrebuildConfiguration ProjectPrebuildConfiguration` prebuild_configuration defines how prebuilds are created for this project. - `Enabled bool` enabled controls whether prebuilds are created for this project. When disabled, no automatic prebuilds will be triggered. - `EnableJetbrainsWarmup bool` enable_jetbrains_warmup controls whether JetBrains IDE warmup runs during prebuilds. - `EnvironmentClassIDs []string` environment_class_ids specifies which environment classes should have prebuilds created. If empty, no prebuilds are created. - `Executor Subject` executor specifies who runs prebuilds for this project. The executor's SCM credentials are used to clone the repository. If not set, defaults to the project creator. - `Timeout string` timeout is the maximum duration allowed for a prebuild to complete. If not specified, defaults to 1 hour. Must be between 5 minutes and 2 hours. - `Trigger ProjectPrebuildConfigurationTrigger` trigger defines when prebuilds should be created. - `DailySchedule ProjectPrebuildConfigurationTriggerDailySchedule` daily_schedule triggers a prebuild once per day at the specified hour (UTC). The actual start time may vary slightly to distribute system load. - `HourUtc int64` hour_utc is the hour of day (0-23) in UTC when the prebuild should start. The actual start time may be adjusted by a few minutes to balance system load. - `RecommendedEditors RecommendedEditors` recommended_editors specifies the editors recommended for this project. - `Editors map[string, RecommendedEditorsEditor]` editors maps editor aliases to their recommended versions. Key is the editor alias (e.g., "intellij", "goland", "vscode"). Value contains the list of recommended versions for that editor. If versions list is empty, all available versions are recommended. Example: {"intellij": {versions: ["2025.1", "2024.3"]}, "goland": {}} - `Versions []string` versions is the list of recommended versions for this editor. If empty, all available versions are recommended. Examples for JetBrains: ["2025.1", "2024.3"] - `TechnicalDescription string` technical_description is a detailed technical description of the project This field is not returned by default in GetProject or ListProjects responses - `UsedBy ProjectUsedBy` - `Subjects []Subject` Subjects are the 10 most recent subjects who have used the project to create an environment - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `TotalSubjects int64` Total number of unique subjects who have used the project ### Example ```go package main import ( "context" "fmt" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) page, err := client.Projects.List(context.TODO(), gitpod.ProjectListParams{ Pagination: gitpod.F(gitpod.ProjectListParamsPagination{ PageSize: gitpod.F(int64(20)), }), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "count": { "relation": "COUNT_RESPONSE_RELATION_UNSPECIFIED", "value": 0 }, "pagination": { "nextToken": "nextToken" }, "projects": [ { "environmentClass": { "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "localRunner": true, "order": 0 }, "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "automationsFilePath": "automationsFilePath", "desiredPhase": "PROJECT_PHASE_UNSPECIFIED", "devcontainerFilePath": "devcontainerFilePath", "environmentClasses": [ { "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "localRunner": true, "order": 0 } ], "initializer": { "specs": [ { "contextUrl": { "url": "https://example.com" }, "git": { "checkoutLocation": "checkoutLocation", "cloneTarget": "cloneTarget", "remoteUri": "remoteUri", "targetMode": "CLONE_TARGET_MODE_UNSPECIFIED", "upstreamRemoteUri": "upstreamRemoteUri" } } ] }, "metadata": { "createdAt": "2019-12-27T18:11:19.117Z", "creator": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "name": "x", "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "updatedAt": "2019-12-27T18:11:19.117Z" }, "prebuildConfiguration": { "enabled": true, "enableJetbrainsWarmup": true, "environmentClassIds": [ "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" ], "executor": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "timeout": "+9125115.360s", "trigger": { "dailySchedule": { "hourUtc": 23 } } }, "recommendedEditors": { "editors": { "foo": { "versions": [ "string" ] } } }, "technicalDescription": "technicalDescription", "usedBy": { "subjects": [ { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" } ], "totalSubjects": 0 } } ] } ``` ## GetProject `client.Projects.Get(ctx, body) (*ProjectGetResponse, error)` **post** `/gitpod.v1.ProjectService/GetProject` Gets details about a specific project. Use this method to: - View project configuration - Check project status - Get project metadata ### Examples - Get project details: Retrieves information about a specific project. ```yaml projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" ``` ### Parameters - `body ProjectGetParams` - `ProjectID param.Field[string]` project_id specifies the project identifier ### Returns - `type ProjectGetResponse struct{…}` - `Project Project` - `EnvironmentClass ProjectEnvironmentClass` Use `environment_classes` instead. - `EnvironmentClassID string` Use a fixed environment class on a given Runner. This cannot be a local runner's environment class. - `LocalRunner bool` Use a local runner for the user - `Order int64` order is the priority of this entry - `ID string` id is the unique identifier for the project - `AutomationsFilePath string` automations_file_path is the path to the automations file relative to the repo root - `DesiredPhase ProjectPhase` desired_phase is the desired phase of the project When set to DELETED, the project is pending deletion - `const ProjectPhaseUnspecified ProjectPhase = "PROJECT_PHASE_UNSPECIFIED"` - `const ProjectPhaseActive ProjectPhase = "PROJECT_PHASE_ACTIVE"` - `const ProjectPhaseDeleted ProjectPhase = "PROJECT_PHASE_DELETED"` - `DevcontainerFilePath string` devcontainer_file_path is the path to the devcontainer file relative to the repo root - `EnvironmentClasses []ProjectEnvironmentClass` environment_classes is the list of environment classes for the project - `EnvironmentClassID string` Use a fixed environment class on a given Runner. This cannot be a local runner's environment class. - `LocalRunner bool` Use a local runner for the user - `Order int64` order is the priority of this entry - `Initializer EnvironmentInitializer` initializer is the content initializer - `Specs []EnvironmentInitializerSpec` - `ContextURL EnvironmentInitializerSpecsContextURL` - `URL string` url is the URL from which the environment is created - `Git EnvironmentInitializerSpecsGit` - `CheckoutLocation string` a path relative to the environment root in which the code will be checked out to - `CloneTarget string` the value for the clone target mode - use depends on the target mode - `RemoteUri string` remote_uri is the Git remote origin - `TargetMode EnvironmentInitializerSpecsGitTargetMode` the target mode determines what gets checked out - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeUnspecified EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_UNSPECIFIED"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteHead EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_HEAD"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteCommit EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_COMMIT"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeLocalBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_LOCAL_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteTag EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_TAG"` - `UpstreamRemoteUri string` upstream_Remote_uri is the fork upstream of a repository - `Metadata ProjectMetadata` - `CreatedAt Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `Creator Subject` creator is the identity of the project creator - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"` - `const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"` - `const PrincipalUser Principal = "PRINCIPAL_USER"` - `const PrincipalRunner Principal = "PRINCIPAL_RUNNER"` - `const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"` - `const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"` - `const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"` - `Name string` name is the human readable name of the project - `OrganizationID string` organization_id is the ID of the organization that contains the environment - `UpdatedAt Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `PrebuildConfiguration ProjectPrebuildConfiguration` prebuild_configuration defines how prebuilds are created for this project. - `Enabled bool` enabled controls whether prebuilds are created for this project. When disabled, no automatic prebuilds will be triggered. - `EnableJetbrainsWarmup bool` enable_jetbrains_warmup controls whether JetBrains IDE warmup runs during prebuilds. - `EnvironmentClassIDs []string` environment_class_ids specifies which environment classes should have prebuilds created. If empty, no prebuilds are created. - `Executor Subject` executor specifies who runs prebuilds for this project. The executor's SCM credentials are used to clone the repository. If not set, defaults to the project creator. - `Timeout string` timeout is the maximum duration allowed for a prebuild to complete. If not specified, defaults to 1 hour. Must be between 5 minutes and 2 hours. - `Trigger ProjectPrebuildConfigurationTrigger` trigger defines when prebuilds should be created. - `DailySchedule ProjectPrebuildConfigurationTriggerDailySchedule` daily_schedule triggers a prebuild once per day at the specified hour (UTC). The actual start time may vary slightly to distribute system load. - `HourUtc int64` hour_utc is the hour of day (0-23) in UTC when the prebuild should start. The actual start time may be adjusted by a few minutes to balance system load. - `RecommendedEditors RecommendedEditors` recommended_editors specifies the editors recommended for this project. - `Editors map[string, RecommendedEditorsEditor]` editors maps editor aliases to their recommended versions. Key is the editor alias (e.g., "intellij", "goland", "vscode"). Value contains the list of recommended versions for that editor. If versions list is empty, all available versions are recommended. Example: {"intellij": {versions: ["2025.1", "2024.3"]}, "goland": {}} - `Versions []string` versions is the list of recommended versions for this editor. If empty, all available versions are recommended. Examples for JetBrains: ["2025.1", "2024.3"] - `TechnicalDescription string` technical_description is a detailed technical description of the project This field is not returned by default in GetProject or ListProjects responses - `UsedBy ProjectUsedBy` - `Subjects []Subject` Subjects are the 10 most recent subjects who have used the project to create an environment - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `TotalSubjects int64` Total number of unique subjects who have used the project ### Example ```go package main import ( "context" "fmt" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) project, err := client.Projects.Get(context.TODO(), gitpod.ProjectGetParams{ ProjectID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", project.Project) } ``` #### Response ```json { "project": { "environmentClass": { "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "localRunner": true, "order": 0 }, "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "automationsFilePath": "automationsFilePath", "desiredPhase": "PROJECT_PHASE_UNSPECIFIED", "devcontainerFilePath": "devcontainerFilePath", "environmentClasses": [ { "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "localRunner": true, "order": 0 } ], "initializer": { "specs": [ { "contextUrl": { "url": "https://example.com" }, "git": { "checkoutLocation": "checkoutLocation", "cloneTarget": "cloneTarget", "remoteUri": "remoteUri", "targetMode": "CLONE_TARGET_MODE_UNSPECIFIED", "upstreamRemoteUri": "upstreamRemoteUri" } } ] }, "metadata": { "createdAt": "2019-12-27T18:11:19.117Z", "creator": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "name": "x", "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "updatedAt": "2019-12-27T18:11:19.117Z" }, "prebuildConfiguration": { "enabled": true, "enableJetbrainsWarmup": true, "environmentClassIds": [ "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" ], "executor": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "timeout": "+9125115.360s", "trigger": { "dailySchedule": { "hourUtc": 23 } } }, "recommendedEditors": { "editors": { "foo": { "versions": [ "string" ] } } }, "technicalDescription": "technicalDescription", "usedBy": { "subjects": [ { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" } ], "totalSubjects": 0 } } } ``` ## UpdateProject `client.Projects.Update(ctx, body) (*ProjectUpdateResponse, error)` **post** `/gitpod.v1.ProjectService/UpdateProject` Updates a project's configuration. Use this method to: - Modify project settings - Update environment class - Change project name - Configure initializers - Configure prebuild settings ### Examples - Update project name: Changes the project's display name. ```yaml projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" name: "New Project Name" ``` - Enable prebuilds with daily schedule: Configures prebuilds to run daily at 2 AM UTC. ```yaml projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" prebuildConfiguration: enabled: true environmentClassIds: - "b0e12f6c-4c67-429d-a4a6-d9838b5da041" timeout: "3600s" trigger: dailySchedule: hourUtc: 2 ``` ### Parameters - `body ProjectUpdateParams` - `AutomationsFilePath param.Field[string]` automations_file_path is the path to the automations file relative to the repo root path must not be absolute (start with a /): ``` this.matches('^$|^[^/].*') ``` - `DevcontainerFilePath param.Field[string]` devcontainer_file_path is the path to the devcontainer file relative to the repo root path must not be absolute (start with a /): ``` this.matches('^$|^[^/].*') ``` - `Initializer param.Field[EnvironmentInitializer]` initializer is the content initializer - `Name param.Field[string]` - `PrebuildConfiguration param.Field[ProjectPrebuildConfiguration]` prebuild_configuration defines how prebuilds are created for this project. If not provided, the existing prebuild configuration is not modified. To disable prebuilds, set enabled to false. - `ProjectID param.Field[string]` project_id specifies the project identifier - `RecommendedEditors param.Field[RecommendedEditors]` recommended_editors specifies the editors recommended for this project. If not provided, the existing recommended editors are not modified. To clear all recommended editors, set to an empty RecommendedEditors message. - `TechnicalDescription param.Field[string]` technical_description is a detailed technical description of the project This field is not returned by default in GetProject or ListProjects responses 8KB max ### Returns - `type ProjectUpdateResponse struct{…}` - `Project Project` - `EnvironmentClass ProjectEnvironmentClass` Use `environment_classes` instead. - `EnvironmentClassID string` Use a fixed environment class on a given Runner. This cannot be a local runner's environment class. - `LocalRunner bool` Use a local runner for the user - `Order int64` order is the priority of this entry - `ID string` id is the unique identifier for the project - `AutomationsFilePath string` automations_file_path is the path to the automations file relative to the repo root - `DesiredPhase ProjectPhase` desired_phase is the desired phase of the project When set to DELETED, the project is pending deletion - `const ProjectPhaseUnspecified ProjectPhase = "PROJECT_PHASE_UNSPECIFIED"` - `const ProjectPhaseActive ProjectPhase = "PROJECT_PHASE_ACTIVE"` - `const ProjectPhaseDeleted ProjectPhase = "PROJECT_PHASE_DELETED"` - `DevcontainerFilePath string` devcontainer_file_path is the path to the devcontainer file relative to the repo root - `EnvironmentClasses []ProjectEnvironmentClass` environment_classes is the list of environment classes for the project - `EnvironmentClassID string` Use a fixed environment class on a given Runner. This cannot be a local runner's environment class. - `LocalRunner bool` Use a local runner for the user - `Order int64` order is the priority of this entry - `Initializer EnvironmentInitializer` initializer is the content initializer - `Specs []EnvironmentInitializerSpec` - `ContextURL EnvironmentInitializerSpecsContextURL` - `URL string` url is the URL from which the environment is created - `Git EnvironmentInitializerSpecsGit` - `CheckoutLocation string` a path relative to the environment root in which the code will be checked out to - `CloneTarget string` the value for the clone target mode - use depends on the target mode - `RemoteUri string` remote_uri is the Git remote origin - `TargetMode EnvironmentInitializerSpecsGitTargetMode` the target mode determines what gets checked out - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeUnspecified EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_UNSPECIFIED"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteHead EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_HEAD"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteCommit EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_COMMIT"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeLocalBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_LOCAL_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteTag EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_TAG"` - `UpstreamRemoteUri string` upstream_Remote_uri is the fork upstream of a repository - `Metadata ProjectMetadata` - `CreatedAt Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `Creator Subject` creator is the identity of the project creator - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"` - `const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"` - `const PrincipalUser Principal = "PRINCIPAL_USER"` - `const PrincipalRunner Principal = "PRINCIPAL_RUNNER"` - `const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"` - `const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"` - `const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"` - `Name string` name is the human readable name of the project - `OrganizationID string` organization_id is the ID of the organization that contains the environment - `UpdatedAt Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `PrebuildConfiguration ProjectPrebuildConfiguration` prebuild_configuration defines how prebuilds are created for this project. - `Enabled bool` enabled controls whether prebuilds are created for this project. When disabled, no automatic prebuilds will be triggered. - `EnableJetbrainsWarmup bool` enable_jetbrains_warmup controls whether JetBrains IDE warmup runs during prebuilds. - `EnvironmentClassIDs []string` environment_class_ids specifies which environment classes should have prebuilds created. If empty, no prebuilds are created. - `Executor Subject` executor specifies who runs prebuilds for this project. The executor's SCM credentials are used to clone the repository. If not set, defaults to the project creator. - `Timeout string` timeout is the maximum duration allowed for a prebuild to complete. If not specified, defaults to 1 hour. Must be between 5 minutes and 2 hours. - `Trigger ProjectPrebuildConfigurationTrigger` trigger defines when prebuilds should be created. - `DailySchedule ProjectPrebuildConfigurationTriggerDailySchedule` daily_schedule triggers a prebuild once per day at the specified hour (UTC). The actual start time may vary slightly to distribute system load. - `HourUtc int64` hour_utc is the hour of day (0-23) in UTC when the prebuild should start. The actual start time may be adjusted by a few minutes to balance system load. - `RecommendedEditors RecommendedEditors` recommended_editors specifies the editors recommended for this project. - `Editors map[string, RecommendedEditorsEditor]` editors maps editor aliases to their recommended versions. Key is the editor alias (e.g., "intellij", "goland", "vscode"). Value contains the list of recommended versions for that editor. If versions list is empty, all available versions are recommended. Example: {"intellij": {versions: ["2025.1", "2024.3"]}, "goland": {}} - `Versions []string` versions is the list of recommended versions for this editor. If empty, all available versions are recommended. Examples for JetBrains: ["2025.1", "2024.3"] - `TechnicalDescription string` technical_description is a detailed technical description of the project This field is not returned by default in GetProject or ListProjects responses - `UsedBy ProjectUsedBy` - `Subjects []Subject` Subjects are the 10 most recent subjects who have used the project to create an environment - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `TotalSubjects int64` Total number of unique subjects who have used the project ### Example ```go package main import ( "context" "fmt" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) project, err := client.Projects.Update(context.TODO(), gitpod.ProjectUpdateParams{ PrebuildConfiguration: gitpod.F(gitpod.ProjectPrebuildConfigurationParam{ Enabled: gitpod.F(true), EnvironmentClassIDs: gitpod.F([]string{"b0e12f6c-4c67-429d-a4a6-d9838b5da041"}), Timeout: gitpod.F("3600s"), Trigger: gitpod.F(gitpod.ProjectPrebuildConfigurationTriggerParam{ DailySchedule: gitpod.F(gitpod.ProjectPrebuildConfigurationTriggerDailyScheduleParam{ HourUtc: gitpod.F(int64(2)), }), }), }), ProjectID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", project.Project) } ``` #### Response ```json { "project": { "environmentClass": { "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "localRunner": true, "order": 0 }, "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "automationsFilePath": "automationsFilePath", "desiredPhase": "PROJECT_PHASE_UNSPECIFIED", "devcontainerFilePath": "devcontainerFilePath", "environmentClasses": [ { "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "localRunner": true, "order": 0 } ], "initializer": { "specs": [ { "contextUrl": { "url": "https://example.com" }, "git": { "checkoutLocation": "checkoutLocation", "cloneTarget": "cloneTarget", "remoteUri": "remoteUri", "targetMode": "CLONE_TARGET_MODE_UNSPECIFIED", "upstreamRemoteUri": "upstreamRemoteUri" } } ] }, "metadata": { "createdAt": "2019-12-27T18:11:19.117Z", "creator": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "name": "x", "organizationId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "updatedAt": "2019-12-27T18:11:19.117Z" }, "prebuildConfiguration": { "enabled": true, "enableJetbrainsWarmup": true, "environmentClassIds": [ "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e" ], "executor": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" }, "timeout": "+9125115.360s", "trigger": { "dailySchedule": { "hourUtc": 23 } } }, "recommendedEditors": { "editors": { "foo": { "versions": [ "string" ] } } }, "technicalDescription": "technicalDescription", "usedBy": { "subjects": [ { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "principal": "PRINCIPAL_UNSPECIFIED" } ], "totalSubjects": 0 } } } ``` ## Domain Types ### Environment Initializer - `type EnvironmentInitializer struct{…}` EnvironmentInitializer specifies how an environment is to be initialized - `Specs []EnvironmentInitializerSpec` - `ContextURL EnvironmentInitializerSpecsContextURL` - `URL string` url is the URL from which the environment is created - `Git EnvironmentInitializerSpecsGit` - `CheckoutLocation string` a path relative to the environment root in which the code will be checked out to - `CloneTarget string` the value for the clone target mode - use depends on the target mode - `RemoteUri string` remote_uri is the Git remote origin - `TargetMode EnvironmentInitializerSpecsGitTargetMode` the target mode determines what gets checked out - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeUnspecified EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_UNSPECIFIED"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteHead EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_HEAD"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteCommit EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_COMMIT"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeLocalBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_LOCAL_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteTag EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_TAG"` - `UpstreamRemoteUri string` upstream_Remote_uri is the fork upstream of a repository ### Project - `type Project struct{…}` - `EnvironmentClass ProjectEnvironmentClass` Use `environment_classes` instead. - `EnvironmentClassID string` Use a fixed environment class on a given Runner. This cannot be a local runner's environment class. - `LocalRunner bool` Use a local runner for the user - `Order int64` order is the priority of this entry - `ID string` id is the unique identifier for the project - `AutomationsFilePath string` automations_file_path is the path to the automations file relative to the repo root - `DesiredPhase ProjectPhase` desired_phase is the desired phase of the project When set to DELETED, the project is pending deletion - `const ProjectPhaseUnspecified ProjectPhase = "PROJECT_PHASE_UNSPECIFIED"` - `const ProjectPhaseActive ProjectPhase = "PROJECT_PHASE_ACTIVE"` - `const ProjectPhaseDeleted ProjectPhase = "PROJECT_PHASE_DELETED"` - `DevcontainerFilePath string` devcontainer_file_path is the path to the devcontainer file relative to the repo root - `EnvironmentClasses []ProjectEnvironmentClass` environment_classes is the list of environment classes for the project - `EnvironmentClassID string` Use a fixed environment class on a given Runner. This cannot be a local runner's environment class. - `LocalRunner bool` Use a local runner for the user - `Order int64` order is the priority of this entry - `Initializer EnvironmentInitializer` initializer is the content initializer - `Specs []EnvironmentInitializerSpec` - `ContextURL EnvironmentInitializerSpecsContextURL` - `URL string` url is the URL from which the environment is created - `Git EnvironmentInitializerSpecsGit` - `CheckoutLocation string` a path relative to the environment root in which the code will be checked out to - `CloneTarget string` the value for the clone target mode - use depends on the target mode - `RemoteUri string` remote_uri is the Git remote origin - `TargetMode EnvironmentInitializerSpecsGitTargetMode` the target mode determines what gets checked out - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeUnspecified EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_UNSPECIFIED"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteHead EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_HEAD"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteCommit EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_COMMIT"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeLocalBranch EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_LOCAL_BRANCH"` - `const EnvironmentInitializerSpecsGitTargetModeCloneTargetModeRemoteTag EnvironmentInitializerSpecsGitTargetMode = "CLONE_TARGET_MODE_REMOTE_TAG"` - `UpstreamRemoteUri string` upstream_Remote_uri is the fork upstream of a repository - `Metadata ProjectMetadata` - `CreatedAt Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `Creator Subject` creator is the identity of the project creator - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"` - `const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"` - `const PrincipalUser Principal = "PRINCIPAL_USER"` - `const PrincipalRunner Principal = "PRINCIPAL_RUNNER"` - `const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"` - `const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"` - `const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"` - `Name string` name is the human readable name of the project - `OrganizationID string` organization_id is the ID of the organization that contains the environment - `UpdatedAt Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `PrebuildConfiguration ProjectPrebuildConfiguration` prebuild_configuration defines how prebuilds are created for this project. - `Enabled bool` enabled controls whether prebuilds are created for this project. When disabled, no automatic prebuilds will be triggered. - `EnableJetbrainsWarmup bool` enable_jetbrains_warmup controls whether JetBrains IDE warmup runs during prebuilds. - `EnvironmentClassIDs []string` environment_class_ids specifies which environment classes should have prebuilds created. If empty, no prebuilds are created. - `Executor Subject` executor specifies who runs prebuilds for this project. The executor's SCM credentials are used to clone the repository. If not set, defaults to the project creator. - `Timeout string` timeout is the maximum duration allowed for a prebuild to complete. If not specified, defaults to 1 hour. Must be between 5 minutes and 2 hours. - `Trigger ProjectPrebuildConfigurationTrigger` trigger defines when prebuilds should be created. - `DailySchedule ProjectPrebuildConfigurationTriggerDailySchedule` daily_schedule triggers a prebuild once per day at the specified hour (UTC). The actual start time may vary slightly to distribute system load. - `HourUtc int64` hour_utc is the hour of day (0-23) in UTC when the prebuild should start. The actual start time may be adjusted by a few minutes to balance system load. - `RecommendedEditors RecommendedEditors` recommended_editors specifies the editors recommended for this project. - `Editors map[string, RecommendedEditorsEditor]` editors maps editor aliases to their recommended versions. Key is the editor alias (e.g., "intellij", "goland", "vscode"). Value contains the list of recommended versions for that editor. If versions list is empty, all available versions are recommended. Example: {"intellij": {versions: ["2025.1", "2024.3"]}, "goland": {}} - `Versions []string` versions is the list of recommended versions for this editor. If empty, all available versions are recommended. Examples for JetBrains: ["2025.1", "2024.3"] - `TechnicalDescription string` technical_description is a detailed technical description of the project This field is not returned by default in GetProject or ListProjects responses - `UsedBy ProjectUsedBy` - `Subjects []Subject` Subjects are the 10 most recent subjects who have used the project to create an environment - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `TotalSubjects int64` Total number of unique subjects who have used the project ### Project Metadata - `type ProjectMetadata struct{…}` - `CreatedAt Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. - `Creator Subject` creator is the identity of the project creator - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"` - `const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"` - `const PrincipalUser Principal = "PRINCIPAL_USER"` - `const PrincipalRunner Principal = "PRINCIPAL_RUNNER"` - `const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"` - `const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"` - `const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"` - `Name string` name is the human readable name of the project - `OrganizationID string` organization_id is the ID of the organization that contains the environment - `UpdatedAt Time` A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings. # Examples Example 1: Compute Timestamp from POSIX `time()`. Timestamp timestamp; timestamp.set_seconds(time(NULL)); timestamp.set_nanos(0); Example 2: Compute Timestamp from POSIX `gettimeofday()`. struct timeval tv; gettimeofday(&tv, NULL); Timestamp timestamp; timestamp.set_seconds(tv.tv_sec); timestamp.set_nanos(tv.tv_usec * 1000); Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`. FILETIME ft; GetSystemTimeAsFileTime(&ft); UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime; // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z. Timestamp timestamp; timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL)); timestamp.set_nanos((INT32) ((ticks % 10000000) * 100)); Example 4: Compute Timestamp from Java `System.currentTimeMillis()`. long millis = System.currentTimeMillis(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000) .setNanos((int) ((millis % 1000) * 1000000)).build(); Example 5: Compute Timestamp from Java `Instant.now()`. Instant now = Instant.now(); Timestamp timestamp = Timestamp.newBuilder().setSeconds(now.getEpochSecond()) .setNanos(now.getNano()).build(); Example 6: Compute Timestamp from current time in Python. timestamp = Timestamp() timestamp.GetCurrentTime() # JSON Mapping In JSON format, the Timestamp type is encoded as a string in the [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z" where {year} is always expressed using four digits while {month}, {day}, {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution), are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone is required. A proto3 JSON serializer should always use UTC (as indicated by "Z") when printing the Timestamp type and a proto3 JSON parser should be able to accept both UTC and other timezones (as indicated by an offset). For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past 01:30 UTC on January 15, 2017. In JavaScript, one can convert a Date object to this format using the standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString) method. In Python, a standard `datetime.datetime` object can be converted to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use the Joda Time's [`ISODateTimeFormat.dateTime()`](http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime\(\)) to obtain a formatter capable of generating timestamps in this format. ### Project Phase - `type ProjectPhase string` - `const ProjectPhaseUnspecified ProjectPhase = "PROJECT_PHASE_UNSPECIFIED"` - `const ProjectPhaseActive ProjectPhase = "PROJECT_PHASE_ACTIVE"` - `const ProjectPhaseDeleted ProjectPhase = "PROJECT_PHASE_DELETED"` ### Project Prebuild Configuration - `type ProjectPrebuildConfiguration struct{…}` ProjectPrebuildConfiguration defines how prebuilds are created for a project. Prebuilds create environment snapshots that enable faster environment startup times. - `Enabled bool` enabled controls whether prebuilds are created for this project. When disabled, no automatic prebuilds will be triggered. - `EnableJetbrainsWarmup bool` enable_jetbrains_warmup controls whether JetBrains IDE warmup runs during prebuilds. - `EnvironmentClassIDs []string` environment_class_ids specifies which environment classes should have prebuilds created. If empty, no prebuilds are created. - `Executor Subject` executor specifies who runs prebuilds for this project. The executor's SCM credentials are used to clone the repository. If not set, defaults to the project creator. - `ID string` id is the UUID of the subject - `Principal Principal` Principal is the principal of the subject - `const PrincipalUnspecified Principal = "PRINCIPAL_UNSPECIFIED"` - `const PrincipalAccount Principal = "PRINCIPAL_ACCOUNT"` - `const PrincipalUser Principal = "PRINCIPAL_USER"` - `const PrincipalRunner Principal = "PRINCIPAL_RUNNER"` - `const PrincipalEnvironment Principal = "PRINCIPAL_ENVIRONMENT"` - `const PrincipalServiceAccount Principal = "PRINCIPAL_SERVICE_ACCOUNT"` - `const PrincipalRunnerManager Principal = "PRINCIPAL_RUNNER_MANAGER"` - `Timeout string` timeout is the maximum duration allowed for a prebuild to complete. If not specified, defaults to 1 hour. Must be between 5 minutes and 2 hours. - `Trigger ProjectPrebuildConfigurationTrigger` trigger defines when prebuilds should be created. - `DailySchedule ProjectPrebuildConfigurationTriggerDailySchedule` daily_schedule triggers a prebuild once per day at the specified hour (UTC). The actual start time may vary slightly to distribute system load. - `HourUtc int64` hour_utc is the hour of day (0-23) in UTC when the prebuild should start. The actual start time may be adjusted by a few minutes to balance system load. ### Recommended Editors - `type RecommendedEditors struct{…}` RecommendedEditors contains the map of recommended editors and their versions. - `Editors map[string, RecommendedEditorsEditor]` editors maps editor aliases to their recommended versions. Key is the editor alias (e.g., "intellij", "goland", "vscode"). Value contains the list of recommended versions for that editor. If versions list is empty, all available versions are recommended. Example: {"intellij": {versions: ["2025.1", "2024.3"]}, "goland": {}} - `Versions []string` versions is the list of recommended versions for this editor. If empty, all available versions are recommended. Examples for JetBrains: ["2025.1", "2024.3"] # Environment Clases ## ListProjectEnvironmentClasses `client.Projects.EnvironmentClases.List(ctx, params) (*ProjectEnvironmentClassesPage[ProjectEnvironmentClass], error)` **post** `/gitpod.v1.ProjectService/ListProjectEnvironmentClasses` Lists environment classes of a project. Use this method to: - View all environment classes of a project ### Examples - List project environment classes: Shows all environment classes of a project. ```yaml projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" pagination: pageSize: 20 ``` ### Parameters - `params ProjectEnvironmentClaseListParams` - `Token param.Field[string]` Query param - `PageSize param.Field[int64]` Query param - `Pagination param.Field[ProjectEnvironmentClaseListParamsPagination]` Body param: pagination contains the pagination options for listing project policies - `Token string` Token for the next set of results that was returned as next_token of a PaginationResponse - `PageSize int64` Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100. - `ProjectID param.Field[string]` Body param: project_id specifies the project identifier ### Returns - `type ProjectEnvironmentClass struct{…}` - `EnvironmentClassID string` Use a fixed environment class on a given Runner. This cannot be a local runner's environment class. - `LocalRunner bool` Use a local runner for the user - `Order int64` order is the priority of this entry ### Example ```go package main import ( "context" "fmt" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) page, err := client.Projects.EnvironmentClases.List(context.TODO(), gitpod.ProjectEnvironmentClaseListParams{ Pagination: gitpod.F(gitpod.ProjectEnvironmentClaseListParamsPagination{ PageSize: gitpod.F(int64(20)), }), ProjectID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "pagination": { "nextToken": "nextToken" }, "projectEnvironmentClasses": [ { "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "localRunner": true, "order": 0 } ] } ``` ## UpdateProjectEnvironmentClasses `client.Projects.EnvironmentClases.Update(ctx, body) (*ProjectEnvironmentClaseUpdateResponse, error)` **post** `/gitpod.v1.ProjectService/UpdateProjectEnvironmentClasses` Updates all environment classes of a project. Use this method to: - Modify all environment classea of a project ### Examples - Update project environment classes: Updates all environment classes for a project. ```yaml projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" projectEnvironmentClasses: - environmentClassId: "b0e12f6c-4c67-429d-a4a6-d9838b5da041" order: 0 - localRunner: true order: 1 ``` ### Parameters - `body ProjectEnvironmentClaseUpdateParams` - `ProjectEnvironmentClasses param.Field[[]ProjectEnvironmentClass]` - `EnvironmentClassID string` Use a fixed environment class on a given Runner. This cannot be a local runner's environment class. - `LocalRunner bool` Use a local runner for the user - `Order int64` order is the priority of this entry - `ProjectID param.Field[string]` project_id specifies the project identifier ### Returns - `type ProjectEnvironmentClaseUpdateResponse interface{…}` ### Example ```go package main import ( "context" "fmt" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" "github.com/gitpod-io/gitpod-sdk-go/shared" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) environmentClase, err := client.Projects.EnvironmentClases.Update(context.TODO(), gitpod.ProjectEnvironmentClaseUpdateParams{ ProjectEnvironmentClasses: gitpod.F([]shared.ProjectEnvironmentClassParam{shared.ProjectEnvironmentClassParam{ EnvironmentClassID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da041"), Order: gitpod.F(int64(0)), }, shared.ProjectEnvironmentClassParam{ LocalRunner: gitpod.F(true), Order: gitpod.F(int64(1)), }}), ProjectID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", environmentClase) } ``` #### Response ```json {} ``` # Policies ## CreateProjectPolicy `client.Projects.Policies.New(ctx, body) (*ProjectPolicyNewResponse, error)` **post** `/gitpod.v1.ProjectService/CreateProjectPolicy` Creates a new policy for a project. Use this method to: - Set up access controls - Define group permissions - Configure role-based access ### Examples - Create admin policy: Grants admin access to a group. ```yaml projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" groupId: "f53d2330-3795-4c5d-a1f3-453121af9c60" role: PROJECT_ROLE_ADMIN ``` ### Parameters - `body ProjectPolicyNewParams` - `GroupID param.Field[string]` group_id specifies the group_id identifier - `ProjectID param.Field[string]` project_id specifies the project identifier - `Role param.Field[ProjectRole]` ### Returns - `type ProjectPolicyNewResponse struct{…}` - `Policy ProjectPolicy` - `GroupID string` - `Role ProjectRole` role is the role assigned to the group - `const ProjectRoleUnspecified ProjectRole = "PROJECT_ROLE_UNSPECIFIED"` - `const ProjectRoleAdmin ProjectRole = "PROJECT_ROLE_ADMIN"` - `const ProjectRoleUser ProjectRole = "PROJECT_ROLE_USER"` - `const ProjectRoleEditor ProjectRole = "PROJECT_ROLE_EDITOR"` ### Example ```go package main import ( "context" "fmt" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) policy, err := client.Projects.Policies.New(context.TODO(), gitpod.ProjectPolicyNewParams{ GroupID: gitpod.F("f53d2330-3795-4c5d-a1f3-453121af9c60"), ProjectID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"), Role: gitpod.F(gitpod.ProjectRoleAdmin), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", policy.Policy) } ``` #### Response ```json { "policy": { "groupId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "role": "PROJECT_ROLE_UNSPECIFIED" } } ``` ## DeleteProjectPolicy `client.Projects.Policies.Delete(ctx, body) (*ProjectPolicyDeleteResponse, error)` **post** `/gitpod.v1.ProjectService/DeleteProjectPolicy` Deletes a project policy. Use this method to: - Remove access controls - Revoke permissions - Clean up policies ### Examples - Delete policy: Removes a group's access policy. ```yaml projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" groupId: "f53d2330-3795-4c5d-a1f3-453121af9c60" ``` ### Parameters - `body ProjectPolicyDeleteParams` - `GroupID param.Field[string]` group_id specifies the group_id identifier - `ProjectID param.Field[string]` project_id specifies the project identifier ### Returns - `type ProjectPolicyDeleteResponse interface{…}` ### Example ```go package main import ( "context" "fmt" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) policy, err := client.Projects.Policies.Delete(context.TODO(), gitpod.ProjectPolicyDeleteParams{ GroupID: gitpod.F("f53d2330-3795-4c5d-a1f3-453121af9c60"), ProjectID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", policy) } ``` #### Response ```json {} ``` ## ListProjectPolicies `client.Projects.Policies.List(ctx, params) (*PoliciesPage[ProjectPolicy], error)` **post** `/gitpod.v1.ProjectService/ListProjectPolicies` Lists policies for a project. Use this method to: - View access controls - Check policy configurations - Audit permissions ### Examples - List policies: Shows all policies for a project. ```yaml projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" pagination: pageSize: 20 ``` ### Parameters - `params ProjectPolicyListParams` - `Token param.Field[string]` Query param - `PageSize param.Field[int64]` Query param - `Pagination param.Field[ProjectPolicyListParamsPagination]` Body param: pagination contains the pagination options for listing project policies - `Token string` Token for the next set of results that was returned as next_token of a PaginationResponse - `PageSize int64` Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100. - `ProjectID param.Field[string]` Body param: project_id specifies the project identifier ### Returns - `type ProjectPolicy struct{…}` - `GroupID string` - `Role ProjectRole` role is the role assigned to the group - `const ProjectRoleUnspecified ProjectRole = "PROJECT_ROLE_UNSPECIFIED"` - `const ProjectRoleAdmin ProjectRole = "PROJECT_ROLE_ADMIN"` - `const ProjectRoleUser ProjectRole = "PROJECT_ROLE_USER"` - `const ProjectRoleEditor ProjectRole = "PROJECT_ROLE_EDITOR"` ### Example ```go package main import ( "context" "fmt" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) page, err := client.Projects.Policies.List(context.TODO(), gitpod.ProjectPolicyListParams{ Pagination: gitpod.F(gitpod.ProjectPolicyListParamsPagination{ PageSize: gitpod.F(int64(20)), }), ProjectID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", page) } ``` #### Response ```json { "pagination": { "nextToken": "nextToken" }, "policies": [ { "groupId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "role": "PROJECT_ROLE_UNSPECIFIED" } ] } ``` ## UpdateProjectPolicy `client.Projects.Policies.Update(ctx, body) (*ProjectPolicyUpdateResponse, error)` **post** `/gitpod.v1.ProjectService/UpdateProjectPolicy` Updates an existing project policy. Use this method to: - Modify access levels - Change group roles - Update permissions ### Examples - Update policy role: Changes a group's access level. ```yaml projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047" groupId: "f53d2330-3795-4c5d-a1f3-453121af9c60" role: PROJECT_ROLE_EDITOR ``` ### Parameters - `body ProjectPolicyUpdateParams` - `GroupID param.Field[string]` group_id specifies the group_id identifier - `ProjectID param.Field[string]` project_id specifies the project identifier - `Role param.Field[ProjectRole]` ### Returns - `type ProjectPolicyUpdateResponse struct{…}` - `Policy ProjectPolicy` - `GroupID string` - `Role ProjectRole` role is the role assigned to the group - `const ProjectRoleUnspecified ProjectRole = "PROJECT_ROLE_UNSPECIFIED"` - `const ProjectRoleAdmin ProjectRole = "PROJECT_ROLE_ADMIN"` - `const ProjectRoleUser ProjectRole = "PROJECT_ROLE_USER"` - `const ProjectRoleEditor ProjectRole = "PROJECT_ROLE_EDITOR"` ### Example ```go package main import ( "context" "fmt" "github.com/gitpod-io/gitpod-sdk-go" "github.com/gitpod-io/gitpod-sdk-go/option" ) func main() { client := gitpod.NewClient( option.WithBearerToken("My Bearer Token"), ) policy, err := client.Projects.Policies.Update(context.TODO(), gitpod.ProjectPolicyUpdateParams{ GroupID: gitpod.F("f53d2330-3795-4c5d-a1f3-453121af9c60"), ProjectID: gitpod.F("b0e12f6c-4c67-429d-a4a6-d9838b5da047"), Role: gitpod.F(gitpod.ProjectRoleEditor), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", policy.Policy) } ``` #### Response ```json { "policy": { "groupId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "role": "PROJECT_ROLE_UNSPECIFIED" } } ``` ## Domain Types ### Project Policy - `type ProjectPolicy struct{…}` - `GroupID string` - `Role ProjectRole` role is the role assigned to the group - `const ProjectRoleUnspecified ProjectRole = "PROJECT_ROLE_UNSPECIFIED"` - `const ProjectRoleAdmin ProjectRole = "PROJECT_ROLE_ADMIN"` - `const ProjectRoleUser ProjectRole = "PROJECT_ROLE_USER"` - `const ProjectRoleEditor ProjectRole = "PROJECT_ROLE_EDITOR"` ### Project Role - `type ProjectRole string` - `const ProjectRoleUnspecified ProjectRole = "PROJECT_ROLE_UNSPECIFIED"` - `const ProjectRoleAdmin ProjectRole = "PROJECT_ROLE_ADMIN"` - `const ProjectRoleUser ProjectRole = "PROJECT_ROLE_USER"` - `const ProjectRoleEditor ProjectRole = "PROJECT_ROLE_EDITOR"`