feat: Introduce DefaultRuntime to PipelineJob

Google APIs · copybara-github · commit d10780874de1 · 2024-10-15T16:46:53.000-07:00
PiperOrigin-RevId: 686283392
diff --git a/google/cloud/aiplatform/v1beta1/pipeline_job.proto b/google/cloud/aiplatform/v1beta1/pipeline_job.proto
@@ -64,6 +64,44 @@ message PipelineJob {
       }
     }
 
+    // Persistent resource based runtime detail. For more information, refer to
+    // https://cloud.google.com/vertex-ai/docs/training/persistent-resource-overview
+    message PersistentResourceRuntimeDetail {
+      // An enum that specifies the behavior to take if the timeout is reached.
+      enum TaskResourceUnavailableTimeoutBehavior {
+        // Unspecified. Behavior is same as `FAIL`.
+        TASK_RESOURCE_UNAVAILABLE_TIMEOUT_BEHAVIOR_UNSPECIFIED = 0;
+
+        // Fail the task if the timeout is reached.
+        FAIL = 1;
+
+        // Fall back to on-demand execution if the timeout is reached.
+        FALL_BACK_TO_ON_DEMAND = 2;
+      }
+
+      // Persistent resource name.
+      // Format:
+      // `projects/{project}/locations/{location}/persistentResources/{persistent_resource}`
+      string persistent_resource_name = 1;
+
+      // The max time a pipeline task waits for the required CPU, memory, or
+      // accelerator resource to become available from the specified persistent
+      // resource. Default wait time is 0.
+      int64 task_resource_unavailable_wait_time_ms = 2;
+
+      // Specifies the behavior to take if the timeout is reached.
+      TaskResourceUnavailableTimeoutBehavior
+          task_resource_unavailable_timeout_behavior = 3;
+    }
+
+    // The default runtime for the PipelineJob.
+    message DefaultRuntime {
+      oneof runtime_detail {
+        // Persistent resource based runtime detail.
+        PersistentResourceRuntimeDetail persistent_resource_runtime_detail = 1;
+      }
+    }
+
     // Deprecated. Use
     // [RuntimeConfig.parameter_values][google.cloud.aiplatform.v1beta1.PipelineJob.RuntimeConfig.parameter_values]
     // instead. The runtime parameters of the PipelineJob. The parameters will
@@ -103,6 +141,12 @@ message PipelineJob {
     // The runtime artifacts of the PipelineJob. The key will be the input
     // artifact name and the value would be one of the InputArtifact.
     map<string, InputArtifact> input_artifacts = 5;
+
+    // Optional. The default runtime for the PipelineJob. If not provided,
+    // Vertex Custom Job(on demand) is used as the runtime. For Vertex Custom
+    // Job, please refer to
+    // https://cloud.google.com/vertex-ai/docs/training/overview.
+    DefaultRuntime default_runtime = 6 [(google.api.field_behavior) = OPTIONAL];
   }
 
   // Output only. The resource name of the PipelineJob.
