feat: Add machine_spec, data_persistent_disk_spec, network_spec, euc_config, shielded_vm_config to message .google.cloud.aiplatform.v1.NotebookRuntime

Google APIs · copybara-github · commit 7e9066bdf5d8 · 2025-01-22T11:37:40.000-08:00
docs: Deprecate `is_default` in message `.google.cloud.aiplatform.v1.NotebookRuntimeTemplate`
docs: Deprecate `service_account` in message `.google.cloud.aiplatform.v1.NotebookRuntimeTemplate`
docs: Deprecate `service_account` in message `.google.cloud.aiplatform.v1.NotebookRuntime`

PiperOrigin-RevId: 718467020
diff --git a/google/cloud/aiplatform/v1/notebook_runtime.proto b/google/cloud/aiplatform/v1/notebook_runtime.proto
@@ -67,8 +67,12 @@ message NotebookRuntimeTemplate {
   // The description of the NotebookRuntimeTemplate.
   string description = 3;
 
-  // Output only. The default template to use if not specified.
-  bool is_default = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
+  // Output only. Deprecated: This field has no behavior. Use
+  // notebook_runtime_type = 'ONE_CLICK' instead.
+  //
+  // The default template to use if not specified.
+  bool is_default = 4
+      [deprecated = true, (google.api.field_behavior) = OUTPUT_ONLY];
 
   // Optional. Immutable. The specification of a single machine for the
   // template.
@@ -86,14 +90,23 @@ message NotebookRuntimeTemplate {
   // Optional. Network spec.
   NetworkSpec network_spec = 12 [(google.api.field_behavior) = OPTIONAL];
 
+  // Deprecated: This field is ignored 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.
+  // For NotebookExecutionJob, use NotebookExecutionJob.service_account instead.
+  //
   // The service account that the runtime workload runs as.
   // 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](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account)
   // is used.
-  string service_account = 13;
+  string service_account = 13 [deprecated = true];
 
   // Used to perform consistent read-modify-write updates. If not set, a blind
   // "overwrite" update happens.
@@ -228,7 +241,15 @@ message NotebookRuntime {
   // The description of the NotebookRuntime.
   string description = 11;
 
-  // Output only. The service account that the NotebookRuntime workload runs as.
+  // 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.
   string service_account = 13 [(google.api.field_behavior) = OUTPUT_ONLY];
 
   // Output only. The runtime (instance) state of the NotebookRuntime.
@@ -272,10 +293,30 @@ message NotebookRuntime {
   NotebookRuntimeType notebook_runtime_type = 19
       [(google.api.field_behavior) = OUTPUT_ONLY];
 
+  // Output only. The specification of a single machine used by the notebook
+  // runtime.
+  MachineSpec machine_spec = 20 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // 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.
+  PersistentDiskSpec data_persistent_disk_spec = 21
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Network spec of the notebook runtime.
+  NetworkSpec network_spec = 22 [(google.api.field_behavior) = OUTPUT_ONLY];
+
   // Output only. The idle shutdown configuration of the notebook runtime.
   NotebookIdleShutdownConfig idle_shutdown_config = 23
       [(google.api.field_behavior) = OUTPUT_ONLY];
 
+  // Output only. EUC configuration of the notebook runtime.
+  NotebookEucConfig euc_config = 24 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. Runtime Shielded VM spec.
+  ShieldedVmConfig shielded_vm_config = 32
+      [(google.api.field_behavior) = OUTPUT_ONLY];
+
   // Optional. The Compute Engine tags to add to runtime (see [Tagging
   // instances](https://cloud.google.com/vpc/docs/add-remove-network-tags)).
   repeated string network_tags = 25 [(google.api.field_behavior) = OPTIONAL];
