Class Instance

The definition of a notebook instance.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
NameDescription
strname
Output only. The name of this notebook instance. Format: ``projects/{project_id}/locations/{location}/instances/{instance_id}``
google.cloud.notebooks_v1beta1.types.VmImagevm_image
Use a Compute Engine VM image to start the notebook instance. This field is a member of `oneof`_ ``environment``.
google.cloud.notebooks_v1beta1.types.ContainerImagecontainer_image
Use a container image to start the notebook instance. This field is a member of `oneof`_ ``environment``.
strpost_startup_script
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``).
strproxy_uri
Output only. The proxy endpoint that is used to access the Jupyter notebook.
Sequence[str]instance_owners
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.
strservice_account
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, the `Compute Engine default service account
strmachine_type
Required. The `Compute Engine machine type
google.cloud.notebooks_v1beta1.types.Instance.AcceleratorConfigaccelerator_config
The hardware accelerator used on this instance. If you use accelerators, make sure that your configuration has `enough vCPUs and memory to support the ``machine_type`` you have selected
google.cloud.notebooks_v1beta1.types.Instance.Statestate
Output only. The state of this instance.
boolinstall_gpu_driver
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.
strcustom_gpu_driver_path
Specify a custom Cloud Storage path where the GPU driver is stored. If not specified, we'll automatically choose from official GPU drivers.
google.cloud.notebooks_v1beta1.types.Instance.DiskTypeboot_disk_type
Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (``PD_STANDARD``).
intboot_disk_size_gb
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.
google.cloud.notebooks_v1beta1.types.Instance.DiskTypedata_disk_type
Input only. The type of the data disk attached to this instance, defaults to standard persistent disk (``PD_STANDARD``).
intdata_disk_size_gb
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.
boolno_remove_data_disk
Input only. If true, the data disk will not be auto deleted when deleting the instance.
google.cloud.notebooks_v1beta1.types.Instance.DiskEncryptiondisk_encryption
Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
strkms_key
Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format: ``projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}`` Learn more about `using your own encryption keys
boolno_public_ip
If true, no public IP will be assigned to this instance.
boolno_proxy_access
If true, the notebook instance will not register with the proxy.
strnetwork
The name of the VPC that this instance is in. Format: ``projects/{project_id}/global/networks/{network_id}``
strsubnet
The name of the subnet that this instance is in. Format: ``projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}``
Sequence[google.cloud.notebooks_v1beta1.types.Instance.LabelsEntry]labels
Labels to apply to this instance. These can be later modified by the setLabels method.
Sequence[google.cloud.notebooks_v1beta1.types.Instance.MetadataEntry]metadata
Custom metadata to apply to this instance.
google.protobuf.timestamp_pb2.Timestampcreate_time
Output only. Instance creation time.
google.protobuf.timestamp_pb2.Timestampupdate_time
Output only. Instance update time.

Inheritance

builtins.object > proto.message.Message > Instance

Classes

AcceleratorConfig

AcceleratorConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Definition of a hardware accelerator. Note that not all combinations of type and core_count are valid. Check GPUs on Compute Engine </compute/docs/gpus/#gpus-list>__ to find a valid combination. TPUs are not supported.

AcceleratorType

AcceleratorType(value)

Definition of the types of hardware accelerators that can be used on this instance.

DiskEncryption

DiskEncryption(value)

Definition of the disk encryption options.

DiskType

DiskType(value)

Possible disk types for notebook instances.

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

API documentation for notebooks_v1beta1.types.Instance.LabelsEntry class.

MetadataEntry

MetadataEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

API documentation for notebooks_v1beta1.types.Instance.MetadataEntry class.

State

State(value)

The definition of the states of this instance.