ListProjectEnvironmentClasses

client.projects.environmentClases.list(, ?): ProjectEnvironmentClassesPage<ProjectEnvironmentClass { environmentClassId, localRunner, order } >

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

params: EnvironmentClaseListParams { token, pageSize, pagination, projectId }

token?: string

Query param

pageSize?: number

Query param

maximum100

minimum0

pagination?: Pagination

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?: number

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

formatint32

maximum100

projectId?: string

Body param: project_id specifies the project identifier

formatuuid

ReturnsExpand Collapse

ProjectEnvironmentClass { environmentClassId, localRunner, order }

environmentClassId?: string

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

formatuuid

localRunner?: boolean

Use a local runner for the user

order?: number

order is the priority of this entry

formatint32

ListProjectEnvironmentClasses

import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const projectEnvironmentClass of client.projects.environmentClases.list({
  pagination: { pageSize: 20 },
  projectId: 'b0e12f6c-4c67-429d-a4a6-d9838b5da047',
})) {
  console.log(projectEnvironmentClass.environmentClassId);
}

{
  "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
    }
  ]
}