notebook_runtimes

Creates, updates, deletes, gets or lists a notebook_runtimes resource.

Overview

Name	notebook_runtimes
Type	Resource
Id	google.aiplatform.notebook_runtimes

Fields

Name	Datatype	Description
name	string	Output only. The resource name of the NotebookRuntime.
description	string	The description of the NotebookRuntime.
createTime	string	Output only. Timestamp when this NotebookRuntime was created.
displayName	string	Required. The display name of the NotebookRuntime. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpec	object	Represents a customer-managed encryption key spec that can be applied to a top-level resource.
expirationTime	string	Output only. Timestamp when this NotebookRuntime will be expired: 1. System Predefined NotebookRuntime: 24 hours after creation. After expiration, system predifined runtime will be deleted. 2. User created NotebookRuntime: 6 months after last upgrade. After expiration, user created runtime will be stopped and allowed for upgrade.
healthState	string	Output only. The health state of the NotebookRuntime.
idleShutdownConfig	object	The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field.
isUpgradable	boolean	Output only. Whether NotebookRuntime is upgradable.
labels	object	The labels with user-defined metadata to organize your NotebookRuntime. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime: "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id. "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex.
networkTags	array	Optional. The Compute Engine tags to add to runtime (see Tagging instances).
notebookRuntimeTemplateRef	object	Points to a NotebookRuntimeTemplateRef.
notebookRuntimeType	string	Output only. The type of the notebook runtime.
proxyUri	string	Output only. The proxy endpoint used to access the NotebookRuntime.
runtimeState	string	Output only. The runtime (instance) state of the NotebookRuntime.
runtimeUser	string	Required. The user email of the NotebookRuntime.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
serviceAccount	string	Output only. The service account that the NotebookRuntime workload runs as.
updateTime	string	Output only. Timestamp when this NotebookRuntime was most recently updated.
version	string	Output only. The VM os image version of NotebookRuntime.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	locationsId, notebookRuntimesId, projectsId	Gets a NotebookRuntime.
list	SELECT	locationsId, projectsId	Lists NotebookRuntimes in a Location.
delete	DELETE	locationsId, notebookRuntimesId, projectsId	Deletes a NotebookRuntime.
assign	EXEC	locationsId, projectsId	Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.
start	EXEC	locationsId, notebookRuntimesId, projectsId	Starts a NotebookRuntime.
upgrade	EXEC	locationsId, notebookRuntimesId, projectsId	Upgrades a NotebookRuntime.

SELECT examples

Lists NotebookRuntimes in a Location.

SELECT
name,
description,
createTime,
displayName,
encryptionSpec,
expirationTime,
healthState,
idleShutdownConfig,
isUpgradable,
labels,
networkTags,
notebookRuntimeTemplateRef,
notebookRuntimeType,
proxyUri,
runtimeState,
runtimeUser,
satisfiesPzi,
satisfiesPzs,
serviceAccount,
updateTime,
version
FROM google.aiplatform.notebook_runtimes
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

DELETE example

Deletes the specified notebook_runtimes resource.

/*+ delete */
DELETE FROM google.aiplatform.notebook_runtimes
WHERE locationsId = '{{ locationsId }}'
AND notebookRuntimesId = '{{ notebookRuntimesId }}'
AND projectsId = '{{ projectsId }}';