- 1.63.0 (latest)
- 1.62.0
- 1.60.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.1
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.39.0
- 1.38.1
- 1.37.0
- 1.36.4
- 1.35.0
- 1.34.0
- 1.33.1
- 1.32.0
- 1.31.1
- 1.30.1
- 1.29.0
- 1.28.1
- 1.27.1
- 1.26.1
- 1.25.0
- 1.24.1
- 1.23.0
- 1.22.1
- 1.21.0
- 1.20.0
- 1.19.1
- 1.18.3
- 1.17.1
- 1.16.1
- 1.15.1
- 1.14.0
- 1.13.1
- 1.12.1
- 1.11.0
- 1.10.0
- 1.9.0
- 1.8.1
- 1.7.1
- 1.6.2
- 1.5.0
- 1.4.3
- 1.3.0
- 1.2.0
- 1.1.1
- 1.0.1
- 0.9.0
- 0.8.0
- 0.7.1
- 0.6.0
- 0.5.1
- 0.4.0
- 0.3.1
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_v1.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_v1.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. The service account that the NotebookRuntime workload runs as. |
runtime_state |
google.cloud.aiplatform_v1.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_v1.types.NotebookRuntimeType
Output only. The type of the notebook runtime. |
idle_shutdown_config |
google.cloud.aiplatform_v1.types.NotebookIdleShutdownConfig
Output only. The idle shutdown configuration of the notebook runtime. |
network_tags |
MutableSequence[str]
Optional. The Compute Engine tags to add to runtime (see `Tagging instances |
encryption_spec |
google.cloud.aiplatform_v1.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,
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 |
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.