Class NotebookRuntime (1.89.0) 

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

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.

Attributes
Name Description
name str
Output only. The resource name of the NotebookRuntime.
runtime_user str
Required. The user email of the NotebookRuntime.
notebook_runtime_template_ref google.cloud.aiplatform_v1beta1.types.NotebookRuntimeTemplateRef
Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.
proxy_uri str
Output only. The proxy endpoint used to access the NotebookRuntime.
create_time google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when this NotebookRuntime was created.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when this NotebookRuntime was most recently updated.
health_state google.cloud.aiplatform_v1beta1.types.NotebookRuntime.HealthState
Output only. The health state of the NotebookRuntime.
display_name str
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 str
The description of the NotebookRuntime.
service_account str
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.
runtime_state google.cloud.aiplatform_v1beta1.types.NotebookRuntime.RuntimeState
Output only. The runtime (instance) state of the NotebookRuntime.
is_upgradable bool
Output only. Whether NotebookRuntime is upgradable.
labels MutableMapping[str, str]
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.
expiration_time google.protobuf.timestamp_pb2.Timestamp
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.
version str
Output only. The VM os image version of NotebookRuntime.
notebook_runtime_type google.cloud.aiplatform_v1beta1.types.NotebookRuntimeType
Output only. The type of the notebook runtime.
machine_spec google.cloud.aiplatform_v1beta1.types.MachineSpec
Output only. The specification of a single machine used by the notebook runtime.
data_persistent_disk_spec google.cloud.aiplatform_v1beta1.types.PersistentDiskSpec
Output only. The specification of [persistent disk][https://cloud.google.com/compute/docs/disks/persistent-disks] attached to the notebook runtime as data disk storage.
network_spec google.cloud.aiplatform_v1beta1.types.NetworkSpec
Output only. Network spec of the notebook runtime.
idle_shutdown_config google.cloud.aiplatform_v1beta1.types.NotebookIdleShutdownConfig
Output only. The idle shutdown configuration of the notebook runtime.
euc_config google.cloud.aiplatform_v1beta1.types.NotebookEucConfig
Output only. EUC configuration of the notebook runtime.
shielded_vm_config google.cloud.aiplatform_v1beta1.types.ShieldedVmConfig
Output only. Runtime Shielded VM spec.
network_tags MutableSequence[str]
Optional. The Compute Engine tags to add to runtime (see `Tagging instances
software_config google.cloud.aiplatform_v1beta1.types.NotebookSoftwareConfig
Output only. Software config of the notebook runtime.
encryption_spec google.cloud.aiplatform_v1beta1.types.EncryptionSpec
Output only. Customer-managed encryption key spec for the notebook runtime.
satisfies_pzs bool
Output only. Reserved for future use.
satisfies_pzi bool
Output only. Reserved for future use.

Classes

HealthState

HealthState(value)

The substate of the NotebookRuntime to display health information.

LabelsEntry

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

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.
mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

RuntimeState

RuntimeState(value)

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

Methods

NotebookRuntime

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

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.