ListProjectEnvironmentClasses

projects.environment_clases.list() -> SyncProjectEnvironmentClassesPage[ProjectEnvironmentClass]

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.

projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
pagination:
  pageSize: 20

ParametersExpand Collapse

token: Optional[str]

page_size: Optional[int]

maximum100

minimum0

pagination: Optional[Pagination]

pagination contains the pagination options for listing project policies

token: Optional[str]

Token for the next set of results that was returned as next_token of a PaginationResponse

page_size: Optional[int]

Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100.

formatint32

maximum100

project_id: Optional[str]

project_id specifies the project identifier

formatuuid

ReturnsExpand Collapse

class 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

ListProjectEnvironmentClasses

import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
page = client.projects.environment_clases.list(
    pagination={
        "page_size": 20
    },
    project_id="b0e12f6c-4c67-429d-a4a6-d9838b5da047",
)
page = page.project_environment_classes[0]
print(page.environment_class_id)

{
  "pagination": {
    "nextToken": "nextToken"
  },
  "projectEnvironmentClasses": [
    {
      "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "localRunner": true,
      "order": 0
    }
  ]
}

Returns Examples

{
  "pagination": {
    "nextToken": "nextToken"
  },
  "projectEnvironmentClasses": [
    {
      "environmentClassId": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "localRunner": true,
      "order": 0
    }
  ]
}