string

Output only. The name of this notebook instance. Format:projects/{projectId}/locations/{location}/instances/{instanceId}

string

Path to a Bash script that automatically runs after a notebook instance fully boots up. The path must be a URL or Cloud Storage path (gs://path-to-file/file-name).

string

Output only. The proxy endpoint that is used to access the Jupyter notebook.

string

Input only. The owner of this instance after creation. Format:alias@example.com

Currently supports one owner only. If not specified, all of the service account users of your VM instance's service account can use the instance.

string

The service account on this instance, giving access to other Google Cloud services. You can use any service account within the same project, but you must have the service account user permission to use the instance.

If not specified, theCompute Engine default service account is used.

string

Optional. The URIs of service account scopes to be included in Compute Engine instances.

If not specified, the followingscopes are defined: -https://www.googleapis.com/auth/cloud-platform -https://www.googleapis.com/auth/userinfo.email If not using default scopes, you need at least:https://www.googleapis.com/auth/compute

string

Required. TheCompute Engine machine type of this instance.

object (AcceleratorConfig)

The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration hasenough vCPUs and memory to support themachineType you have selected.

enum (State)

Output only. The state of this instance.

boolean

Whether the end user authorizes Google Cloud to install GPU driver on this instance. If this field is empty or set to false, the GPU driver won't be installed. Only applicable to instances with GPUs.

string

Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.

enum (DiskType)

Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).

string (int64 format)

Input only. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). The minimum recommended value is 100 GB. If not specified, this defaults to 100.

enum (DiskType)

Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).

string (int64 format)

Input only. The size of the data disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). You can choose the size of the data disk based on how big your notebooks and data are. If not specified, this defaults to 100.

boolean

Input only. If true, the data disk will not be auto deleted when deleting the instance.

enum (DiskEncryption)

Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.

string

Input only. The KMS key used to encrypt the disks, only applicable if diskEncryption is CMEK. Format:projects/{projectId}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}

Learn more aboutusing your own encryption keys.

object (Disk)

Output only. Attached disks to notebook instance.

object (ShieldedInstanceConfig)

Optional. Shielded VM configuration.Images using supported Shielded VM features.

boolean

If true, no external IP will be assigned to this instance.

boolean

If true, the notebook instance will not register with the proxy.

string

The name of the VPC that this instance is in. Format:projects/{projectId}/global/networks/{network_id}

string

The name of the subnet that this instance is in. Format:projects/{projectId}/regions/{region}/subnetworks/{subnetwork_id}

map (key: string, value: string)

Labels to apply to this instance. These can be later modified by the setLabels method.

An object containing a list of"key": value pairs. Example:{ "name": "wrench", "mass": "1.3kg", "count": "3" }.

map (key: string, value: string)

Custom metadata to apply to this instance. For example, to specify a Cloud Storage bucket for automatic backup, you can use thegcs-data-bucket metadata tag. Format:"--metadata=gcs-data-bucket=BUCKET".

An object containing a list of"key": value pairs. Example:{ "name": "wrench", "mass": "1.3kg", "count": "3" }.

string

Optional. The Compute Engine network tags to add to runtime (seeAdd network tags).

object (UpgradeHistoryEntry)

The upgrade history of this instance.

enum (NicType)

Optional. The type of vNIC to be used on this interface. This may be gVNIC or VirtioNet.

object (ReservationAffinity)

Optional. The optional reservation affinity. Setting this field will apply the specifiedZonal Compute Reservation to this notebook instance.

string

Output only. Email address of entity that sent original instances.create request.

boolean

Optional. Flag to enable ip forwarding or not, default false/off.https://cloud.google.com/vpc/docs/using-routes#canipforward

string (Timestamp format)

Output only. Instance creation time.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".

string (Timestamp format)

Output only. Instance update time.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".

object (InstanceMigrationEligibility)

Output only. Checks how feasible a migration from UmN to WbI is.

object (VmImage)

Use a Compute Engine VM image to start the notebook instance.

object (ContainerImage)

Use a container image to start the notebook instance.

boolean

Output only. Bool indicating whether this notebook has been migrated to a Workbench Instance

enum (AcceleratorType)

Type of this accelerator.

string (int64 format)

Count of cores of this accelerator.

boolean

Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

boolean

Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

string

Indicates a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine.This field is only applicable for persistent disks.

string (int64 format)

Indicates the size of the disk in base-2 GB.

object (GuestOsFeature)

Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

string (int64 format)

A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

string

Indicates the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values:

• NVME
• SCSI

string

Type of the resource. Always compute#attachedDisk for attached disks.

string

A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.

string

The mode in which to attach this disk, eitherREAD_WRITE orREAD_ONLY. If not specified, the default is to attach the disk inREAD_WRITE mode. Valid values:

• READ_ONLY
• READ_WRITE

string

Indicates a valid partial or full URL to an existing Persistent Disk resource.

string

Indicates the type of the disk, eitherSCRATCH orPERSISTENT. Valid values:

• PERSISTENT
• SCRATCH

string

The ID of a supported feature. Read Enabling guest operating system features to see a list of available options. Valid values:

• FEATURE_TYPE_UNSPECIFIED
• MULTI_IP_SUBNET
• SECURE_BOOT
• UEFI_COMPATIBLE
• VIRTIO_SCSI_MULTIQUEUE
• WINDOWS

boolean

Defines whether the instance has Secure Boot enabled.

Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails. Disabled by default.

boolean

Defines whether the instance has the vTPM enabled. Enabled by default.

boolean

Defines whether the instance has integrity monitoring enabled.

Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created. Enabled by default.

string

The snapshot of the boot disk of this notebook instance before upgrade.

string

The VM image before this instance upgrade.

string

The container image before this instance upgrade.

string

The framework of this notebook instance.

string

The version of the notebook instance before this upgrade.

enum (State)

The state of this instance upgrade history entry.

string (Timestamp format)

The time that this instance upgrade history entry is created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples:"2014-10-02T15:01:23Z","2014-10-02T15:01:23.045123456Z" or"2014-10-02T15:01:23+05:30".

string

enum (Action)

Action. Rolloback or Upgrade.

string

Target VM Version, like m63.

enum (Type)

Optional. Type of reservation to consume

string

Optional. Corresponds to the label key of reservation resource.

string

Optional. Corresponds to the label values of reservation resource.

enum (Warning)

Output only. Certain configurations will be defaulted during the migration.

enum (Error)

Output only. Certain configurations make the UmN ineligible for an automatic migration. A manual migration is required.