notebook_runtimes

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

Overview

Name	notebook_runtimes
Type	Resource
Id	google.aiplatform.notebook_runtimes

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the NotebookRuntime.
createTime	string (google-datetime)	Output only. Timestamp when this NotebookRuntime was created.
dataPersistentDiskSpec	object	Output only. The specification of persistent disk attached to the notebook runtime as data disk storage. (id: GoogleCloudAiplatformV1PersistentDiskSpec)
description	string	The description of the NotebookRuntime.
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	Output only. Customer-managed encryption key spec for the notebook runtime. (id: GoogleCloudAiplatformV1EncryptionSpec)
eucConfig	object	Output only. EUC configuration of the notebook runtime. (id: GoogleCloudAiplatformV1NotebookEucConfig)
expirationTime	string (google-datetime)	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	Output only. The idle shutdown configuration of the notebook runtime. (id: GoogleCloudAiplatformV1NotebookIdleShutdownConfig)
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.
machineSpec	object	Output only. The specification of a single machine used by the notebook runtime. (id: GoogleCloudAiplatformV1MachineSpec)
networkSpec	object	Output only. Network spec of the notebook runtime. (id: GoogleCloudAiplatformV1NetworkSpec)
networkTags	array	Optional. The Compute Engine tags to add to runtime (see Tagging instances).
notebookRuntimeTemplateRef	object	Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from. (id: GoogleCloudAiplatformV1NotebookRuntimeTemplateRef)
notebookRuntimeType	string	Output only. The type of the notebook runtime.
proxyUri	string	Output only. The proxy endpoint used to access the NotebookRuntime.
reservationAffinity	object	Output only. Reservation Affinity of the notebook runtime. (id: GoogleCloudAiplatformV1NotebookReservationAffinity)
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. Deprecated: This field is no longer used and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. The service account that the NotebookRuntime workload runs as.
shieldedVmConfig	object	Output only. Runtime Shielded VM spec. (id: GoogleCloudAiplatformV1ShieldedVmConfig)
softwareConfig	object	Output only. Software config of the notebook runtime. (id: GoogleCloudAiplatformV1NotebookSoftwareConfig)
updateTime	string (google-datetime)	Output only. Timestamp when this NotebookRuntime was most recently updated.
version	string	Output only. The VM os image version of NotebookRuntime.

list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the NotebookRuntime.
createTime	string (google-datetime)	Output only. Timestamp when this NotebookRuntime was created.
dataPersistentDiskSpec	object	Output only. The specification of persistent disk attached to the notebook runtime as data disk storage. (id: GoogleCloudAiplatformV1PersistentDiskSpec)
description	string	The description of the NotebookRuntime.
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	Output only. Customer-managed encryption key spec for the notebook runtime. (id: GoogleCloudAiplatformV1EncryptionSpec)
eucConfig	object	Output only. EUC configuration of the notebook runtime. (id: GoogleCloudAiplatformV1NotebookEucConfig)
expirationTime	string (google-datetime)	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	Output only. The idle shutdown configuration of the notebook runtime. (id: GoogleCloudAiplatformV1NotebookIdleShutdownConfig)
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.
machineSpec	object	Output only. The specification of a single machine used by the notebook runtime. (id: GoogleCloudAiplatformV1MachineSpec)
networkSpec	object	Output only. Network spec of the notebook runtime. (id: GoogleCloudAiplatformV1NetworkSpec)
networkTags	array	Optional. The Compute Engine tags to add to runtime (see Tagging instances).
notebookRuntimeTemplateRef	object	Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from. (id: GoogleCloudAiplatformV1NotebookRuntimeTemplateRef)
notebookRuntimeType	string	Output only. The type of the notebook runtime.
proxyUri	string	Output only. The proxy endpoint used to access the NotebookRuntime.
reservationAffinity	object	Output only. Reservation Affinity of the notebook runtime. (id: GoogleCloudAiplatformV1NotebookReservationAffinity)
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. Deprecated: This field is no longer used and the "Vertex AI Notebook Service Account" (service-PROJECT_NUMBER@gcp-sa-aiplatform-vm.iam.gserviceaccount.com) is used for the runtime workload identity. See https://cloud.google.com/iam/docs/service-agents#vertex-ai-notebook-service-account for more details. The service account that the NotebookRuntime workload runs as.
shieldedVmConfig	object	Output only. Runtime Shielded VM spec. (id: GoogleCloudAiplatformV1ShieldedVmConfig)
softwareConfig	object	Output only. Software config of the notebook runtime. (id: GoogleCloudAiplatformV1NotebookSoftwareConfig)
updateTime	string (google-datetime)	Output only. Timestamp when this NotebookRuntime was most recently updated.
version	string	Output only. The VM os image version of NotebookRuntime.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, notebookRuntimesId		Gets a NotebookRuntime.
list	select	projectsId, locationsId	filter, pageSize, pageToken, readMask, orderBy	Lists NotebookRuntimes in a Location.
delete	delete	projectsId, locationsId, notebookRuntimesId		Deletes a NotebookRuntime.
assign	exec	projectsId, locationsId		Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.
upgrade	exec	projectsId, locationsId, notebookRuntimesId		Upgrades a NotebookRuntime.
start	exec	projectsId, locationsId, notebookRuntimesId		Starts a NotebookRuntime.
stop	exec	projectsId, locationsId, notebookRuntimesId		Stops a NotebookRuntime.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
notebookRuntimesId	string
projectsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
readMask	string (google-fieldmask)

