DeleteWarmPool

client.Prebuilds.DeleteWarmPool(ctx, body) (*PrebuildDeleteWarmPoolResponse, error)

POST/gitpod.v1.PrebuildService/DeleteWarmPool

Deletes a warm pool.

Deletion is processed asynchronously. The pool is marked for deletion and the runner drains instances in the background.

Warm pools are also automatically deleted when prebuilds are disabled on the project or the environment class is removed from the prebuild configuration.

Examples

Delete warm pool:

warmPoolId: "a1b2c3d4-5678-9abc-def0-1234567890ab"

ParametersExpand Collapse

body PrebuildDeleteWarmPoolParams

WarmPoolID param.Field[string]

warm_pool_id specifies the warm pool to delete

formatuuid

ReturnsExpand Collapse

type PrebuildDeleteWarmPoolResponse interface{…}

DeleteWarmPool

package main

import (
  "context"
  "fmt"

  "github.com/gitpod-io/gitpod-sdk-go"
  "github.com/gitpod-io/gitpod-sdk-go/option"
)

func main() {
  client := gitpod.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  response, err := client.Prebuilds.DeleteWarmPool(context.TODO(), gitpod.PrebuildDeleteWarmPoolParams{
    WarmPoolID: gitpod.F("a1b2c3d4-5678-9abc-def0-1234567890ab"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response)
}

{}

Returns Examples

{}