UpdateProjectEnvironmentClasses

client.projects.environmentClases.update(, ?): EnvironmentClaseUpdateResponse

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

body: EnvironmentClaseUpdateParams { projectEnvironmentClasses, projectId }

projectEnvironmentClasses?: Array<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

projectId?: string

project_id specifies the project identifier

formatuuid

ReturnsExpand Collapse

EnvironmentClaseUpdateResponse = unknown

UpdateProjectEnvironmentClasses

import Gitpod from '@gitpod/sdk';

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

const environmentClase = await client.projects.environmentClases.update({
  projectEnvironmentClasses: [
    { environmentClassId: 'b0e12f6c-4c67-429d-a4a6-d9838b5da041', order: 0 },
    { localRunner: true, order: 1 },
  ],
  projectId: 'b0e12f6c-4c67-429d-a4a6-d9838b5da047',
});

console.log(environmentClase);

{}

Returns Examples

{}