SELECT examples

get

Gets a NotebookRuntime.

SELECT
name,
createTime,
dataPersistentDiskSpec,
description,
displayName,
encryptionSpec,
eucConfig,
expirationTime,
healthState,
idleShutdownConfig,
isUpgradable,
labels,
machineSpec,
networkSpec,
networkTags,
notebookRuntimeTemplateRef,
notebookRuntimeType,
proxyUri,
reservationAffinity,
runtimeState,
runtimeUser,
satisfiesPzi,
satisfiesPzs,
serviceAccount,
shieldedVmConfig,
softwareConfig,
updateTime,
version
FROM google.aiplatform.notebook_runtimes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND notebookRuntimesId = '{{ notebookRuntimesId }}' -- required;

list

Lists NotebookRuntimes in a Location.

SELECT
name,
createTime,
dataPersistentDiskSpec,
description,
displayName,
encryptionSpec,
eucConfig,
expirationTime,
healthState,
idleShutdownConfig,
isUpgradable,
labels,
machineSpec,
networkSpec,
networkTags,
notebookRuntimeTemplateRef,
notebookRuntimeType,
proxyUri,
reservationAffinity,
runtimeState,
runtimeUser,
satisfiesPzi,
satisfiesPzs,
serviceAccount,
shieldedVmConfig,
softwareConfig,
updateTime,
version
FROM google.aiplatform.notebook_runtimes
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND readMask = '{{ readMask }}'
AND orderBy = '{{ orderBy }}';

DELETE examples

delete

Deletes a NotebookRuntime.

DELETE FROM google.aiplatform.notebook_runtimes
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND notebookRuntimesId = '{{ notebookRuntimesId }}' --required;

Lifecycle Methods

assign

Assigns a NotebookRuntime to a user for a particular Notebook file. This method will either returns an existing assignment or generates a new one.

EXEC google.aiplatform.notebook_runtimes.assign 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required 
@@json=
'{
"notebookRuntimeTemplate": "{{ notebookRuntimeTemplate }}", 
"notebookRuntime": "{{ notebookRuntime }}", 
"notebookRuntimeId": "{{ notebookRuntimeId }}"
}';

upgrade

Upgrades a NotebookRuntime.

EXEC google.aiplatform.notebook_runtimes.upgrade 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@notebookRuntimesId='{{ notebookRuntimesId }}' --required;

start

Starts a NotebookRuntime.

EXEC google.aiplatform.notebook_runtimes.start 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@notebookRuntimesId='{{ notebookRuntimesId }}' --required;

stop

Stops a NotebookRuntime.

EXEC google.aiplatform.notebook_runtimes.stop 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@notebookRuntimesId='{{ notebookRuntimesId }}' --required;