UpdateProjectEnvironmentClasses

projects.environment_clases.update() -> object

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.

projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
projectEnvironmentClasses:
  - environmentClassId: "b0e12f6c-4c67-429d-a4a6-d9838b5da041"
    order: 0
  - localRunner: true
    order: 1

ParametersExpand Collapse

project_environment_classes: Optional[Iterable[ProjectEnvironmentClass]]

environment_class_id: Optional[str]

Use a fixed environment class on a given Runner. This cannot be a local runner’s environment class.

formatuuid

local_runner: Optional[bool]

Use a local runner for the user

order: Optional[int]

order is the priority of this entry

formatint32

project_id: Optional[str]

project_id specifies the project identifier

formatuuid

ReturnsExpand Collapse

object

UpdateProjectEnvironmentClasses

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
environment_clase = client.projects.environment_clases.update(
    project_environment_classes=[{
        "environment_class_id": "b0e12f6c-4c67-429d-a4a6-d9838b5da041",
        "order": 0,
    }, {
        "local_runner": True,
        "order": 1,
    }],
    project_id="b0e12f6c-4c67-429d-a4a6-d9838b5da047",
)
print(environment_clase)

{}

Returns Examples

{}