feat: add StopNotebookRuntime method

PiperOrigin-RevId: 691235183
googleapis · Oct 30, 2024 · 4160527 · 4160527
1 parent e6b6ff9
commit 4160527
Showing 1 changed file with 40 additions and 0 deletions.
diff --git a/google/cloud/aiplatform/v1/notebook_service.proto b/google/cloud/aiplatform/v1/notebook_service.proto
@@ -172,6 +172,20 @@ service NotebookService {
     };
   }
 
+  // Stops a NotebookRuntime.
+  rpc StopNotebookRuntime(StopNotebookRuntimeRequest)
+      returns (google.longrunning.Operation) {
+    option (google.api.http) = {
+      post: "/v1/{name=projects/*/locations/*/notebookRuntimes/*}:stop"
+      body: "*"
+    };
+    option (google.api.method_signature) = "name";
+    option (google.longrunning.operation_info) = {
+      response_type: "StopNotebookRuntimeResponse"
+      metadata_type: "StopNotebookRuntimeOperationMetadata"
+    };
+  }
+
   // Creates a NotebookExecutionJob.
   rpc CreateNotebookExecutionJob(CreateNotebookExecutionJobRequest)
       returns (google.longrunning.Operation) {
@@ -598,6 +612,32 @@ message StartNotebookRuntimeOperationMetadata {
 // [NotebookService.StartNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.StartNotebookRuntime].
 message StartNotebookRuntimeResponse {}
 
+// Request message for
+// [NotebookService.StopNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.StopNotebookRuntime].
+message StopNotebookRuntimeRequest {
+  // Required. The name of the NotebookRuntime resource to be stopped.
+  // Instead of checking whether the name is in valid NotebookRuntime resource
+  // name format, directly throw NotFound exception if there is no such
+  // NotebookRuntime in spanner.
+  string name = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "aiplatform.googleapis.com/NotebookRuntime"
+    }
+  ];
+}
+
+// Metadata information for
+// [NotebookService.StopNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.StopNotebookRuntime].
+message StopNotebookRuntimeOperationMetadata {
+  // The operation generic information.
+  GenericOperationMetadata generic_metadata = 1;
+}
+
+// Response message for
+// [NotebookService.StopNotebookRuntime][google.cloud.aiplatform.v1.NotebookService.StopNotebookRuntime].
+message StopNotebookRuntimeResponse {}
+
 // Request message for [NotebookService.CreateNotebookExecutionJob]
 message CreateNotebookExecutionJobRequest {
   // Required. The resource name of the Location to create the