REST Resource: projects.locations.notebookRuntimes

Resource: NotebookRuntime

A runtime is a virtual machine allocated to a particular user for a particular Notebook file on temporary basis with lifetime limited to 24 hours.

Fields
name string

Output only. The resource name of the NotebookRuntime.

runtimeUser string

Required. The user email of the NotebookRuntime.

notebookRuntimeTemplateRef object (NotebookRuntimeTemplateRef)

Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.

proxyUri string

Output only. The proxy endpoint used to access the NotebookRuntime.

createTime string (Timestamp format)

Output only. timestamp when this NotebookRuntime was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime string (Timestamp format)

Output only. timestamp when this NotebookRuntime was most recently updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

healthState enum (HealthState)

Output only. The health state 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.

description string

The description of the NotebookRuntime.

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.

runtimeState enum (RuntimeState)

Output only. The runtime (instance) state of the NotebookRuntime.

isUpgradable boolean

Output only. Whether NotebookRuntime is upgradable.

labels map (key: string, value: string)

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.
expirationTime string (Timestamp format)

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.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

version string

Output only. The VM os image version of NotebookRuntime.

notebookRuntimeType enum (NotebookRuntimeType)

Output only. The type of the notebook runtime.

idleShutdownConfig object (NotebookIdleShutdownConfig)

Output only. The idle shutdown configuration of the notebook runtime.

eucConfig object (NotebookEucConfig)

Output only. EUC configuration of the notebook runtime.

shieldedVmConfig object (ShieldedVmConfig)

Output only. Runtime Shielded VM spec.

networkTags[] string

Optional. The Compute Engine tags to add to runtime (see Tagging instances).

encryptionSpec object (EncryptionSpec)

Output only. Customer-managed encryption key spec for the notebook runtime.

satisfiesPzs boolean

Output only. reserved for future use.

satisfiesPzi boolean

Output only. reserved for future use.

JSON representation 
{
  "name": string,
  "runtimeUser": string,
  "notebookRuntimeTemplateRef": {
    object (NotebookRuntimeTemplateRef)
  },
  "proxyUri": string,
  "createTime": string,
  "updateTime": string,
  "healthState": enum (HealthState),
  "displayName": string,
  "description": string,
  "serviceAccount": string,
  "runtimeState": enum (RuntimeState),
  "isUpgradable": boolean,
  "labels": {
    string: string,
    ...
  },
  "expirationTime": string,
  "version": string,
  "notebookRuntimeType": enum (NotebookRuntimeType),
  "idleShutdownConfig": {
    object (NotebookIdleShutdownConfig)
  },
  "eucConfig": {
    object (NotebookEucConfig)
  },
  "shieldedVmConfig": {
    object (ShieldedVmConfig)
  },
  "networkTags": [
    string
  ],
  "encryptionSpec": {
    object (EncryptionSpec)
  },
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean
}

NotebookRuntimeTemplateRef

Points to a NotebookRuntimeTemplateRef.

Fields
notebookRuntimeTemplate string

Immutable. A resource name of the NotebookRuntimeTemplate.

JSON representation 
{
  "notebookRuntimeTemplate": string
}

HealthState

The substate of the NotebookRuntime to display health information.

Enums
HEALTH_STATE_UNSPECIFIED Unspecified health state.
HEALTHY NotebookRuntime is in healthy state. Applies to ACTIVE state.
UNHEALTHY NotebookRuntime is in unhealthy state. Applies to ACTIVE state.

RuntimeState

The substate of the NotebookRuntime to display state of runtime. The resource of NotebookRuntime is in ACTIVE state for these sub state.

Enums
RUNTIME_STATE_UNSPECIFIED Unspecified runtime state.
RUNNING NotebookRuntime is in running state.
BEING_STARTED NotebookRuntime is in starting state.
BEING_STOPPED NotebookRuntime is in stopping state.
STOPPED NotebookRuntime is in stopped state.
BEING_UPGRADED NotebookRuntime is in upgrading state. It is in the middle of upgrading process.
ERROR NotebookRuntime was unable to start/stop properly.
INVALID NotebookRuntime is in invalid state. Cannot be recovered.

Methods

assign

 Assigns a NotebookRuntime to a user for a particular Notebook file.

delete

 Deletes a NotebookRuntime.

get

 Gets a NotebookRuntime.

list

 Lists NotebookRuntimes in a Location.

start

 Starts a NotebookRuntime.

stop

 Stops a NotebookRuntime.

upgrade

 Upgrades a NotebookRuntime.