feat: add message ColabImage, add field colab_image to NotebookSoftwareConfig

Google APIs · copybara-github · commit 63161c080e7e · 2025-07-01T10:14:51.000-07:00
feat: allow user input for schedule_resource_name in NotebookExecutionJob
docs: A comment for message NotebookRuntime is changed
docs: A comment for enum value BEING_STARTED in enum NotebookRuntime.RuntimeState is changed
docs: A comment for message NotebookSoftwareConfig is changed

PiperOrigin-RevId: 778092563
diff --git a/google/cloud/aiplatform/v1beta1/notebook_execution_job.proto b/google/cloud/aiplatform/v1beta1/notebook_execution_job.proto
@@ -146,15 +146,11 @@ message NotebookExecutionJob {
   // Max running time of the execution job in seconds (default 86400s / 24 hrs).
   google.protobuf.Duration execution_timeout = 5;
 
-  // Output only. The Schedule resource name if this job is triggered by one.
-  // Format:
+  // The Schedule resource name if this job is triggered by one. Format:
   // `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
-  string schedule_resource_name = 6 [
-    (google.api.field_behavior) = OUTPUT_ONLY,
-    (google.api.resource_reference) = {
-      type: "aiplatform.googleapis.com/Schedule"
-    }
-  ];
+  string schedule_resource_name = 6 [(google.api.resource_reference) = {
+    type: "aiplatform.googleapis.com/Schedule"
+  }];
 
   // Output only. The state of the NotebookExecutionJob.
   JobState job_state = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
diff --git a/google/cloud/aiplatform/v1beta1/notebook_runtime.proto b/google/cloud/aiplatform/v1beta1/notebook_runtime.proto
@@ -164,8 +164,9 @@ message NotebookRuntimeTemplate {
 }
 
 // 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.
+// particular Notebook file on temporary basis with lifetime. Default runtimes
+// have a lifetime of 18 hours, while custom runtimes last for 6 months from
+// their creation or last upgrade.
 message NotebookRuntime {
   option (google.api.resource) = {
     type: "aiplatform.googleapis.com/NotebookRuntime"
@@ -193,7 +194,8 @@ message NotebookRuntime {
     // NotebookRuntime is in running state.
     RUNNING = 1;
 
-    // NotebookRuntime is in starting state.
+    // NotebookRuntime is in starting state. This is when the runtime is being
+    // started from a stopped state.
     BEING_STARTED = 2;
 
     // NotebookRuntime is in stopping state.
diff --git a/google/cloud/aiplatform/v1beta1/notebook_software_config.proto b/google/cloud/aiplatform/v1beta1/notebook_software_config.proto
@@ -46,7 +46,27 @@ message PostStartupScriptConfig {
       [(google.api.field_behavior) = OPTIONAL];
 }
 
+// Colab image of the runtime.
+message ColabImage {
+  // Optional. The release name of the NotebookRuntime Colab image, e.g.
+  // "py310". If not specified, detault to the latest release.
+  string release_name = 1 [(google.api.field_behavior) = OPTIONAL];
+
+  // Output only. A human-readable description of the specified colab image
+  // release, populated by the system. Example: "Python 3.10", "Latest - current
+  // Python 3.11"
+  string description = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
+}
+
+// Notebook Software Config. This is passed to the backend when user
+// makes software configurations in UI.
 message NotebookSoftwareConfig {
+  // The image to be used by the notebook runtime.
+  oneof runtime_image {
+    // Optional. Google-managed NotebookRuntime colab image.
+    ColabImage colab_image = 5 [(google.api.field_behavior) = OPTIONAL];
+  }
+
   // Optional. Environment variables to be passed to the container.
   // Maximum limit is 100.
   repeated EnvVar env = 1 [(google.api.field_behavior) = OPTIONAL];
