Skip to content
Ona Docs

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.

    projectId: "b0e12f6c-4c67-429d-a4a6-d9838b5da047"
    projectEnvironmentClasses:
      - environmentClassId: "b0e12f6c-4c67-429d-a4a6-d9838b5da041"
        order: 0
      - localRunner: true
        order: 1
ParametersExpand Collapse
body ProjectEnvironmentClaseUpdateParams
ProjectEnvironmentClasses param.Field[[]ProjectEnvironmentClass]Optional
EnvironmentClassID stringOptional

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

formatuuid
LocalRunner boolOptional

Use a local runner for the user

Order int64Optional

order is the priority of this entry

formatint32
ProjectID param.Field[string]Optional

project_id specifies the project identifier

formatuuid
ReturnsExpand Collapse
type ProjectEnvironmentClaseUpdateResponse interface{…}

UpdateProjectEnvironmentClasses

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)
}
{}
Returns Examples
{}