Method: projects.locations.runtimes.migrate

Migrate an existing Runtime to a new Workbench Instance.

HTTP request

POST https://notebooks.googleapis.com/v1/{name}:migrate

Path parameters

Parameters
name

string

Required. Format: projects/{projectId}/locations/{location}/runtimes/{runtimeId}

Authorization requires one or more of the following IAM permissions on the specified resource name:

  • notebooks.runtimes.get
  • notebooks.instances.create

Request body

The request body contains data with the following structure:

JSON representation 
{
  "network": string,
  "subnet": string,
  "serviceAccount": string,
  "requestId": string,
  "postStartupScriptOption": enum (PostStartupScriptOption)
}
Fields
network

string

Optional. Name of the VPC that the new Instance is in. This is required if the Runtime uses google-managed network. If the Runtime uses customer-owned network, it will reuse the same VPC, and this field must be empty. Format: projects/{projectId}/global/networks/{network_id}
subnet

string

Optional. Name of the subnet that the new Instance is in. This is required if the Runtime uses google-managed network. If the Runtime uses customer-owned network, it will reuse the same subnet, and this field must be empty. Format: projects/{projectId}/regions/{region}/subnetworks/{subnetwork_id}
serviceAccount

string

Optional. The service account to be included in the Compute Engine instance of the new Workbench Instance when the Runtime uses "single user only" mode for permission. If not specified, the Compute Engine default service account is used. When the Runtime uses service account mode for permission, it will reuse the same service account, and this field must be empty.
requestId

string

Optional. Idempotent request UUID.
postStartupScriptOption

enum (PostStartupScriptOption)

Optional. Specifies the behavior of post startup script during migration.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

PostStartupScriptOption

Specifies the behavior of post startup script during migration.

Enums
POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED Post startup script option is not specified. Default is POST_STARTUP_SCRIPT_OPTION_SKIP.
POST_STARTUP_SCRIPT_OPTION_SKIP Not migrate the post startup script to the new Workbench Instance.
POST_STARTUP_SCRIPT_OPTION_RERUN Redownload and rerun the same post startup script as the Google-Managed Notebook.