Notebooks API (notebooks:v2)

Additions

Methods


• ▼ ▲ notebooks.projects.locations.instances.checkUpgradability

  Path: v2/{+notebookInstance}:checkUpgradability

  Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:checkUpgradability

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

  Parameter Order: notebookInstance

  Parameters:

  notebookInstance

  Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$

  Required: Yes

  Description: Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

  Type: string

  Location: path

  HTTP Method: GET

  Description: Checks whether a notebook instance is upgradable.

• ▼ ▲ notebooks.projects.locations.instances.get

  Path: v2/{+name}

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

  Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}

  Parameters:

  name

  Required: Yes

  Location: path

  Type: string

  Description: Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

  Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$

  Parameter Order: name

  Description: Gets details of a single Instance.

  HTTP Method: GET

• ▼ ▲ notebooks.projects.locations.instances.start

  HTTP Method: POST

  Parameter Order: name

  Path: v2/{+name}:start

  Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:start

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

  Parameters:

  name

  Location: path

  Description: Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

  Type: string

  Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$

  Required: Yes

  Description: Starts a notebook instance.

• ▼ ▲ notebooks.projects.locations.instances.delete

  Description: Deletes a single Instance.

  Parameters:

  requestId

  Description: Optional. Idempotent request UUID.

  Type: string

  Location: query

  name

  Required: Yes

  Location: path

  Type: string

  Description: Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

  Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$

  Path: v2/{+name}

  Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}

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

  HTTP Method: DELETE

  Parameter Order: name

• ▼ ▲ notebooks.projects.locations.instances.create

  Description: Creates a new Instance in a given project and location.

  Parameters:

  requestId

  Description: Optional. Idempotent request UUID.

  Location: query

  Type: string

  parent

  Type: string

  Required: Yes

  Location: path

  Pattern: ^projects/[^/]+/locations/[^/]+$

  Description: Required. Format: `parent=projects/{project_id}/locations/{location}`

  instanceId

  Location: query

  Description: Required. User-defined unique ID of this instance.

  Type: string

  Path: v2/{+parent}/instances

  HTTP Method: POST

  Parameter Order: parent

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

  Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances

• ▼ ▲ notebooks.projects.locations.instances.upgradeSystem

  HTTP Method: POST

  Description: Allows notebook instances to upgrade themselves. Do not use this method directly.

  Path: v2/{+name}:upgradeSystem

  Parameter Order: name

  Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:upgradeSystem

  Parameters:

  name

  Location: path

  Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$

  Description: Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

  Required: Yes

  Type: string

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

• ▼ ▲ notebooks.projects.locations.instances.diagnose

  Parameters:

  name

  Description: Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

  Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$

  Type: string

  Required: Yes

  Location: path

  Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:diagnose

  Parameter Order: name

  Description: Creates a Diagnostic File and runs Diagnostic Tool given an Instance.

  Path: v2/{+name}:diagnose

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

  HTTP Method: POST

• ▼ ▲ notebooks.projects.locations.instances.stop

  Parameters:

  name

  Required: Yes

  Location: path

  Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$

  Description: Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

  Type: string

  Parameter Order: name

  Description: Stops a notebook instance.

  Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:stop

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

  Path: v2/{+name}:stop

  HTTP Method: POST

• ▼ ▲ notebooks.projects.locations.instances.patch

  HTTP Method: PATCH

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

  Parameter Order: name

  Parameters:

  requestId

  Type: string

  Location: query

  Description: Optional. Idempotent request UUID.

  updateMask

  Location: query

  Type: string

  Format: google-fieldmask

  Description: Required. Mask used to update an instance

  name

  Description: Output only. The name of this notebook instance. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

  Location: path

  Required: Yes

  Type: string

  Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$

  Description: UpdateInstance updates an Instance.

  Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}

  Path: v2/{+name}

• ▼ ▲ notebooks.projects.locations.instances.list

  Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances

  Path: v2/{+parent}/instances

  Description: Lists instances in a given project and location.

  HTTP Method: GET

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

  Parameters:

  pageSize

  Format: int32

  Type: integer

  Description: Optional. Maximum return size of the list call.

  Location: query

  parent

  Pattern: ^projects/[^/]+/locations/[^/]+$

  Type: string

  Location: path

  Description: Required. Format: `parent=projects/{project_id}/locations/{location}`

  Required: Yes

  pageToken

  Description: Optional. A previous returned page token that can be used to continue listing from the last result.

  Location: query

  Type: string

  Parameter Order: parent

• ▼ ▲ notebooks.projects.locations.instances.reset

  Parameter Order: name

  Parameters:

  name

  Location: path

  Description: Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

  Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$

  Type: string

  Required: Yes

  Description: Resets a notebook instance.

  Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:reset

  HTTP Method: POST

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

  Path: v2/{+name}:reset

• ▼ ▲ notebooks.projects.locations.instances.reportInfoSystem

  Parameter Order: name

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

  Path: v2/{+name}:reportInfoSystem

  Parameters:

  name

  Required: Yes

  Location: path

  Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$

  Type: string

  Description: Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

  Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:reportInfoSystem

  Description: Allows notebook instances to report their latest instance information to the Notebooks API server. The server will merge the reported information to the instance metadata store. Do not use this method directly.

  HTTP Method: POST

• ▼ ▲ notebooks.projects.locations.instances.upgrade

  Description: Upgrades a notebook instance to the latest version.

  HTTP Method: POST

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

  Parameter Order: name

  Path: v2/{+name}:upgrade

  Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:upgrade

  Parameters:

  name

  Required: Yes

  Location: path

  Type: string

  Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$

  Description: Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

• ▼ ▲ notebooks.projects.locations.instances.rollback

  Path: v2/{+name}:rollback

  Parameter Order: name

  Parameters:

  name

  Pattern: ^projects/[^/]+/locations/[^/]+/instances/[^/]+$

  Description: Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`

  Type: string

  Required: Yes

  Location: path

  Flat Path: v2/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:rollback

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

  HTTP Method: POST

  Description: Rollbacks a notebook instance to the previous version.